編輯

共用方式為


presence: clearPresence

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Clear a presence session of an application for a user. If it is the user's only presence session, a successful clearPresence changes the user's presence to Offline/Offline.

Read more about presence sessions and their time-out and expiration.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Presence.ReadWrite Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Presence.ReadWrite.All Not available.

HTTP Request

POST /users/{userId}/presence/clearPresence

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter Type Description
sessionId string The ID of the application's presence session.

Important

Provide the ID of the application as sessionId in the request.

Response

If successful, this method returns a 200 OK response code.

If the presence session doesn't exist, this method returns a 404 NotFound response code.

Examples

The following request shows the application with ID 22553876-f5ab-4529-bffb-cfe50aa89f87 that clears its presence session for user fa8bf3dc-eca7-46b7-bad1-db199b62afc3.

Request

POST https://graph.microsoft.com/beta/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/clearPresence
Content-Type: application/json

{
  "sessionId": "22553876-f5ab-4529-bffb-cfe50aa89f87"
}

Response

HTTP/1.1 200 OK