NATSidentity.session.revoke-all吊销用户全部会话

Try it 面板需要启用 JavaScript。

吊销用户全部（或除指定会话外）的会话；用于全端下线、强制下线与凭据变更保护。

Request Payload

消息格式：JSON

Name	Data Type	Required	Description
userId	string	Yes	用户 ID
exceptSessionId	string	No	保留的会话 ID（可选，通常为当前会话）

type RequestBody = {
  /** 用户 ID */
  userId: string
  /** 保留的会话 ID（可选，通常为当前会话） */
  exceptSessionId?: string
}

{
  "userId": "01JD8SEGQ0P9N2XK4L7VDH3T6C",
  "exceptSessionId": "01JD8SEGVK6MZ7W3Q4RT5N8YB2"
}

回复使用统一信封 {id, code, messages, result}，其 result：

Name	Data Type	Required	Description
revoked	number	Yes	实际吊销的会话数

type ResponseBody = {
  /** 实际吊销的会话数 */
  revoked: number
}

{
  "revoked": 3
}

回复使用统一信封 {id, code, messages, result}，其 code 字段：

code	Meaning	Notes
0	成功	吊销用户全部会话

{ "userId": "01JD8SEGQ0P9N2XK4L7VDH3T6C", "exceptSessionId": "01JD8SEGVK6MZ7W3Q4RT5N8YB2" }

{
  "id": "01JD8SV15N7G3I0JF",
  "code": 0,
  "messages": [],
  "result": { "revoked": 3 }
}