Diese Seite wurde von der Cloud Translation API übersetzt.

Method: accounts.signInWithEmailLink

HTTP-Anfrage
Anfragetext
- JSON-Darstellung
Antworttext
- JSON-Darstellung
Autorisierungsbereiche
Testen!

Meldet einen Nutzer mit einem externen Bestätigungscode über einen E-Mail-Link an oder registriert ihn. Wenn kein Nutzer mit der angegebenen E-Mail-Adresse vorhanden ist, wird ein Nutzereintrag erstellt. Wenn die Anmeldung erfolgreich ist, werden für den authentifizierten Nutzer eine Identity Platform-ID und ein Aktualisierungstoken ausgestellt.

In der Anfrage ist ein API-Schlüssel erforderlich, um das Google Cloud-Projekt zu identifizieren.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{ "oobCode": string, "email": string, "idToken": string, "tenantId": string }

Felder
`oobCode`	`string` Pflichtangabe. Den Out-of-Band-Code aus dem E-Mail-Link.
`email`	`string` Pflichtangabe. Die E-Mail-Adresse, an die der Anmeldelink gesendet wurde. Die E-Mail-Adresse darf maximal 256 Zeichen lang sein und muss im Format `name@domain.tld` sein. Die E-Mail-Adresse muss außerdem der RFC 822-Adressenspezifikation entsprechen.
`idToken`	`string` Ein gültiges ID-Token für ein Identity Platform-Konto. Wenn die Anfrage erfolgreich ist, wird die E-Mail-Adresse mit dem Nutzer verknüpft, der durch dieses ID-Token vertreten wird. Außerdem wird die Anmeldung über den E-Mail-Link im Konto für die Zukunft aktiviert.
`tenantId`	`string` Die ID des Identity Platform-Mandanten, bei dem sich der Nutzer anmeldet. Wenn nicht festgelegt, meldet sich der Nutzer im Standardprojekt von Identity Platform an.

Antworttext

Antwortnachricht für accounts.signInWithEmailLink.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung

JSON-Darstellung
{ "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)
    }
  ]
}

Felder
`kind (deprecated)`	`string` Dieses Element ist veraltet.
`idToken`	`string` Ein Identity Platform-ID-Token für den authentifizierten Nutzer.
`email`	`string` Die E-Mail-Adresse, mit der sich der Nutzer angemeldet hat. Muss immer in der Antwort vorhanden sein.
`refreshToken`	`string` Aktualisierungstoken für den authentifizierten Nutzer.
`expiresIn`	`string (int64 format)` Die Anzahl der Sekunden, bis das ID-Token abläuft.
`localId`	`string` Die ID des authentifizierten Nutzers. Muss immer in der Antwort vorhanden sein.
`isNewUser`	`boolean` Gibt an, ob der authentifizierte Nutzer durch diese Anfrage erstellt wurde.
`mfaPendingCredential`	`string` Ein undurchsichtiger String, der als Nachweis dient, dass der Nutzer die erste Faktorprüfung bestanden hat.
`mfaInfo[]`	`object (MfaEnrollment)` Informationen dazu, welche Anbieter für die Multi-Faktor-Authentifizierung aktiviert sind. Wird angezeigt, wenn der Nutzer die Anmeldung mit der Multi-Faktor-Authentifizierung abschließen muss.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.