撤銷端點

/oauth2/revoke端點會撤銷 Amazon Cognito 最初使用您提供的重新整理權杖發行的使用者存取權杖。此端點還撤銷來自同一刷新令牌的所有後續訪問和身份令牌。端點撤銷權杖後，您無法使用已撤銷的存取權杖存取 Amazon Cognito 權杖進行身分驗證的 API。

POST /oauth2/revoke

/oauth2/revoke 端點僅支援 HTTPS POST。使用者集區用戶端會直接對此端點提出請求，而不是透過系統瀏覽器。

標頭中的請求參數

Authorization

如果您的應用程序客戶端具有客戶端密鑰，則應用程序必須通過 Basic HTTP 授權client_secret在授權標頭中傳遞其client_id密鑰。密碼是基本 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。