presence:clearPresence

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

为用户清除应用程序 的状态会话 。 如果它是用户的唯一状态会话,则成功的 clearPresence 会将用户的状态更改为 Offline/Offline

详细了解 状态会话 及其 超时和过期

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Presence.ReadWrite 不可用。
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 Presence.ReadWrite.All 不可用。

HTTP 请求

POST /users/{userId}/presence/clearPresence

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type application/json. 必需。

请求正文

在请求正文中,提供具有以下参数的 JSON 对象。

参数 类型 说明
sessionId string 应用程序的状态会话的 ID。

重要

在请求中提供应用程序的 sessionId ID。

响应

如果成功,此方法返回 200 OK 响应代码。

如果状态会话不存在,此方法将 404 NotFound 返回响应代码。

示例

以下请求显示了应用程序的 ID 22553876-f5ab-4529-bffb-cfe50aa89f87 ,该应用程序清除用户 fa8bf3dc-eca7-46b7-bad1-db199b62afc3的状态会话。

请求

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

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

响应

HTTP/1.1 200 OK