Questa pagina è stata tradotta dall'API Cloud Translation.

Method: accounts.signInWithEmailLink

Richiesta HTTP
Corpo della richiesta
- Rappresentazione JSON
Corpo della risposta
- Rappresentazione JSON
Ambiti di autorizzazione
Prova!

Consente a un utente di accedere o registrarsi con un codice out-of-band da un link email. Se non esiste un utente con l'indirizzo email specificato, verrà creato un record utente. Se l'accesso va a buon fine, vengono emessi un ID Identity Platform e un token di aggiornamento per l'utente autenticato.

Per identificare il progetto Google Cloud, nella richiesta è obbligatoria una chiave API.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{ "oobCode": string, "email": string, "idToken": string, "tenantId": string }

Campi
`oobCode`	`string` Obbligatorio. Il codice out-of-band dal link dell'email.
`email`	`string` Obbligatorio. L'indirizzo email a cui è stato inviato il link di accesso. La lunghezza dell'email deve essere inferiore a 256 caratteri e nel formato `name@domain.tld`. L'email deve inoltre corrispondere alla produzione di addr-spec RFC 822.
`idToken`	`string` Un token ID valido per un account Identity Platform. Se viene passata, questa richiesta collegherà l'indirizzo email all'utente rappresentato da questo token ID e attiverà l'accesso con il link email nell'account per il futuro.
`tenantId`	`string` L'ID del tenant Identity Platform a cui l'utente sta accedendo. Se non è impostato, l'utente accederà al progetto Identity Platform predefinito.

Corpo della risposta

Messaggio di risposta per accounts.signInWithEmailLink.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON

Rappresentazione 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)
    }
  ]
}

Campi
`kind (deprecated)`	`string` Questo elemento è deprecato.
`idToken`	`string` Un token ID Identity Platform per l'utente autenticato.
`email`	`string` L'indirizzo email con cui l'utente ha eseguito l'accesso. Sempre presente nella risposta.
`refreshToken`	`string` Token di aggiornamento per l'utente autenticato.
`expiresIn`	`string (int64 format)` Il numero di secondi che rimangono prima della scadenza del token ID.
`localId`	`string` L'ID dell'utente autenticato. Sempre presente nella risposta.
`isNewUser`	`boolean` Indica se l'utente autenticato è stato creato da questa richiesta.
`mfaPendingCredential`	`string` Una stringa opaca che funge da prova del fatto che l'utente ha superato correttamente il controllo del primo fattore.
`mfaInfo[]`	`object (MfaEnrollment)` Informazioni sui fornitori di autenticazione a più fattori abilitati. Presente se l'utente deve completare l'accesso utilizzando l'autenticazione a più fattori.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la sezione Authentication Overview.