Method: accounts.signInWithPassword

Meldet einen Nutzer mit E-Mail-Adresse und Passwort an. Wenn die Anmeldung erfolgreich ist, werden für den authentifizierten 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:signInWithPassword

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "email": string,
  "password": string,
  "pendingIdToken": string,
  "captchaChallenge": string,
  "captchaResponse": string,
  "instanceId": string,
  "delegatedProjectNumber": string,
  "idToken": string,
  "returnSecureToken": boolean,
  "tenantId": string,
  "clientType": enum (ClientType),
  "recaptchaVersion": enum (RecaptchaVersion)
}
Felder
email

string

Pflichtangabe. Die E-Mail-Adresse, mit der sich der Nutzer anmeldet. 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.
password

string

Pflichtangabe. Das Passwort, das der Nutzer für die Anmeldung im Konto angibt.
pendingIdToken
(deprecated)

string
captchaChallenge
(deprecated)

string
captchaResponse

string

Das reCAPTCHA-Token, das von der clientseitigen reCAPTCHA-Integration bereitgestellt wird. reCAPTCHA Enterprise verwendet es für die Risikobewertung. Erforderlich, wenn reCAPTCHA Enterprise aktiviert ist.
instanceId
(deprecated)

string
delegatedProjectNumber
(deprecated)

string (int64 format)
idToken
(deprecated)

string
returnSecureToken

boolean

Sollte immer wahr sein.
tenantId

string

Die ID des Identity Platform-Mandanten, bei dem sich der Nutzer anmeldet. Wenn nicht festgelegt, meldet sich der Nutzer in der Standard-Identity Platform-Instanz im Projekt an.
clientType

enum (ClientType)

Der Clienttyp: „web“, „android“ oder „ios“. Erforderlich, wenn reCAPTCHA Enterprise aktiviert ist.
recaptchaVersion

enum (RecaptchaVersion)

Die reCAPTCHA-Version des reCAPTCHA-Tokens in der captchaResponse.

Antworttext

Antwortnachricht für accounts.signInWithPassword

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

JSON-Darstellung 
{
  "kind": string,
  "localId": string,
  "email": string,
  "displayName": string,
  "idToken": string,
  "registered": boolean,
  "profilePicture": string,
  "oauthAccessToken": string,
  "oauthExpireIn": integer,
  "oauthAuthorizationCode": string,
  "refreshToken": string,
  "expiresIn": string,
  "mfaPendingCredential": string,
  "mfaInfo": [
    {
      object (MfaEnrollment)
    }
  ],
  "userNotifications": [
    {
      object (UserNotification)
    }
  ]
}
Felder
kind
(deprecated)

string
localId

string

Die ID des authentifizierten Nutzers. Muss immer in der Antwort vorhanden sein.
email

string

Die E-Mail-Adresse des authentifizierten Nutzers. Muss immer in der Antwort vorhanden sein.
displayName

string

Der Anzeigename des Nutzers, der in den Attributen des Kontos gespeichert ist.
idToken

string

Ein Identity Platform-ID-Token für den authentifizierten Nutzer.
registered
(deprecated)

boolean

Gibt an, ob dies die E-Mail-Adresse eines vorhandenen Kontos ist. Immer wahr.
profilePicture

string

Das Profilbild des Nutzers, das in den Attributen des Kontos gespeichert ist.
oauthAccessToken
(deprecated)

string

Das OAuth2-Zugriffstoken.
oauthExpireIn
(deprecated)

integer

Die Ablaufzeit des Zugriffstokens in Sekunden.
oauthAuthorizationCode
(deprecated)

string
refreshToken

string

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

string (int64 format)

Die Anzahl der Sekunden, bis das Identity Platform-ID-Token abläuft.
mfaPendingCredential

string

Ein nicht transparenter String, der als Nachweis dient, dass der Nutzer die Authentifizierung mit dem ersten Faktor bestanden hat.
mfaInfo[]

object (MfaEnrollment)

Informationen dazu, welche Anbieter für die Multi-Faktor-Authentifizierung für das Konto aktiviert sind. Wird angezeigt, wenn der Nutzer die Anmeldung mit der Multi-Faktor-Authentifizierung abschließen muss.
userNotifications[]

object (UserNotification)

Warnmeldungen für den Nutzer.

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.

UserNotification

Warnmeldungen für den Nutzer.

JSON-Darstellung 
{
  "notificationCode": enum (NotificationCode),
  "notificationMessage": string
}
Felder
notificationCode

enum (NotificationCode)

Enum für Warnmeldungen. Kann für die Lokalisierung verwendet werden.
notificationMessage

string

String für Warnmeldungen. Kann als Fallback verwendet werden.

NotificationCode

Enum für Warnmeldungen. Kann für die Lokalisierung verwendet werden.

Enums
NOTIFICATION_CODE_UNSPECIFIED Es wurde keine Benachrichtigung angegeben.
MISSING_LOWERCASE_CHARACTER Das Passwort enthält keinen Kleinbuchstaben.
MISSING_UPPERCASE_CHARACTER Das Passwort enthält keinen Großbuchstaben.
MISSING_NUMERIC_CHARACTER Das Passwort enthält kein numerisches Zeichen.
MISSING_NON_ALPHANUMERIC_CHARACTER Das Passwort enthält kein nicht alphanumerisches Zeichen.
MINIMUM_PASSWORD_LENGTH Das Passwort ist kürzer als die erforderliche Mindestlänge.
MAXIMUM_PASSWORD_LENGTH Das Passwort ist länger als die maximal zulässige Länge.