本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
權杖撤銷端點
在其工作階段中擁有重新整理權杖的使用者具有類似瀏覽器 Cookie 的內容。只要重新整理權杖有效,他們可以續約現有的工作階段。您的應用程式可以使用重新整理權杖來取得新的有效權杖,而不是在其 ID 或存取權杖過期後提示使用者登入。不過,您可以從外部判斷使用者的工作階段應該結束,或者使用者可能會選擇忘記目前的工作階段。此時,您可以撤銷該重新整理權杖,讓他們無法繼續保留工作階段。
/oauth2/revoke
端點會撤銷 Amazon Cognito 最初使用您提供的重新整理權杖發出的使用者存取權杖。此端點也會從相同的重新整理權杖撤銷重新整理權杖本身,以及所有後續的存取和身分權杖。端點撤銷權杖後,您就無法使用撤銷的存取權杖來存取 APIs Amazon Cognito 權杖驗證的存取權。
POST /oauth2/revoke
/oauth2/revoke
端點僅支援 HTTPS
POST
。使用者集區用戶端會直接對此端點提出請求,而不是透過系統瀏覽器。
標頭中的請求參數
Authorization
-
如果您的應用程式用戶端具有用戶端秘密,則應用程式必須透過基本HTTP授權在授權標頭
client_secret
中傳遞其client_id
和 。密碼是基本Base64Encode(client_id:client_secret)
。 Content-Type
-
必須一律為
'application/x-www-form-urlencoded'
。
內文中的請求參數
token
-
(必要) 用戶端想要撤銷的重新整理權杖。請求也會撤銷 Amazon Cognito 從重新整理權杖發出的所有存取權杖。
必要。
client_id
-
(選用) 您要撤銷之權杖的應用程式用戶端 ID。
如果用戶端是公開的,且沒有密碼,此為必要值。
撤銷請求範例
此撤銷請求會撤銷沒有用戶端秘密之應用程式用戶端的重新整理權杖。記下請求內文中的 client_id
參數。
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
此撤銷請求會撤銷具有用戶端秘密之應用程式用戶端的重新整理權杖。請注意標頭,Authorization
其中包含編碼的用戶端 ID 和用戶端秘密,但在請求內文client_id
中沒有 。
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
欄位的JSON物件,在某些情況下,還有error_description
欄位。
端點錯誤
-
如果請求中沒有權杖,或者應用程式用戶端已停用此功能,則會收到 HTTP 400 和錯誤
invalid_request
。 -
如果 Amazon Cognito 在撤銷請求中傳送的權杖不是重新整理權杖,您會收到 HTTP 400 和錯誤
unsupported_token_type
。 -
如果用戶端憑證無效,您會收到 HTTP 401 和錯誤
invalid_client
。 -
如果字符已被撤銷,或者如果用戶端提交了無效的字符,您將收到 HTTP 200 OK。