退出认证门户登录

最近更新时间:2024-09-18 11:31:01

我的收藏

接口描述

将用户(浏览器)重定向到此接口地址,退出登录并清除认证门户登录态。退出后,CIAM 会将用户重定向到应用的退出回调地址 logout_redirect_uri
说明:
此接口清除的是认证门户的登录态,用户在应用系统的登录态需要由应用自行清除。
本节请求示例中使用的应用系统 Logout Redirect URI 为 https://example.com/logout

支持的应用类型

Web 应用、单页应用、移动 App。

请求方法

GET

请求路径

/logout

请求示例

GET /logout?client_id=TENANT_CLIENT_ID&logout_redirect_uri=https%3A%2F%2Fexample.com%2Flogout HTTP/1.1
Host: sample.portal.tencentciam.com

请求参数

参数
可选
描述
client_id
false
应用的 client_id 。可参考 应用管理页面 > 选定指定应用 > 单击应用配置 > 对应的“Client Id”。
logout_redirect_uri
true
退出登录后的重定向地址,需要与应用参数配置中的 Logout Redirect URI 匹配。若应用仅配置了一条 Logout Redirect URI,则此参数可以不传,系统将默认使用该条配置作为退出登录后的重定向地址。
state
true
应用随机生成的一个字符串,重定向时将原样返回。

正常响应示例

HTTP/1.1 302 Found
Location: https://example.com/logout

异常响应示例

client_id 参数缺失

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
"error" : "invalid_request",
"error_description" : "Client ID parameter not found"
}