Method: accounts.signInWithCustomToken

通过交换自定义 Auth 令牌来登录或注册用户。用户成功登录或注册后，系统会为其颁发新的 Identity Platform ID 令牌和刷新令牌。

请求中必须包含 API 密钥，以便识别 Google Cloud 项目。

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 令牌 (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。