presence resource type

Namespace: microsoft.graph

Contains information about a user's presence, including their availability and user activity.

This resource supports subscribing to change notifications.

Methods

Method	Return Type	Description
Get presence	presence	Get a user's presence information.
Get presence for multiple users	presence collection	Get the presence information for multiple users.
Set presence		Set an application's presence session for a user.
Clear presence		Clear an application's presence session for a user.
Set user preferred presence		Set the preferred availability and activity status for a user.
Clear user preferred presence		Clear the preferred availability and activity status for a user.
Set user status message		Set a presence status message for a user.
Set automatic location	None	Update the automatic work location for a user.
Set manual location	None	Set the manual work location signal for a user.
Clear automatic location	None	Clear the automatic work location signal for a user.
Clear location	None	Clear the work location signals for a user, including both the manual and automatic layers for the current date.

Properties

Property	Type	Description
activity	String	The supplemental information to a user's availability. Possible values are available, away, beRightBack, busy, doNotDisturb, offline, outOfOffice, presenceUnknown.
availability	String	The base presence information for a user. Possible values are available, away, beRightBack, busy, doNotDisturb, focusing, inACall, inAMeeting, offline, presenting, presenceUnknown.
id	String	The unique identifier for the user.
outOfOfficeSettings	outOfOfficeSettings	The out of office settings for a user.
sequenceNumber	String	The lexicographically sortable String stamp that represents the version of a presence object.
statusMessage	presenceStatusMessage	The presence status message of a user.
workLocation	userWorkLocation	Represents the user’s aggregated work location state.

Note

• To learn more about the different presence states, see User presence in Teams.
• For more details about presence sessions, states permutations, timeouts, and trusted domains, see Manage presence state using the Microsoft Graph API.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
   "activity": "String",
   "availability":"String",
   "id": "String (identifier)",
   "outOfOfficeSettings": {"@odata.type": "#microsoft.graph.outOfOfficeSettings"},
   "sequenceNumber": "String",
   "statusMessage": {"@odata.type": "#microsoft.graph.presenceStatusMessage"},
   "workLocation": {"@odata.type": "microsoft.graph.userWorkLocation" }
}