Method: accounts.signInWithCustomToken

カスタム認証トークンを交換して、ユーザーをログインまたは登録します。ログインまたは登録が成功すると、ユーザーに新しい Identity Platform ID トークンと更新トークンが発行されます。

Google Cloud プロジェクトを識別するには、リクエストに API キーが必要です。

HTTP リクエスト

POST https://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "token": string,
  "instanceId": string,
  "returnSecureToken": boolean,
  "delegatedProjectNumber": string,
  "tenantId": string
}
フィールド
token

string

必須。デベロッパーがアサートしたカスタム Auth トークン。トークンは、API リファレンスの「カスタム トークン クレーム」セクションに記載されているクレームを含む JSON Web Token（JWT）である必要があります。
instanceId
(deprecated)

string
returnSecureToken

boolean

常に true を指定します。
delegatedProjectNumber
(deprecated)

string (int64 format)
tenantId

string

ユーザーがログインしている Identity Platform テナントの ID。存在する場合、ID はトークンの tenantId と一致している必要があります。

レスポンスの本文

accounts.signInWithCustomToken のレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "kind": string,
  "idToken": string,
  "refreshToken": string,
  "expiresIn": string,
  "isNewUser": boolean
}
フィールド
kind
(deprecated)

string
idToken

string

認証済みユーザーの Identity Platform ID トークン。
refreshToken

string

認証されたユーザーの Identity Platform 更新トークン。
expiresIn

string (int64 format)

ID トークンの有効期限が切れるまでの秒数。
isNewUser

boolean

認証済みユーザーがこのリクエストによって作成されたかどうか。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。