Permite que un usuario acceda o se registre con un código fuera de banda desde un vínculo de correo electrónico. Si no existe un usuario con la dirección de correo electrónico proporcionada, se creará un registro de usuario. Si el acceso se realiza de forma correcta, se emite un ID de Identity Platform y un token de actualización para el usuario autenticado.
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:signInWithEmailLink
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 |
|---|
{ "oobCode": string, "email": string, "idToken": string, "tenantId": string } |
| Campos | |
|---|---|
oobCode |
Obligatorio. El código fuera de banda del vínculo del correo electrónico |
email |
Obligatorio. La dirección de correo electrónico a la que se envió el vínculo de acceso La longitud del correo electrónico debe ser inferior a 256 caracteres y debe tener el formato |
idToken |
Un token de ID válido para una cuenta de Identity Platform Si se aprueba, esta solicitud vinculará la dirección de correo electrónico al usuario representado por este token de ID y habilitará el vínculo de acceso con correo electrónico en la cuenta para el futuro. |
tenantId |
El ID del grupo de usuarios de Identity Platform al que accede el usuario. Si no se establece, el usuario accederá al proyecto predeterminado de Identity Platform. |
Cuerpo de la respuesta
Mensaje de respuesta para accounts.signInWithEmailLink.
Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:
| Representación JSON |
|---|
{
"kind": string,
"idToken": string,
"email": string,
"refreshToken": string,
"expiresIn": string,
"localId": string,
"isNewUser": boolean,
"mfaPendingCredential": string,
"mfaInfo": [
{
object ( |
| Campos | |
|---|---|
kind |
|
idToken |
Un token de ID de Identity Platform para el usuario autenticado. |
email |
El correo electrónico con el que accedió el usuario. Siempre está presente en la respuesta. |
refreshToken |
Token de actualización para el usuario autenticado. |
expiresIn |
Es la cantidad de segundos hasta que vence el token de ID. |
localId |
El ID del usuario autenticado. Siempre está presente en la respuesta. |
isNewUser |
Indica si esta solicitud creó el usuario autenticado. |
mfaPendingCredential |
Es una cadena opaca que funciona como prueba de que el usuario pasó correctamente la verificación del primer factor. |
mfaInfo[] |
Información sobre qué proveedores de autenticación de varios factores están habilitados. Se muestra si el usuario necesita completar el acceso con la autenticación de varios factores. |
Permisos de autorización
Se necesita uno de los siguientes permisos de OAuth:
https://www.googleapis.com/auth/identitytoolkithttps://www.googleapis.com/auth/cloud-platform
Para obtener más información, consulta Authentication Overview.