退出登录

该接口用于退出用户的登录态

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/passport/v1/sessions/logout
HTTP Method	POST
接口频率限制	特殊频控
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	passport:session:logout 登出指定用户
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

查询参数

名称	类型	必填	描述
user_id_type	string	否	用户 ID 类型 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ 默认值：open_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体

名称	类型	必填	描述
idp_credential_id	string	否	idp 侧的唯一标识，logout_type = 2 时必填 示例值："user@xxx.xx"
logout_type	int	是	登出的方式 示例值：1 可选值有： - 1: UserID，使用开放平台的维度登出 - 2: IdpCredentialID，使用 idp 侧的唯一标识登出 - 3: Session 标识符，基于session uuid 登出
terminal_type	int\[\]	否	登出的客户端类型，默认全部登出。可选值： - 1：PC 端 - 2：Web 端 - 3：Android 端 - 4：iOS 端 - 5：服务端 - 6：旧版小程序端 - 8：其他移动端 示例值：[1]
user_id	string	否	开放平台的数据标识，用户 ID 类型与查询参数 user_id_type 一致，logout_type = 1 时必填 示例值："ou_7dab8a3d3cdcc9da365777c7ad535d62"
logout_reason	int	否	登出提示语，非必填，不传时默认提示：你已在其他客户端上退出了当前设备，请重新登录。 可选值： - 34：您已修改登录密码，请重新登录 - 35：您的登录态已失效，请重新登录 - 36：您的密码已过期，请在登录页面通过忘记密码功能修改密码后重新登录 示例值：34
sid	string	否	需要精确登出的 session 标识符，logout_type = 3 时必填 示例值："AAAAAAAAAANll6nQoIAAFA=="

请求体示例

{
    "idp_credential_id": "user@xxx.xx",
    "logout_type": 1,
    "terminal_type": [
        1
    ],
    "user_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62",
    "logout_reason": 34,
    "sid": "AAAAAAAAAANll6nQoIAAFA=="
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1080001	param is invalis	参数错误，请对照接口文档修改输入参数后重试。
400	1084001	The parameter sid is invalid	sid不合法，请检查后重试。
400	1084002	The parameter logout_reason is invalid	logout_reason不合法，请参照上文“请求体”说明，检查后重试。