從 Identity Provider (IdP) 撤銷使用者的權杖。方法是手動提供 IdP 憑證,以及要撤銷的權杖類型。
如要識別 Google Cloud 專案,請在要求中提供 API 金鑰。
HTTP 要求
POST https://identitytoolkit.googleapis.com/v2/accounts:revokeToken
這個網址使用 gRPC 轉碼語法。
要求主體
要求主體包含下列結構的資料:
JSON 表示法 |
---|
{
"providerId": string,
"tokenType": enum ( |
欄位 | |
---|---|
providerId |
這是必要旗標,權杖的 IDp 供應工具。目前僅支援 Apple IdP。格式應為「apple.com」。 |
tokenType |
這是必要旗標,要撤銷的權杖類型。 |
token |
這是必要旗標,要撤銷的權杖。如果傳入授權碼,API 會先將這組驗證碼換成存取權杖,然後撤銷已交換的權杖。 |
idToken |
這是必要旗標,有效的 Identity Platform ID 權杖,用於連結帳戶。如果帳戶上有成功的符記撤銷要求,且撤銷後未產生任何符記,系統會立即忽略並傳回重複要求。 |
tenantId |
使用者要登入的 Identity Platform 租用戶 ID。如果未設定,使用者會登入預設的 Identity Platform 專案。 |
redirectUri |
用戶端向 IdP 提出的初始授權要求中提供的重新導向 URI。URI 必須採用 HTTPS 通訊協定、包含網域名稱,且不得包含 IP 位址或 localhost。如果 tokenType 是 CODE,則為必要屬性。 |
回應主體
如果成功,回應主體會留白。
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/identitytoolkit
https://www.googleapis.com/auth/cloud-platform
詳情請參閱 Authentication Overview。
TokenType
要撤銷的權杖類型。
列舉 | |
---|---|
TOKEN_TYPE_UNSPECIFIED |
預設值,請勿使用。 |
REFRESH_TOKEN |
權杖類型為 refreshToken。 |
ACCESS_TOKEN |
權杖類型為 accessToken。 |
CODE |
符記類型為 authorization_code。 |