Method: accounts.signInWithCustomToken

Connecte ou inscrit un utilisateur en échangeant un jeton Auth personnalisé. Une fois la connexion ou l'inscription effectuée, un nouveau jeton d'ID et un nouveau jeton d'actualisation Identity Platform sont émis pour l'utilisateur.

Une clé API est requise dans la requête pour identifier le projet Google Cloud.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON
{
  "token": string,
  "instanceId": string,
  "returnSecureToken": boolean,
  "delegatedProjectNumber": string,
  "tenantId": string
}
Champs
token

string

Obligatoire. Jeton d'authentification personnalisé affirmé par le développeur. Le jeton doit être un jeton Web JSON (JWT) qui inclut les revendications listées dans la documentation de référence de l'API, sous la section "Revendications de jeton personnalisées".

instanceId
(deprecated)

string

returnSecureToken

boolean

Doit toujours être défini sur "true".

delegatedProjectNumber
(deprecated)

string (int64 format)

tenantId

string

ID du locataire Identity Platform auquel l'utilisateur se connecte. Le cas échéant, l'ID doit correspondre à l'ID de locataire dans le jeton.

Corps de la réponse

Message de réponse pour accounts.signInWithCustomToken.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "kind": string,
  "idToken": string,
  "refreshToken": string,
  "expiresIn": string,
  "isNewUser": boolean
}
Champs
kind
(deprecated)

string

idToken

string

Jeton d'ID Identity Platform de l'utilisateur authentifié.

refreshToken

string

Jeton d'actualisation Identity Platform de l'utilisateur authentifié.

expiresIn

string (int64 format)

Nombre de secondes avant l'expiration du jeton d'ID.

isNewUser

boolean

Indique si l'utilisateur authentifié a été créé par cette requête.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez Authentication Overview.