Method: projects.accounts.update

Aktualisiert kontobezogene Informationen für den angegebenen Nutzer, indem bestimmte Felder festgelegt oder Aktionscodes angewendet werden. Anfragen von Administratoren und Endnutzern werden unterstützt.

HTTP-Anfrage

POST https://identitytoolkit.googleapis.com/v1/projects/{targetProjectId}/accounts:update

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
targetProjectId

string

Die Projekt-ID des Projekts, zu dem das Konto gehört. Für die Angabe dieses Felds sind Google OAuth 2.0-Anmeldedaten mit den richtigen Berechtigungen erforderlich. Anfragen von Endnutzern sollten stattdessen ein Identity Platform-ID-Token übergeben.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource targetProjectId erforderlich:

  • firebaseauth.users.update

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "idToken": string,
  "localId": string,
  "displayName": string,
  "email": string,
  "password": string,
  "provider": [
    string
  ],
  "oobCode": string,
  "emailVerified": boolean,
  "upgradeToFederatedLogin": boolean,
  "captchaChallenge": string,
  "captchaResponse": string,
  "validSince": string,
  "disableUser": boolean,
  "instanceId": string,
  "delegatedProjectNumber": string,
  "photoUrl": string,
  "deleteAttribute": [
    enum (UserAttributeName)
  ],
  "returnSecureToken": boolean,
  "deleteProvider": [
    string
  ],
  "lastLoginAt": string,
  "createdAt": string,
  "phoneNumber": string,
  "customAttributes": string,
  "tenantId": string,
  "mfa": {
    object (MfaInfo)
  },
  "linkProviderUserInfo": {
    object (ProviderUserInfo)
  }
}
Felder
idToken

string

Ein gültiges Identity Platform-ID-Token. Erforderlich, wenn Sie versuchen, nutzerbezogene Informationen zu ändern.

localId

string

Die ID des Nutzers. Für die Angabe dieses Felds sind Google OAuth 2.0-Anmeldedaten mit den richtigen Berechtigungen erforderlich. Für Anfragen von Endnutzern sollte stattdessen ein ID-Token übergeben werden.

displayName

string

Der neue Anzeigename des Nutzers, der in den Attributen des Kontos aktualisiert werden soll. Der Anzeigename darf maximal 256 Zeichen lang sein.

email

string

Die neue E-Mail-Adresse des Nutzers, die in den Attributen des Kontos aktualisiert werden soll. 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. Wenn der Schutz vor E-Mail-Aufzählung aktiviert ist, kann die E-Mail-Adresse vom Nutzer nicht geändert werden, ohne dass er sie zuerst bestätigt hat. Sie kann jedoch von einem Administrator geändert werden.

password

string

Das neue Passwort des Nutzers, das in den Attributen des Kontos aktualisiert werden soll. Das Passwort muss aus mindestens 6 Zeichen bestehen.

provider[]

string

Die Identitätsanbieter, mit denen das Konto verknüpft werden soll.

oobCode

string

Der Out-of-Band-Code, der auf das Konto des Nutzers angewendet werden soll. Die folgenden Out-of-Band-Codetypen werden unterstützt: * VERIFY_EMAIL * RECOVER_EMAIL * REVERT_SECOND_FACTOR_ADDITION * VERIFY_AND_CHANGE_EMAIL

emailVerified

boolean

Gibt an, ob die E-Mail-Adresse des Nutzers bestätigt wurde. Für die Angabe dieses Felds sind Google OAuth 2.0-Anmeldedaten mit den richtigen Berechtigungen erforderlich.

upgradeToFederatedLogin

boolean

Ob das Konto auf die Verwendung der föderierten Anmeldung beschränkt werden soll.

captchaChallenge
(deprecated)

string

captchaResponse

string

Die Antwort von reCAPTCHA. Dies ist erforderlich, wenn das System mögliche Missbrauchsaktivitäten erkennt.

validSince

string (int64 format)

Gibt den Mindestzeitstempel in Sekunden an, der für ein Identity Platform-ID-Token erforderlich ist, damit es als gültig betrachtet wird.

disableUser

boolean

Wenn „true“ angegeben ist, wird das Konto als deaktiviert markiert. Der Nutzer kann sich dann nicht mehr anmelden.

instanceId
(deprecated)

string

delegatedProjectNumber
(deprecated)

string (int64 format)

photoUrl

string

Die neue Foto-URL des Nutzers, die das Profilbild des Kontos in den Attributen des Kontos aktualisieren soll. Die URL darf maximal 2.048 Zeichen lang sein.

deleteAttribute[]

enum (UserAttributeName)

returnSecureToken

boolean

Gibt an, ob eine ID und ein Aktualisierungstoken zurückgegeben werden sollen. Sollte immer wahr sein.

deleteProvider[]

string

Die Identitätsanbieter, deren Verknüpfung mit dem Konto des Nutzers aufgehoben werden soll.

lastLoginAt

string (int64 format)

Der Zeitstempel in Millisekunden, zu dem sich das Konto zuletzt angemeldet hat.

createdAt

string (int64 format)

Der Zeitstempel in Millisekunden, zu dem das Konto erstellt wurde.

phoneNumber

string

Die Telefonnummer, die in den Attributen des Kontos aktualisiert werden soll.

customAttributes

string

Benutzerdefinierte Attribute im JSON-Format, die im Identity Platform-ID-Token gespeichert werden sollen. Für die Angabe dieses Felds sind Google OAuth 2.0-Anmeldedaten mit den richtigen Berechtigungen erforderlich.

tenantId

string

Die Mandanten-ID des Identity Platform-Mandanten, zu dem das Konto gehört. Anfragen von Endnutzern sollten ein Identity Platform-ID-Token übergeben, anstatt dieses Feld festzulegen.

mfa

object (MfaInfo)

Die Informationen zur Multi-Faktor-Authentifizierung, die im Konto des Nutzers festgelegt werden sollen. Dadurch werden alle vorherigen Informationen zur Multi-Faktor-Authentifizierung im Konto überschrieben. Für die Angabe dieses Felds sind Google OAuth 2.0-Anmeldedaten mit den richtigen Berechtigungen erforderlich.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von SetAccountInfoResponse.

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.