撤销令牌 - RevokeEmbedAuthToken
功能介绍
主动撤销 access_token 或 refresh_token。
URI
POST /v1/app/auth/token/revoke
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释： 请求体类型。 约束限制： 不涉及。 取值范围： 固定值：application/x-www-form-urlencoded。 默认取值： 不涉及。 |
| X-Cloud-Doc-AppId | 是 | String | 参数解释： APP ID。 约束限制： 不涉及。 取值范围： [1-128]个字符。 默认取值： 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| token | 是 | String | 参数解释： 需要撤销的Token。 约束限制： 不涉及。 取值范围： [1-1024]个字符。 默认取值： 不涉及。 |
| token_type | 是 | String | 参数解释： Token类型。 约束限制： 不涉及。 取值范围： 默认取值： 不涉及。 |
| client_id | 是 | String | 参数解释： APP ID。 约束限制： 不涉及。 取值范围： [1-128]个字符。 默认取值： 不涉及。 |
| client_secret | 是 | String | 参数解释： APP Secret。 约束限制： 不涉及。 取值范围： [1-256]个字符。 默认取值： 不涉及。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-Trace-Id | String | 业务跟踪ID。 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-Trace-Id | String | 业务跟踪ID。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
状态码：500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-Trace-Id | String | 业务跟踪ID。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
撤销token_type类型为access_token，值aaa.bbb.ccc的用户token。
https://{Endpoint}/v1/app/auth/token/revoke
{
"token" : "aaa.bbb.ccc",
"token_type" : "access_token",
"client_id" : "xxxxxx-yyyy-23",
"client_secret" : "xxxxxxxxxxxxxxxxx"
} 响应示例
状态码：200
无
状态码：400
{
"error_code" : "KPGE.00001000",
"error_msg" : "Parameter error."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 400 | 错误响应。 |
| 500 | 错误响应。 |
错误码
请参见错误码。
