Method: accounts.signUp

Ermöglicht die Registrierung eines neuen Nutzers mit E-Mail-Adresse und Passwort oder eines anonymen Nutzers oder wandelt einen anonymen Nutzer in einen Nutzer mit E-Mail-Adresse und Passwort um. Bei einer Administratoranfrage mit Google OAuth 2.0-Anmeldedaten mit den richtigen Berechtigungen wird ein neuer anonymer Nutzer mit E-Mail-Adresse und Passwort oder Telefonnummer erstellt.

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:signUp

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "email": string,
  "password": string,
  "displayName": string,
  "captchaChallenge": string,
  "captchaResponse": string,
  "instanceId": string,
  "idToken": string,
  "emailVerified": boolean,
  "photoUrl": string,
  "disabled": boolean,
  "localId": string,
  "phoneNumber": string,
  "tenantId": string,
  "targetProjectId": string,
  "mfaInfo": [
    {
      object (MfaFactor)
    }
  ],
  "clientType": enum (ClientType),
  "recaptchaVersion": enum (RecaptchaVersion)
}
Felder
email

string

Die E-Mail-Adresse, die dem erstellten Nutzer zugewiesen werden soll. Die E-Mail 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. Andernfalls wird ein anonymer Nutzer erstellt.
password

string

Das Passwort, das dem erstellten Nutzer zugewiesen werden soll. Das Passwort muss mindestens sechs Zeichen lang sein. Wenn dieses Feld festgelegt ist, muss auch das Feld email festgelegt sein.
displayName

string

Der Anzeigename des zu erstellenden Nutzers.
captchaChallenge
(deprecated)

string
captchaResponse

string

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

string
idToken

string

Ein gültiges ID-Token für einen Identity Platform-Nutzer. Wenn diese Option festgelegt ist, werden die Anmeldedaten mit dem Nutzer verknüpft, der durch dieses ID-Token dargestellt wird. Bei einer Anfrage, die nicht von einem Administrator stammt, müssen sowohl das Feld email als auch das Feld password festgelegt sein. Bei einer Administratoranfrage darf localId nicht festgelegt sein.
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.
photoUrl

string

Die URL des Profilbilds des Nutzers, der erstellt werden soll.
disabled

boolean

Gibt an, ob der Nutzer nach der Erstellung deaktiviert wird. Deaktivierte Konten sind nur für Anfragen mit Google OAuth2-Anmeldedaten mit den richtigen Berechtigungen zugänglich.
localId

string

Die ID des Nutzers, der erstellt werden soll. Die ID muss innerhalb des Projekts, in dem der Nutzer erstellt wird, eindeutig sein. Für die Angabe dieses Felds sind Google OAuth 2.0-Anmeldedaten mit den richtigen Berechtigungen erforderlich.
phoneNumber

string

Die Telefonnummer des Nutzers, der erstellt werden soll. Für die Angabe dieses Felds sind Google OAuth 2.0-Anmeldedaten mit den richtigen Berechtigungen erforderlich.
tenantId

string

Die ID des Identity Platform-Mandanten, unter dem ein Nutzer erstellt werden soll. Wenn nicht festgelegt, wird der Nutzer im Standardprojekt von Identity Platform erstellt.
targetProjectId

string

Die Projekt-ID des Projekts, zu dem der Nutzer gehören soll. Für die Angabe dieses Felds sind Google OAuth 2.0-Anmeldedaten mit den richtigen Berechtigungen erforderlich. Wenn dies nicht festgelegt ist, wird das Zielprojekt aus dem Umfang abgeleitet, der dem Bearer-Zugriffstoken zugewiesen ist.
mfaInfo[]

object (MfaFactor)

Die Multi-Faktor-Authentifizierungsanbieter, die der Nutzer erstellen soll.
clientType

enum (ClientType)

Der Clienttyp: Web, Android oder iOS. Erforderlich, wenn der reCAPTCHA Enterprise-Schutz aktiviert wird.
recaptchaVersion

enum (RecaptchaVersion)

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

Antworttext

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

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.