Method: accounts.signInWithCustomToken

透過交換自訂驗證權杖，讓使用者登入或註冊。使用者成功登入或註冊後，系統會為使用者發出新的 Identity Platform ID 權杖和重新整理權杖。

如要識別 Google Cloud 專案，請在要求中提供 API 金鑰。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "token": string,
  "instanceId": string,
  "returnSecureToken": boolean,
  "delegatedProjectNumber": string,
  "tenantId": string
}
欄位
token

string

這是必要旗標，開發人員斷言的自訂驗證權杖。憑證應為 JSON Web Token (JWT)，其中包含「自訂憑證宣告」部分中 API 參考資料所列的聲明。
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。