Method: accounts.signInWithCustomToken

Faz o login ou o registro de um usuário trocando um token de autenticação personalizado. Após o login ou registro, um novo token de ID e um token de atualização do Identity Platform são emitidos para o usuário.

Uma chave de API é necessária na solicitação para identificar o projeto do Google Cloud.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "token": string,
  "instanceId": string,
  "returnSecureToken": boolean,
  "delegatedProjectNumber": string,
  "tenantId": string
}
Campos
token

string

Obrigatório. O token de autenticação personalizado declarado pelo desenvolvedor. O token precisa ser um token da Web JSON (JWT) que inclua as declarações listadas na referência da API na seção "Declarações de token personalizadas".
instanceId
(deprecated)

string
returnSecureToken

boolean

Precisa ser sempre verdadeiro.
delegatedProjectNumber
(deprecated)

string (int64 format)
tenantId

string

O ID do locatário do Identity Platform em que o usuário está fazendo login. Se presente, o ID precisa corresponder ao tenantId no token.

Corpo da resposta

Mensagem de resposta para accounts.signInWithCustomToken.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "kind": string,
  "idToken": string,
  "refreshToken": string,
  "expiresIn": string,
  "isNewUser": boolean
}
Campos
kind
(deprecated)

string
idToken

string

Um token de ID do Identity Platform para o usuário autenticado.
refreshToken

string

Um token de atualização do Identity Platform para o usuário autenticado.
expiresIn

string (int64 format)

O número de segundos até o token de ID expirar.
isNewUser

boolean

Informa se o usuário autenticado foi criado por essa solicitação.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.