Method: accounts.signInWithCustomToken

Meldet einen Nutzer an oder registriert ihn, indem ein benutzerdefiniertes Auth-Token ausgetauscht wird. Nach einer erfolgreichen Anmeldung oder Registrierung werden für den Nutzer ein neues Identity Platform-ID-Token und ein neues 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:signInWithCustomToken

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "token": string,
  "instanceId": string,
  "returnSecureToken": boolean,
  "delegatedProjectNumber": string,
  "tenantId": string
}
Felder
token

string

Pflichtangabe. Das vom Entwickler angegebene benutzerdefinierte Authentifizierungstoken. Das Token sollte ein JSON Web Token (JWT) sein, das die in der API-Referenz im Abschnitt „Anpassbare Tokenanforderungen“ aufgeführten Anforderungen enthält.
instanceId
(deprecated)

string
returnSecureToken

boolean

Sollte immer wahr sein.
delegatedProjectNumber
(deprecated)

string (int64 format)
tenantId

string

Die ID des Identity Platform-Mandanten, bei dem sich der Nutzer anmeldet. Falls vorhanden, muss die ID mit der Mandanten-ID im Token übereinstimmen.

Antworttext

Antwortnachricht für accounts.signInWithCustomToken

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

JSON-Darstellung 
{
  "kind": string,
  "idToken": string,
  "refreshToken": string,
  "expiresIn": string,
  "isNewUser": boolean
}
Felder
kind
(deprecated)

string
idToken

string

Ein Identity Platform-ID-Token für den authentifizierten Nutzer.
refreshToken

string

Ein aktualisierter Identity Platform-Token für den authentifizierten Nutzer.
expiresIn

string (int64 format)

Die Anzahl der Sekunden, bis das ID-Token abläuft.
isNewUser

boolean

Gibt an, ob der authentifizierte Nutzer durch diese Anfrage erstellt wurde.

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.