Method: accounts.signInWithCustomToken

Permite que un usuario acceda o se registre mediante el intercambio de un token de Auth personalizado. Cuando el acceso o el registro son correctos, se emiten un nuevo token de ID y un token de actualización de Identity Platform para el usuario.

Se requiere una clave de API en la solicitud para identificar el proyecto de Google Cloud.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "token": string,
  "instanceId": string,
  "returnSecureToken": boolean,
  "delegatedProjectNumber": string,
  "tenantId": string
}
Campos
token

string

Obligatorio. Es el token de autenticación personalizado que declara el desarrollador. El token debe ser un token web JSON (JWT) que incluya las reclamaciones que se indican en la referencia de la API, en la sección "Reivindicaciones de tokens personalizados".

instanceId
(deprecated)

string

returnSecureToken

boolean

Siempre debe ser verdadero.

delegatedProjectNumber
(deprecated)

string (int64 format)

tenantId

string

El ID del grupo de usuarios de Identity Platform al que accede el usuario. Si está presente, el ID debe coincidir con el tenantId en el token.

Cuerpo de la respuesta

Mensaje de respuesta para accounts.signInWithCustomToken.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "kind": string,
  "idToken": string,
  "refreshToken": string,
  "expiresIn": string,
  "isNewUser": boolean
}
Campos
kind
(deprecated)

string

idToken

string

Un token de ID de Identity Platform para el usuario autenticado.

refreshToken

string

Un token de actualización de Identity Platform para el usuario autenticado.

expiresIn

string (int64 format)

Es la cantidad de segundos hasta que vence el token de ID.

isNewUser

boolean

Indica si esta solicitud creó el usuario autenticado.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.