エンドポイントの取り消し

/oauth2/revoke エンドポイントは、指定した更新トークンを使用して Amazon Cognito が最初に発行したユーザーのアクセストークンを取り消します。このエンドポイントは、同じ更新トークンから後続のすべてのアクセストークンと ID トークンも取り消します。エンドポイントがトークンを取り消した後は、取り消したアクセストークンを使用して Amazon Cognito トークンAPIsが認証する にアクセスすることはできません。

POST /oauth2/revoke

/oauth2/revoke エンドポイントは HTTPS POST のみをサポートします。ユーザープールクライアントは、システムブラウザ経由ではなくこのエンドポイントに直接リクエストを送信します。

ヘッダーのリクエストパラメータ

Authorization

アプリケーションクライアントにクライアントシークレットがある場合、アプリケーションは基本認証を介して認証ヘッダーclient_secretで client_idと を渡す必要がありますHTTP。シークレットはベーシック 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オブジェクトです。

エンドポイントエラー

• トークンがリクエストに存在しない場合、またはアプリケーションクライアントでこの機能が無効になっている場合は、400 HTTP とエラー が表示されますinvalid_request。

• Amazon Cognito が失効リクエストで送信したトークンが更新トークンでない場合、400 HTTP とエラー が表示されますunsupported_token_type。

• クライアント認証情報が有効でない場合、401 HTTP とエラー が表示されますinvalid_client。

• トークンが取り消された場合、またはクライアントが無効なトークンを送信した場合、200 HTTP OK を受け取ります。