ID プロバイダ(IdP)からユーザーのトークンを取り消します。これは、IdP 認証情報と、取り消し用のトークンタイプを手動で指定することで行います。
Google Cloud プロジェクトを識別するには、リクエストに API キーが必要です。
HTTP リクエスト
POST https://identitytoolkit.googleapis.com/v2/accounts:revokeToken
この URL は gRPC Transcoding 構文を使用します。
リクエストの本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{
"providerId": string,
"tokenType": enum ( |
フィールド | |
---|---|
providerId |
必須。トークンの IDP プロバイダ。現在のところ、Apple Idp のみをサポートしています。形式は「apple.com」にする必要があります。 |
tokenType |
必須。取り消すトークンのタイプ。 |
token |
必須。取り消すトークン。authorization_code が渡された場合、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 です。 |