Cette page a été traduite par l'API Cloud Translation.

Method: accounts.signInWithEmailLink

Requête HTTP
Corps de la requête
- Représentation JSON
Corps de la réponse
- Représentation JSON
Champs d'application des autorisations
Essayer

Connecte ou inscrit un utilisateur à l'aide d'un code hors bande à partir d'un lien par e-mail. Si aucun utilisateur n'existe avec l'adresse e-mail indiquée, un enregistrement utilisateur sera créé. Si la connexion réussit, un ID Identity Platform et un jeton d'actualisation sont émis pour l'utilisateur authentifié.

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:signInWithEmailLink

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
{ "oobCode": string, "email": string, "idToken": string, "tenantId": string }

Champs
`oobCode`	`string` Obligatoire. Code hors bande du lien de l'e-mail.
`email`	`string` Obligatoire. Adresse e-mail à laquelle le lien de connexion a été envoyé. L'e-mail doit comporter moins de 256 caractères et être au format `name@domain.tld`. L'adresse e-mail doit également correspondre à la production d'adresses RFC 822.
`idToken`	`string` Jeton d'ID valide pour un compte Identity Platform. Si cette valeur est transmise, cette requête associera l'adresse e-mail à l'utilisateur représenté par ce jeton d'identité et activera la connexion avec l'adresse e-mail dans le compte à l'avenir.
`tenantId`	`string` ID du locataire Identity Platform auquel l'utilisateur se connecte. Si ce paramètre n'est pas défini, l'utilisateur se connectera au projet Identity Platform par défaut.

Corps de la réponse

Message de réponse pour accounts.signInWithEmailLink.

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

Représentation JSON

Représentation JSON
{ "kind": string, "idToken": string, "email": string, "refreshToken": string, "expiresIn": string, "localId": string, "isNewUser": boolean, "mfaPendingCredential": string, "mfaInfo": [ { object (`MfaEnrollment`) } ] }

{
  "kind": string,
  "idToken": string,
  "email": string,
  "refreshToken": string,
  "expiresIn": string,
  "localId": string,
  "isNewUser": boolean,
  "mfaPendingCredential": string,
  "mfaInfo": [
    {
      object (MfaEnrollment)
    }
  ]
}

Champs
`kind (deprecated)`	`string` Cet élément est obsolète.
`idToken`	`string` Jeton d'ID Identity Platform de l'utilisateur authentifié.
`email`	`string` Adresse e-mail avec laquelle l'utilisateur s'est connecté. Toujours présent dans la réponse.
`refreshToken`	`string` Jeton d'actualisation de l'utilisateur authentifié.
`expiresIn`	`string (int64 format)` Nombre de secondes avant l'expiration du jeton d'ID.
`localId`	`string` ID de l'utilisateur authentifié. Toujours présent dans la réponse.
`isNewUser`	`boolean` Indique si l'utilisateur authentifié a été créé par cette requête.
`mfaPendingCredential`	`string` Chaîne opaque qui sert de preuve que l'utilisateur a réussi la vérification du premier facteur.
`mfaInfo[]`	`object (MfaEnrollment)` Informations sur les fournisseurs d'authentification multifacteur activés. Présent si l'utilisateur doit se connecter à l'aide de l'authentification multifacteur.

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.