REVOCATION 端点 - Amazon Cognito
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

REVOCATION 端点

该 /oauth2/revoke 端点撤销指定刷新令牌生成的所有访问令牌。端点撤销令牌后,您无法使用已撤销的令牌访问 Amazon Cognito 令牌进行身份验证的 API。

POST /oauth2/revoke

/oauth2/revoke 终端节点只支持 HTTPS POST。用户池客户端直接对此终端节点发出请求,而不通过系统浏览器。

标头中的请求参数

授权

如果应用程序客户端具有客户端密钥,则客户端必须通过基本 HTTP 授权在其授权标头中传递 client_idclient_secret。密钥是基本 Base64Encode(client_id:client_secret)

Content-Type

必须始终为 'application/x-www-form-urlencoded'

正文中的请求参数

token

客户端要撤消的刷新令牌。该请求还撤销 Amazon Cognito 从此刷新令牌发出的所有访问令牌。

必填项。

client_id

您要撤消的令牌的应用程序客户端 ID。

如果客户端是公有的且没有密钥,则为必需。

撤消请求示例

示例 1:为没有客户端密钥的应用程序客户端撤消令牌

POST /oauth2/revoke HTTP/1.1 Host: https://mydomain.auth.us-east-1.amazoncognito.com Accept: application/json Content-Type: application/x-www-form-urlencoded token=2YotnFZFEjr1zCsicMWpAA& client_id=djc98u3jiedmi283eu928

示例 2:为具有客户端密钥的应用程序客户端撤消令牌

POST /oauth2/revoke HTTP/1.1 Host: https://mydomain.auth.us-east-1.amazoncognito.com Accept: application/json Content-Type: application/x-www-form-urlencoded Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW token=2YotnFZFEjr1zCsicMWpAA
撤消错误响应

成功的响应包含空正文。错误响应是一个带有 error 字段和 error_description 字段(在某些情况下)的 JSON 对象。

端点错误

  • 如果令牌在请求中不存在或者应用程序客户端禁用了该功能,则您会收到 HTTP 400 和错误 invalid_request

  • 如果 Amazon Cognito 在撤销请求中发送的令牌不是刷新令牌,则您会收到 HTTP 400 和错误 unsupported_token_type

  • 如果客户端凭证无效,则您会收到 HTTP 401 和错误 invalid_client

  • 如果令牌已撤销或客户端提交的令牌无效,您会收到 HTTP 200 OK。