Package google.cloud.identitytoolkit.v1

Index

AccountManagementService

Kontoverwaltung für Identity Toolkit

BatchDeleteAccounts

rpc BatchDeleteAccounts(BatchDeleteAccountsRequest) returns (BatchDeleteAccountsResponse)

Mehrere Konten werden gleichzeitig gelöscht. Bei Konten, die nicht gelöscht werden können, enthält die Antwort Fehlerinformationen. Konten, die nicht vorhanden sind oder in der Anfrage dupliziert sind, werden von der Methode ignoriert.

Für diese Methode sind Google OAuth 2.0-Anmeldedaten mit den entsprechenden Berechtigungen erforderlich.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

DeleteAccount

rpc DeleteAccount(DeleteAccountRequest) returns (DeleteAccountResponse)

Das Konto eines Nutzers wird gelöscht.

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.

DownloadAccount

rpc DownloadAccount(DownloadAccountRequest) returns (DownloadAccountResponse)

Kontoinformationen für alle Konten im Projekt auf seitenweise heruntergeladen werden. Für die Verwendung dieser Methode sind Google OAuth 2.0-Anmeldedaten mit den entsprechenden Berechtigungen erforderlich. Außerdem sind zusätzliche Berechtigungen erforderlich, um Passwort-Hash, Passwort-Salt und Passwortversion aus Konten abzurufen. Andernfalls werden diese Felder entfernt.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

GetAccountInfo

rpc GetAccountInfo(GetAccountInfoRequest) returns (GetAccountInfoResponse)

Ruft Kontoinformationen für alle übereinstimmenden Konten ab. Ruft für eine Endnutzeranfrage das Konto des Endnutzers ab. Ruft bei einer Administratoranfrage mit Google OAuth 2.0-Anmeldedaten ein oder mehrere Konten mit übereinstimmenden Kriterien ab.

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.

GetOobCode

rpc GetOobCode(GetOobCodeRequest) returns (GetOobCodeResponse)

Es wird ein Out-of-Band-Bestätigungscode für ein Konto gesendet. Anfragen von einer authentifizierten Anfrage können optional einen Link mit dem OOB-Code zurückgeben, anstatt ihn zu senden.

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.

QueryUserInfo

rpc QueryUserInfo(QueryUserInfoRequest) returns (QueryUserInfoResponse)

Sucht anhand der Bedingungen in der Anfrage nach Nutzerkonten in einem Projekt oder Mandanten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

ResetPassword

rpc ResetPassword(ResetPasswordRequest) returns (ResetPasswordResponse)

Das Passwort eines Kontos wird entweder mit einem Out-of-Band-Code zurückgesetzt, der mit [sendOobCode][v1.accounts.sendOobCode] generiert wurde, oder durch Angabe der E-Mail-Adresse und des Passworts des zu ändernden Kontos. Sie können auch den Zweck eines Out-of-Band-Codes prüfen, ohne ihn zu verwenden.

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.

SetAccountInfo

rpc SetAccountInfo(SetAccountInfoRequest) returns (SetAccountInfoResponse)

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

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.

UploadAccount

rpc UploadAccount(UploadAccountRequest) returns (UploadAccountResponse)

Hiermit werden mehrere Konten in das Google Cloud-Projekt hochgeladen. Wenn beim Hochladen eines oder mehrerer Konten ein Problem auftritt, werden die übrigen Konten hochgeladen und eine Liste der Fehler zurückgegeben. Für die Verwendung dieser Methode sind Google OAuth 2.0-Anmeldedaten mit den entsprechenden Berechtigungen erforderlich.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

AuthenticationService

Authentifizierung für Identity Toolkit

CreateAuthUri

rpc CreateAuthUri(CreateAuthUriRequest) returns (CreateAuthUriResponse)

Wenn eine E-Mail-ID angegeben ist, wird geprüft, ob ein Nutzerkonto mit der E-Mail-Adresse registriert ist. Wenn ein Konto registriert ist, werden alle Anbieter abgerufen, die mit der E-Mail-Adresse des Kontos verknüpft sind.

Wenn die Anbieter-ID eines Identitätsanbieters (Identity Provider, IdP) angegeben ist, wird ein Autorisierungs-URI für den IdP erstellt. Der Nutzer kann zu diesem URI weitergeleitet werden, um sich beim Identitätsanbieter anzumelden.

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

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.

GetPublicKeys

rpc GetPublicKeys(Empty) returns (Struct)

Ruft öffentliche Schlüssel des Signaturgebers des Legacy Identity Toolkit-Tokens ab, damit Dritte das Legacy-ID-Token verifizieren können. Derzeit wird nur das X509 PEM-Zertifikat unterstützt.

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.

GetRecaptchaParam

rpc GetRecaptchaParam(Empty) returns (GetRecaptchaParamResponse)

Ruft die Parameter ab, die zum Generieren einer reCAPTCHA-Aufgabe erforderlich sind.

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.

IssueSamlResponse

rpc IssueSamlResponse(IssueSamlResponseRequest) returns (IssueSamlResponseResponse)

Experimentell

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.

SendVerificationCode

rpc SendVerificationCode(SendVerificationCodeRequest) returns (SendVerificationCodeResponse)

Es wird ein SMS-Bestätigungscode für die Anmeldung per Telefonnummer gesendet.

Wenn Sie den Text der an den Nutzer gesendeten SMS lokalisieren möchten, setzen Sie den HTTP-Header X-Firebase-Locale auf den Sprachcode, der dem Gebietsschema des Nutzers entspricht.

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

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.

SignInWithCustomToken

rpc SignInWithCustomToken(SignInWithCustomTokenRequest) returns (SignInWithCustomTokenResponse)

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.

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.

SignInWithGameCenter

rpc SignInWithGameCenter(SignInWithGameCenterRequest) returns (SignInWithGameCenterResponse)

Meldet einen Nutzer mit iOS-Game Center-Anmeldedaten an oder registriert ihn. Wenn die Anmeldung erfolgreich ist, werden für den authentifizierten Nutzer ein neues Identity Platform-ID-Token und ein neues Aktualisierungstoken ausgestellt. Die Bundle-ID ist im Anfrageheader als x-ios-bundle-identifier erforderlich.

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

Apple hat das Feld „playerID“ eingestellt. Das Firebase SDK für die Apple-Plattform verwendet ab Version 10.5.0 gamePlayerID und teamPlayerID. Wenn Sie auf die SDK-Version 10.5.0 oder höher upgraden, werden vorhandene Integrationen, in denen playerID verwendet wird, auf gamePlayerID und teamPlayerID umgestellt. Wenn Sie signInWithGameCenter aufrufen, müssen Sie playerID zusammen mit den neuen Feldern gamePlayerID und teamPlayerID angeben, um alle vorhandenen Nutzer zu identifizieren.

Ein Upgrade vorhandener Game Center-Anmeldeintegrationen auf die SDK-Version 10.5.0 oder höher ist nicht rückgängig zu machen.

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.

SignInWithIdp

rpc SignInWithIdp(SignInWithIdpRequest) returns (SignInWithIdpResponse)

Meldet einen Nutzer mit Anmeldedaten eines Identitätsanbieters an oder registriert ihn. Dazu können Sie manuell Anmeldedaten für den Identitätsanbieter angeben oder die Autorisierungsantwort bereitstellen, die über die Autorisierungsanfrage von CreateAuthUri zurückgegeben wurde. Wenn die Anmeldung erfolgreich ist, werden für den authentifizierten Nutzer ein neues Identity Platform-ID-Token und ein neues Aktualisierungstoken ausgestellt.

Ein neues Identity Platform-Nutzerkonto wird erstellt, wenn sich der Nutzer zuvor nicht mit demselben Konto beim Identitätsanbieter angemeldet hat. Wenn die Einstellung „Ein Konto pro E-Mail-Adresse“ aktiviert ist, darf kein Identity Platform-Nutzerkonto mit derselben E-Mail-Adresse vorhanden sein, damit ein neues Nutzerkonto erstellt werden kann.

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

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.

SignInWithPassword

rpc SignInWithPassword(SignInWithPasswordRequest) returns (SignInWithPasswordResponse)

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.

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.

SignInWithPhoneNumber

rpc SignInWithPhoneNumber(SignInWithPhoneNumberRequest) returns (SignInWithPhoneNumberResponse)

Schließt einen Authentifizierungsversuch per Telefonnummer ab. Wenn bereits ein Nutzer mit der angegebenen Telefonnummer vorhanden ist, wird für diesen Nutzer ein ID-Token erstellt. Andernfalls wird ein neuer Nutzer erstellt und mit der Telefonnummer verknüpft. Mit dieser Methode können Sie auch eine Telefonnummer mit einem vorhandenen Nutzer verknüpfen.

Wenn Sie den Text der an den Nutzer gesendeten SMS lokalisieren möchten, setzen Sie den HTTP-Header X-Firebase-Locale auf den Sprachcode, der dem Gebietsschema des Nutzers entspricht.

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

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.

SignUp

rpc SignUp(SignUpRequest) returns (SignUpResponse)

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.

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.

VerifyIosClient

rpc VerifyIosClient(VerifyIosClientRequest) returns (VerifyIosClientResponse)

Prüft, ob ein iOS-Client ein echtes iOS-Gerät ist. Wenn die Anfrage gültig ist, wird in der Antwort eine Bestätigung und ein geheimes Schlüssel über den Apple Push Notification Service gesendet. Der Kunde sollte beide in einem späteren Aufruf an bestimmte Identity Platform APIs zurücksenden (z. B. /accounts:sendVerificationCode), um den Kunden zu bestätigen. Die Bundle-ID ist im Anfrageheader als x-ios-bundle-identifier erforderlich.

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

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.

ProjectConfigService

Projektkonfiguration für Identity Toolkit

GetProjectConfig

rpc GetProjectConfig(GetProjectConfigRequest) returns (GetProjectConfigResponse)

Ruft die öffentliche Identity Toolkit-Konfiguration eines Projekts ab. (Alt) Diese Methode unterstützt auch authentifizierte Aufrufe von Entwicklern zum Abrufen nicht öffentlicher Konfigurationen.

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.

SessionManagementService

Sitzungsverwaltung für Identity Platform

CreateSessionCookie

rpc CreateSessionCookie(CreateSessionCookieRequest) returns (CreateSessionCookieResponse)

Erstellt ein Sitzungscookie für das angegebene Identity Platform-ID-Token. Das Sitzungscookie wird vom Client verwendet, um den Anmeldestatus des Nutzers beizubehalten.

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.

GetSessionCookiePublicKeys

rpc GetSessionCookiePublicKeys(Empty) returns (GetSessionCookiePublicKeysResponse)

Ruft die öffentlichen Schlüssel des JSON Web Token (JWT)-Signers für das Sitzungscookie ab, mit denen das über [createSessionCookie][v1.projects.createSessionCookie] erstellte Sitzungscookie validiert werden kann.

Argon2Parameters

Die Parameter für den Argon2-Hash-Algorithmus.

Felder
hash_length_bytes

int32

Pflichtangabe. Die gewünschte Hash-Länge in Byte. Der Mindestwert ist 4 und der Höchstwert 1.024.

hash_type

HashType

Pflichtangabe. Darf nicht HASH_TYPE_UNSPECIFIED sein.

parallelism

int32

Pflichtangabe. Der Grad der Parallelität, auch als Threads oder Lanes bezeichnet. Der Mindestwert ist 1, der Höchstwert 16.

iterations

int32

Pflichtangabe. Die Anzahl der durchzuführenden Iterationen. Der Mindestwert ist 1, der Höchstwert 16.

memory_cost_kib

int32

Pflichtangabe. Die Speicherkosten in Kibibyte. Der Maximalwert ist 32.768.

version

Version

Die Version des Argon2-Algorithmus. Wenn keine Angabe erfolgt, wird standardmäßig VERSION_13 verwendet.

associated_data

bytes

Die zusätzlichen zugehörigen Daten, sofern vorhanden, werden an den Hashwert angehängt, um eine zusätzliche Sicherheitsebene zu schaffen. Ein base64-codierter String, wenn über JSON angegeben.

HashType

Die Typen des Algorithmus.

Enums
HASH_TYPE_UNSPECIFIED Der Hash-Typ ist nicht angegeben.
ARGON2_D Eine Argon2-Variante, Argon2d.
ARGON2_ID Eine Argon2-Variante, Argonid. Recommended.
ARGON2_I Eine Argon2-Variante, Argon2i.

Version

Die Version des Algorithmus.

Enums
VERSION_UNSPECIFIED Die Version ist nicht angegeben.
VERSION_10 Die vorherige Version, 0x10.
VERSION_13 Die aktuelle Version, 0x13. Der Standardwert für „version“.

BatchDeleteAccountsRequest

Anfragenachricht für BatchDeleteAccounts

Felder
target_project_id

string

Wenn tenant_id angegeben ist, die ID des Google Cloud-Projekts, zu dem der Identity Platform-Tenant gehört. Andernfalls die ID des Google Cloud-Projekts, zu dem die Konten gehören.

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

  • firebaseauth.users.delete
local_ids[]

string

Pflichtangabe. Liste der zu löschenden Nutzer-IDs.

force

bool

Ob Konten, die nicht deaktiviert sind, erzwungen gelöscht werden sollen. Wenn „false“ (falsch) festgelegt ist, werden nur deaktivierte Konten gelöscht und nicht deaktivierte Konten werden der errors hinzugefügt.

tenant_id

string

Wenn die Konten zu einem Identity Platform-Mandanten gehören, die ID des Mandanten. Wenn die Konten zu einem Standard-Identity Platform-Projekt gehören, ist das Feld nicht erforderlich.

BatchDeleteAccountsResponse

Antwortnachricht für BatchDeleteAccounts.

Felder
errors[]

BatchDeleteErrorInfo

Detaillierte Fehlerinformationen für Konten, die nicht gelöscht werden können.

BatchDeleteErrorInfo

Fehlerinformationen für Konto konnten nicht gelöscht werden.

Felder
index

int32

Der Index des fehlerhaften Artikels im ursprünglichen Feld „local_ids“.

local_id

string

Die entsprechende Nutzer-ID.

error_message

string

Detaillierte Fehlermeldung.

ClientType

Der Plattformtyp des Clients: „web“, „android“ oder „ios“.

Enums
CLIENT_TYPE_UNSPECIFIED Clienttyp nicht angegeben
CLIENT_TYPE_WEB Der Clienttyp ist „Web“.
CLIENT_TYPE_ANDROID Der Clienttyp ist Android.
CLIENT_TYPE_IOS Der Clienttyp ist „ios“.

CreateAuthUriRequest

Anfragenachricht für CreateAuthUri.

Felder
identifier

string

Die E-Mail-ID des Nutzerkontos, für das verknüpfte Anbieter abgerufen werden sollen. Mindestens eines der Felder identifier und provider_id muss festgelegt sein.

Die E-Mail-Adresse darf maximal 256 Zeichen lang sein und muss das Format name@domain.tld haben. Die E-Mail-Adresse muss außerdem der addr-spec-Produktion von RFC 822 entsprechen.

continue_uri

string

Eine gültige URL, an die der IdP den Nutzer zurückleiten soll. Die URL darf keine Fragmente oder den reservierten Abfrageparameter state enthalten.

openid_realm
(deprecated)

string

provider_id

string

Die Anbieter-ID des Identitätsanbieters, mit dem sich der Nutzer anmelden soll. Dies sollte eine für die Anmeldung aktivierte Anbieter-ID sein, die entweder aus der Liste der standardmäßig unterstützten Identitätsanbieter stammt oder das Format oidc.* oder saml.* hat. Beispiele hierfür sind google.com, facebook.com, oidc.testapp und saml.testapp. Mindestens eines der Felder identifier und provider_id muss festgelegt sein.

oauth_consumer_key
(deprecated)

string

oauth_scope

string

Zusätzliche, durch Leerzeichen getrennte OAuth 2.0-Bereiche, die den Umfang der Authentifizierungsanfrage beim Identitätsanbieter angeben. Wird für OAuth 2.0-IdPs verwendet.

Wenn dieses Feld festgelegt ist, wird für den Google-Anbieter der Autorisierungscode-Vorgang verwendet.

context

string

Ein opaker String, der verwendet wird, um Kontextinformationen zwischen der Authentifizierungsanfrage und dem Rückruf vom IdP aufrechtzuerhalten.

ota_app
(deprecated)

string

app_id
(deprecated)

string

hosted_domain

string

Wird für den Google-Anbieter verwendet. Die vom Nutzer gehostete G Suite-Domain, um die Anmeldung auf Nutzer in dieser Domain zu beschränken.

session_id

string

Eine Sitzungs-ID, die in SignInWithIdp überprüft werden kann, um Angriffe über Sitzungsfixierung zu verhindern. Andernfalls wird ein zufälliger String generiert und als Sitzungs-ID zurückgegeben.

auth_flow_type

string

Wird für den Google-Anbieter verwendet. Der zu verwendende Authentifizierungsablauf. Falls vorhanden, sollte dies CODE_FLOW sein, um den Autorisierungscodeablauf anzugeben. Andernfalls wird der Standard-ID-Token-Ablauf verwendet.

custom_parameter

map<string, string>

Zusätzliche benutzerdefinierte Suchparameter, die dem Autorisierungs-URI hinzugefügt werden sollen. Die folgenden Parameter sind reserviert und können nicht hinzugefügt werden: client_id, response_type, scope, redirect_uri, state.

Für den Microsoft-Anbieter kann der Azure AD-Mandant, bei dem Sie sich anmelden möchten, im benutzerdefinierten Parameter tenant angegeben werden.

tenant_id

string

Die ID des Identity Platform-Mandanten, für den ein Autorisierungs-URI erstellt oder eine E-Mail-ID abgerufen werden soll. Wenn nicht festgelegt, wird der Vorgang in der Standard-Identity Platform-Instanz im Projekt ausgeführt.

CreateAuthUriResponse

Antwortnachricht für CreateAuthUri

Felder
kind
(deprecated)

string

auth_uri

string

Der Autorisierungs-URI für den angeforderten Anbieter. Nur vorhanden, wenn in der Anfrage eine Anbieter-ID festgelegt ist.

all_providers[]
(deprecated)

string

registered

bool

Gibt an, ob die E-Mail-ID einem vorhandenen Konto zugewiesen ist. Nur vorhanden, wenn in der Anfrage eine E-Mail-ID festgelegt ist.

provider_id

string

Die Anbieter-ID aus der Anfrage, sofern angegeben.

for_existing_provider

bool

Gibt an, ob sich der Nutzer zuvor mit der Anbieter-ID in der Anfrage angemeldet hat. Nur vorhanden, wenn in der Anfrage eine registrierte E-Mail-ID festgelegt ist.

captcha_required

bool

Ob ein CAPTCHA erforderlich ist, weil es zu viele fehlgeschlagene Anmeldeversuche des Nutzers gab. Nur vorhanden, wenn in der Anfrage eine registrierte E-Mail-ID festgelegt ist.

session_id

string

Die Sitzungs-ID aus der Anfrage oder ein zufälliger String, der von CreateAuthUri generiert wird, falls nicht vorhanden. Sie wird verwendet, um Sitzungsfixierungsangriffe zu verhindern.

signin_methods[]

string

Die Liste der Anmeldemethoden, die der Nutzer zuvor verwendet hat. Jedes Element ist password, emailLink oder die Anbieter-ID eines IdP. Nur vorhanden, wenn in der Anfrage eine registrierte E-Mail-ID festgelegt ist. Wenn der Schutz vor E-Mail-Aufzählungen aktiviert ist, gibt diese Methode eine leere Liste zurück.

CreateSessionCookieRequest

Anfragenachricht für CreateSessionCookie.

Felder
id_token

string

Pflichtangabe. Ein gültiges Identity Platform-ID-Token.

valid_duration

int64

Die Anzahl der Sekunden, bis das Sitzungs-Cookie abläuft. Geben Sie eine Dauer in Sekunden an, die zwischen fünf Minuten und vierzehn Tagen liegen muss.

target_project_id

string

Die ID des Projekts, zu dem das Konto gehört.

tenant_id

string

Die Mandanten-ID des Identity Platform-Mandaten, zu dem das Konto gehört.

CreateSessionCookieResponse

Antwortnachricht für CreateSessionCookie.

Felder

DeleteAccountRequest

Anfragenachricht für DeleteAccount.

Felder
local_id

string

Die ID des zu löschenden Nutzerkontos. Für die Angabe dieses Felds sind Google OAuth 2.0-Anmeldedaten mit den richtigen Berechtigungen erforderlich. Anfragen von Nutzern, die keine Anmeldedaten haben, sollten stattdessen ein ID-Token übergeben.

delegated_project_number
(deprecated)

int64

id_token

string

Das Identity Platform-ID-Token des zu löschenden Kontos. Muss für Anfragen von Endnutzern angegeben werden, die keine Google OAuth 2.0-Anmeldedaten haben. Bei authentifizierten Anfragen mit Google OAuth2-Anmeldedaten mit den richtigen Berechtigungen kann „local_id“ übergeben werden, um das zu löschende Konto anzugeben.

tenant_id

string

Die ID des Mandanten, dem das Konto zugewiesen ist, sofern zutreffend. Muss nur für authentifizierte Anfragen mit Google OAuth 2.0-Anmeldedaten angegeben werden, die die local_id eines Kontos angeben, das zu einem Identity Platform-Tenant gehört.

target_project_id

string

Die ID des Projekts, zu dem das Konto gehört. Sollte nur in authentifizierten Anfragen angegeben werden, in denen die „local_id“ eines Kontos angegeben ist.

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

  • firebaseauth.users.delete

DeleteAccountResponse

Antwortnachricht für DeleteAccount

Felder
kind
(deprecated)

string

DownloadAccountRequest

Anfragenachricht für DownloadAccount

Felder
delegated_project_number
(deprecated)

int64

next_page_token

string

Das Paginierungstoken aus der Antwort einer vorherigen Anfrage.

max_results

int32

Die maximale Anzahl von zurückzugebenden Ergebnissen. Er muss mindestens 1 und höchstens 1.000 sein. Der Standardwert ist 20.

target_project_id

string

Wenn tenant_id angegeben ist, die ID des Google Cloud-Projekts, zu dem der Identity Platform-Tenant gehört. Andernfalls die ID des Google Cloud-Projekts, zu dem die Konten gehören.

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

  • firebaseauth.users.get
tenant_id

string

Die ID des Identity Platform-Mandans, zu dem die Konten gehören. Wenn keine Angabe erfolgt, werden Konten im Identity Platform-Projekt zurückgegeben.

DownloadAccountResponse

Antwortnachricht für DownloadAccount.

Felder
kind
(deprecated)

string

users[]

UserInfo

Alle Konten, die zum Projekt/Tenant gehören, begrenzt durch „max_results“ in der Anfrage.

next_page_token

string

Wenn noch weitere Konten heruntergeladen werden sollen, ein Token, das an „DownloadAccount“ zurückgegeben werden kann, um weitere Konten abzurufen. Andernfalls ist das Feld leer.

EmailInfo

Informationen zur MFA für E-Mails

Felder
email_address

string

E-Mail-Adresse, an die eine Bestätigung für die Multi-Faktor-Authentifizierung gesendet werden soll.

EmailTemplate

E-Mail-Vorlage

Felder
disabled

bool

Gibt an, ob die Vorlage deaktiviert ist. Wenn „wahr“ festgelegt ist, wird eine Standardvorlage verwendet.

from

string

Absenderadresse der E-Mail

body

string

E-Mail-Text

subject

string

Betreff der E-Mail

from_display_name

string

Über den Anzeigenamen

format

EmailBodyFormat

Format des E-Mail-Texts

reply_to

string

Antwortadresse

from_local_part

string

Lokaler Teil der Absenderadresse

locale

string

Der Wert ist im Format eines Sprachcodes der III. Welt (z. B. „de-DE“ oder „es“). Sowohl Bindestrich als auch Unterstrich sind zulässig.

customized

bool

Ob der Text oder Betreff der E-Mail angepasst ist.

EmailBodyFormat

Format des E-Mail-Texts

Enums
EMAIL_BODY_FORMAT_UNSPECIFIED Standardwert. Nicht verwenden.
PLAINTEXT Der E-Mail-Text ist im Nur-Text-Format.
HTML Der E-Mail-Text ist im HTML-Format.

Fehlerinformation

Fehlerinformationen, die erklären, warum ein Konto nicht hochgeladen werden kann.

Felder
index

int32

Der Index des Artikels, Bereich [0, request.size – 1]

error_message

string

Detaillierte Fehlermeldung

GetAccountInfoRequest

Anfragenachricht für GetAccountInfo.

Felder
id_token

string

Das Identity Platform-ID-Token des abzurufenden Kontos. Muss für Anfragen von Endnutzern angegeben werden.

local_id[]

string

Die ID eines oder mehrerer Konten, die abgerufen werden sollen. Sollte nur von authentifizierten Anfragen mit Google OAuth 2.0-Anmeldedaten mit den richtigen Berechtigungen angegeben werden.

email[]

string

Die E-Mail-Adresse eines oder mehrerer Konten, die abgerufen werden sollen. 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. Sollte nur in authentifizierten Anfragen von einem Entwickler angegeben werden.

delegated_project_number
(deprecated)

int64

phone_number[]

string

Die Telefonnummer eines oder mehrerer Konten, die abgerufen werden sollen. Sollte nur in authentifizierten Anfragen von einem Entwickler angegeben werden und muss im E.164-Format sein, z. B. +15555555555.

federated_user_id[]

FederatedUserIdentifier

tenant_id

string

Die ID des Mandanten, zu dem das Konto gehört. Sollte nur in authentifizierten Anfragen von einem Entwickler angegeben werden.

target_project_id

string

Die ID des Google Cloud-Projekts, zu dem das Konto oder der mit tenant_id angegebene Identity Platform-Mandant gehört. Sollte nur von authentifizierten Anfragen mit Google OAuth 2.0-Anmeldedaten mit den richtigen Berechtigungen angegeben werden.

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

  • firebaseauth.users.get
initial_email[]

string

Die erste E-Mail-Adresse eines oder mehrerer abzurufender Konten. 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. Sollte nur in authentifizierten Anfragen von einem Entwickler angegeben werden.

FederatedUserIdentifier

Föderierte Nutzer-ID bei einem Identitätsanbieter.

Felder
provider_id

string

Die ID der unterstützten Identitätsanbieter. Dies sollte eine für die Anmeldung aktivierte Anbieter-ID sein, die entweder aus der Liste der standardmäßig unterstützten Identitätsanbieter stammt oder das Format oidc.* oder saml.* hat. Beispiele hierfür sind google.com, facebook.com, oidc.testapp und saml.testapp.

raw_id

string

Die Nutzer-ID des Kontos beim Identitätsanbieter von Drittanbietern, der in provider_id angegeben ist.

GetAccountInfoResponse

Antwortnachricht für GetAccountInfo

Felder
kind
(deprecated)

string

users[]

UserInfo

Die Informationen zu bestimmten Nutzerkonten, die den Parametern in der Anfrage entsprechen.

GetOobCodeRequest

Anfragenachricht für GetOobCode

Felder
req_type

OobReqType

Pflichtangabe. Der Typ des Out-of-Band-Codes (OOB), der gesendet werden soll. Je nach diesem Wert sind andere Felder in dieser Anfrage erforderlich und/oder haben eine andere Bedeutung. Es gibt vier verschiedene OOB-Codes, die gesendet werden können: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL

email

string

Die E-Mail-Adresse des Kontos, an die der Bestätigungscode gesendet werden soll, und in der Regel die E-Mail-Adresse des Kontos, das aktualisiert werden muss. Erforderlich für PASSWORD_RESET, EMAIL_SIGNIN und VERIFY_EMAIL. Nur für VERIFY_AND_CHANGE_EMAIL-Anfragen erforderlich, wenn „return_oob_link“ auf „true“ gesetzt ist. In diesem Fall ist es die ursprüngliche E-Mail-Adresse des Nutzers.

challenge
(deprecated)

string

captcha_resp

string

Für eine PASSWORD_RESET-Anfrage ist eine reCAPTCHA-Antwort erforderlich, wenn das System mögliche Missbrauchsaktivitäten erkennt. In diesen Fällen ist dies die Antwort auf die reCAPTCHA-Abfrage, die zur Bestätigung des Aufrufers verwendet wird.

user_ip

string

Die IP-Adresse des Aufrufers. Nur für PASSWORD_RESET-Anfragen erforderlich.

new_email

string

Die E-Mail-Adresse, auf die das Konto aktualisiert wird. Nur für VERIFY_AND_CHANGE_EMAIL-Anfragen erforderlich.

id_token

string

Ein ID-Token für das Konto. Er ist für VERIFY_AND_CHANGE_EMAIL- und VERIFY_EMAIL-Anfragen erforderlich, es sei denn, return_oob_link ist auf „true“ festgelegt.

continue_url

string

Die URL, unter der fortgefahren wird, nachdem der Nutzer auf den in der E-Mail gesendeten Link geklickt hat. Über diese URL kann das Web-Widget den OOB-Code verarbeiten.

ios_bundle_id

string

Wenn eine zugehörige iOS-App den OOB-Code verarbeiten kann, die iOS-Bundle-ID dieser App. Dadurch kann die richtige App geöffnet werden, wenn sie bereits installiert ist.

ios_app_store_id

string

Wenn eine verknüpfte iOS-App den OOB-Code verarbeiten kann, die App Store-ID dieser App. Dadurch wird der App Store mit der richtigen App geöffnet, wenn die App noch nicht installiert ist.

android_package_name

string

Wenn eine verknüpfte Android-App den OOB-Code verarbeiten kann, der Name des Android-Pakets der Android-App, die den Rückruf verarbeitet, wenn dieser OOB-Code verwendet wird. Dadurch wird die richtige App geöffnet, wenn sie bereits installiert ist, oder der Google Play Store wird mit der richtigen App geöffnet, wenn sie noch nicht installiert ist.

android_install_app

bool

Wenn eine verknüpfte Android-App den OOB-Code verarbeiten kann, wird festgelegt, ob die Android-App auf dem Gerät installiert werden soll, auf dem der Link geöffnet wird, falls die App noch nicht installiert ist.

android_minimum_version_code

string

Wenn eine verknüpfte Android-App den OOB-Code verarbeiten kann, die Mindestversion der App. Wenn die Version auf dem Gerät niedriger ist als diese Version, wird der Nutzer zum Google Play Store weitergeleitet, um die App zu aktualisieren.

can_handle_code_in_app

bool

Wenn diese Option auf „true“ festgelegt ist, wird der Link zum OOB-Code als universeller Link oder als Android-App-Link gesendet und von der entsprechenden App geöffnet, sofern sie installiert ist. Wenn die Option nicht festgelegt oder auf „false“ gesetzt ist, wird der OOB-Code zuerst an das Web-Widget gesendet und dann bei „Continue“ (Weiter) zur App weitergeleitet, sofern diese installiert ist.

tenant_id

string

Die Mandanten-ID des Identity Platform-Mandaten, zu dem das Konto gehört.

target_project_id

string

Die Projekt-ID des Identity Platform-Projekts, zu dem das Konto gehört. Für die Angabe dieses Felds sind Google OAuth 2.0-Anmeldedaten mit den entsprechenden Berechtigungen erforderlich.

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

  • firebaseauth.users.sendEmail
client_type

ClientType

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

recaptcha_version

RecaptchaVersion

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

GetOobCodeResponse

Antwortnachricht für GetOobCode

Felder
kind
(deprecated)

string

oob_code

string

Wenn „return_oob_link“ in der Anfrage „true“ ist, ist dies der zu sendende OOB-Code.

email

string

Wenn „return_oob_link“ in der Anfrage als „false“ festgelegt ist, die E-Mail-Adresse, an die die Bestätigung gesendet wurde.

GetProjectConfigRequest

Anfragenachricht für GetProjectConfig.

Felder
delegated_project_number

int64

Projektnummer der delegierten Projektanfrage. Dieses Feld sollte nur im Rahmen der Firebase V1-Migration verwendet werden.

project_number

int64

Projektnummer der abzurufenden Konfiguration. Dieses Feld wurde eingestellt und sollte bei neuen Integrationen nicht verwendet werden.

android_package_name

string

Android-Paketname, der mit dem tatsächlichen Android-Paketnamen verglichen werden soll. Wenn dieses Feld angegeben ist und sha1_cert_hash nicht angegeben ist, wird bei der Aktion ein Fehler ausgegeben, wenn der Wert nicht mit dem tatsächlichen Namen des Android-Pakets übereinstimmt.

ios_bundle_id

string

iOS-Bundle-ID, die mit der tatsächlichen iOS-Bundle-ID abgeglichen werden soll. Wenn dieses Feld angegeben ist, wird bei der Aktion ein Fehler ausgegeben, wenn die angegebene ID nicht mit der tatsächlichen iOS-Bundle-ID übereinstimmt.

client_id

string

Die OAuth-Client-ID des RP. Wenn diese Option festgelegt ist, wird geprüft, ob der OAuth-Client für das abgerufene Projekt gültig ist. Andernfalls wird die Anfrage mit einem Clientfehler abgelehnt.

sha1_cert

string

SHA-1-Hash des Android-Anwendungszertifikats. Wenn diese Option festgelegt ist, wird geprüft, ob der Zertifikat-Hash für das abgerufene Projekt und den android_package_name gültig ist.

firebase_app_id

string

Die Firebase App-ID für Anwendungen, die Firebase verwenden. Sie finden sie in der Firebase Console für Ihr Projekt. Wenn diese Option festgelegt ist, wird geprüft, ob die App-ID für das abgerufene Projekt gültig ist. Ist der Schlüssel ungültig, wird die Anfrage mit einem Clientfehler abgelehnt.

GetProjectConfigResponse

Antwortnachricht für GetProjectConfig.

Felder
project_id

string

Die Projekt-ID der abgerufenen Konfiguration.

api_key

string

Google Cloud API-Schlüssel. Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.

allow_password_user

bool

Ob die Registrierung von Passwörtern für Konten zulässig ist. Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.

idp_config[]

IdpConfig

OAuth2-Anbieterkonfiguration Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.

authorized_domains[]

string

Autorisierte Domains für die Weiterleitung des Widgets.

enable_anonymous_user

bool

Gibt an, ob der anonyme Nutzer aktiviert ist. Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.

use_email_sending

bool

Ob E-Mails gesendet werden sollen. Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.

reset_password_template

EmailTemplate

E-Mail-Vorlage zum Zurücksetzen des Passworts Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.

verify_email_template

EmailTemplate

E-Mail-Vorlage für die Bestätigung der E-Mail-Adresse. Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.

change_email_template

EmailTemplate

E-Mail-Vorlage für die Änderung der E-Mail-Adresse. Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.

legacy_reset_password_template

EmailTemplate

Vorlage für E-Mails zum Zurücksetzen des Passworts für die alte Firebase V1-App. Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.

revert_second_factor_addition_template

EmailTemplate

E-Mail-Vorlage zum Rückgängigmachen der Hinzufügung eines zweiten Faktors Dieses Feld wird nur für authentifizierte Aufrufe von einem Entwickler zurückgegeben.

GetRecaptchaParamResponse

Antwortnachricht für GetRecaptchaParam.

Felder
kind
(deprecated)

string

recaptcha_stoken
(deprecated)

string

recaptcha_site_key

string

Der reCAPTCHA v2-Websiteschlüssel, mit dem der reCAPTCHA-Dienst aufgerufen wird. Immer vorhanden.

producer_project_number

string

Die Projektnummer des Produzenten, die zum Generieren von PIA-Tokens verwendet wird

GetSessionCookiePublicKeysResponse

Antwortnachricht für GetSessionCookiePublicKeys.

Felder
keys[]

OpenIdConnectKey

Öffentliche Schlüssel der Signatur für Sitzungs-Cookies, formatiert als JSON-Webschlüssel (JWK).

IdpConfig

Konfiguration eines Identitätsanbieters.

Felder
provider

Provider

enabled

bool

„Wahr“, wenn der Nutzer sich beim Anbieter anmelden kann.

experiment_percent

int32

Prozentsatz der Nutzer, die für diesen IdP zur föderierten Anmeldung aufgefordert oder weitergeleitet werden

key

string

OAuth2-Client-ID.

secret

string

OAuth2-Clientschlüssel

whitelisted_audiences[]

string

Client-IDs auf der Zulassungsliste für die Zielgruppenprüfung.

Anbieter

Name des Identitätsanbieters.

Enums
PROVIDER_UNSPECIFIED
MSLIVE Microsoft Live als Identitätsanbieter
GOOGLE Google als Identitätsanbieter
FACEBOOK Facebook als Identitätsanbieter
PAYPAL PayPal als Identitätsanbieter
TWITTER Twitter als Identitätsanbieter
YAHOO Yahoo als Identitätsanbieter
AOL AOL als Identitätsanbieter
GITHUB GitHub als Identitätsanbieter
GOOGLE_PLAY_GAMES Google Play Spiele als Identitätsanbieter
LINKEDIN LinkedIn als Identitätsanbieter
IOS_GAME_CENTER iOS Game Center als Identitätsanbieter

IssueSamlResponseRequest

Anfragenachricht für IssueSamlResponse.

Felder
rp_id

string

Die ID der vertrauenden Seite, die die Zielgruppe der ausgestellten SAMLResponse ist.

id_token

string

Das Identity Platform-ID-Token. Sie wird überprüft und dann in eine neue SAMLResponse umgewandelt.

saml_app_entity_id

string

SAML-App-Entitäts-ID, die in der Admin-Konsole für jede App angegeben ist. Wenn Entwickler Nutzer lieber zu einer Drittanbieter-App als zu einer G Suite-App weiterleiten möchten, ist diese Angabe erforderlich. Wenn es verwendet wird, geben wir ein RelayState zurück. Dazu gehört eine SAMLRequest, mit der ein vom SP initiierter SAML-Ablauf ausgelöst werden kann, um zur echten App weiterzuleiten.

IssueSamlResponseResponse

Antwort auf die IssueSamlResponse-Anfrage.

Felder
saml_response

string

Signierte SAMLResponse, die für die vertrauende Seite erstellt wurde.

acs_endpoint

string

Der ACS-Endpunkt, der die zurückgegebene SAMLResponse verwendet.

relay_state

string

Generiertes RelayState.

email

string

E-Mail-Adresse des Nutzers

first_name

string

Vorname des Nutzers.

last_name

string

Nachname des Nutzers

is_new_user

bool

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

MfaEnrollment

Informationen dazu, welche Anbieter für die Multi-Faktor-Authentifizierung (MFA) für ein Konto aktiviert sind.

Felder
mfa_enrollment_id

string

ID dieser MFA-Option.

display_name

string

Anzeigename für diese MFA-Option, z.B. „Firmenhandy“.

enrolled_at

Timestamp

Zeitstempel für die Registrierung dieses zweiten Faktors im Konto.

Union-Feld mfa_value. Der definierende Wert der MFA-Option. Für mfa_value ist nur einer der folgenden Werte zulässig:
phone_info

string

Normalerweise wird hier die mit dieser Registrierung verknüpfte Telefonnummer angezeigt. In einigen Fällen, z. B. nach einer Anmeldung mit dem ersten Faktor, wird nur die verschleierte Version der zugehörigen Telefonnummer angezeigt.

totp_info

TotpInfo

Enthält spezifische Informationen zur TOTP-Mehrfachauthentifizierung.

email_info

EmailInfo

Enthält spezifische Informationen zur Bestätigung in zwei Schritten per E-Mail.

Union-Feld unobfuscated_mfa_value.

Für unobfuscated_mfa_value ist nur einer der folgenden Werte zulässig:

unobfuscated_phone_info

string

Nur Ausgabe. Nicht verschleierte phone_info.

OobReqType

Der angeforderte Aktionstyp für einen OOB-Code.

Enums
OOB_REQ_TYPE_UNSPECIFIED Der Typ des Bestätigungscodes ist nicht angegeben.
PASSWORD_RESET Passwort zurücksetzen
OLD_EMAIL_AGREE
NEW_EMAIL_ACCEPT
VERIFY_EMAIL E-Mail-Adresse des Kontos per E-Mail bestätigen
RECOVER_EMAIL
EMAIL_SIGNIN Nur mit E-Mail-Adresse anmelden
VERIFY_AND_CHANGE_EMAIL Bei diesem Ablauf wird eine E-Mail an die angegebene neue E-Mail-Adresse gesendet. Wenn Sie auf den Link in der E-Mail klicken, wird die E-Mail-Adresse des Kontos in die neue E-Mail-Adresse geändert. Wird verwendet, wenn für das Konto immer eine bestätigte E-Mail-Adresse erforderlich ist, z. B. für MFA-Konten.
REVERT_SECOND_FACTOR_ADDITION

OpenIdConnectKey

Stellt einen öffentlichen Schlüssel des Signaturschlüssels für Sitzungscookies dar, der als JSON Web Key (JWK) formatiert ist.

Felder
type

string

Schlüsseltyp.

algorithm

string

Signaturalgorithmus.

use

string

Hauptnutzung

id

string

Eindeutiger String zur Identifizierung dieses Schlüssels.

modulus

string

Modulus für den öffentlichen RSA-Schlüssel, dargestellt als base64url-Codierung der Big-Endian-Darstellung des Werts.

exponent

string

Exponent für den öffentlichen RSA-Schlüssel. Er wird als Base64Url-Codierung der Big-Endian-Darstellung des Werts dargestellt.

ProviderUserInfo

Informationen zum Nutzer, die von verschiedenen Identitätsanbietern bereitgestellt werden.

Felder
provider_id

string

Die ID des Identitätsanbieters.

display_name

string

Der Anzeigename des Nutzers beim Identitätsanbieter.

photo_url

string

Die URL des Profilbilds des Nutzers beim Identitätsanbieter.

federated_id

string

Die Kennung des Nutzers beim Identitätsanbieter.

email

string

Die E-Mail-Adresse des Nutzers beim Identitätsanbieter.

raw_id

string

Die Roh-ID des Nutzers, die direkt vom Identitätsanbieter zurückgegeben wird.

screen_name

string

Der screen_name des Nutzers bei Twitter oder der Anmeldename bei GitHub.

phone_number

string

Die Telefonnummer des Nutzers beim Identitätsanbieter.

QueryUserInfoRequest

Anfragenachricht für QueryUserInfo

Felder
return_user_info

bool

Wenn true, werden mit dieser Anfrage die Konten zurückgegeben, die der Abfrage entsprechen. Bei false wird nur die Anzahl der Konten zurückgegeben, die mit der Abfrage übereinstimmen. Die Standardeinstellung ist true.

limit

int64

Die maximale Anzahl der Konten, die zurückgegeben werden sollen. Die Obergrenze beträgt 500. Der Standardwert ist 500. Nur gültig, wenn für return_user_info der Wert true festgelegt wurde.

offset

int64

Die Anzahl der Konten, die am Anfang der übereinstimmenden Einträge übersprungen werden sollen. Nur gültig, wenn für return_user_info der Wert true festgelegt wurde.

sort_by

SortByField

order

Order

target_project_id

string

Die ID des Projekts, auf das sich das Ergebnis bezieht.

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

  • firebaseauth.users.get
tenant_id

string

Die ID des Mandanten, auf den das Ergebnis beschränkt ist.

expression[]

SqlExpression

Auftrag

Eine Reihenfolge für das Sortieren von Abfrageergebnissen.

Enums
ORDER_UNSPECIFIED Reihenfolge nicht angegeben.
ASC Sortieren Sie die Spalte in aufsteigender Reihenfolge.
DESC Sortieren Sie in absteigender Reihenfolge.

SortByField

Ein Feld zum Sortieren von Nutzerkonten.

Enums
SORT_BY_FIELD_UNSPECIFIED Sortierfeld nicht angegeben
USER_ID Ergebnis nach userId sortieren.
NAME Ergebnisse nach Name sortieren.
CREATED_AT Ergebnis nach „createdAt“ sortieren
LAST_LOGIN_AT Ergebnis nach „lastLoginAt“ sortieren
USER_EMAIL Ergebnis nach „userEmail“ sortieren.

SqlExpression

Abfragebedingungen, mit denen Ergebnisse gefiltert werden.

Felder
email

string

Ein String, bei dem die Groß- und Kleinschreibung nicht berücksichtigt wird und der mit der E-Mail-Adresse des Kontos übereinstimmen muss. In einer SqlExpression sollte nur eine der folgenden Optionen angegeben werden: email, phone_number oder user_id. Wenn mehrere angegeben werden, wird nur der erste (in dieser Reihenfolge) angewendet.

user_id

string

Ein String, mit dem die lokale ID des Kontos übereinstimmen muss. In einem SQL-Ausdruck sollte nur einer der folgenden Werte angegeben werden: email, phone_number oder user_id. Wenn mehrere angegeben werden, wird nur der erste (in dieser Reihenfolge) angewendet.

phone_number

string

Ein String, mit dem die Telefonnummer des Kontos übereinstimmen muss. In einer SqlExpression sollte nur eine der folgenden Optionen angegeben werden: email, phone_number oder user_id. Wenn mehrere angegeben werden, wird nur der erste (in dieser Reihenfolge) angewendet.

QueryUserInfoResponse

Antwortnachricht für QueryUserInfo.

Felder
records_count

int64

Wenn return_user_info in der Anfrage „wahr“ ist, entspricht diese Zahl der Anzahl der zurückgegebenen Konten in dieser Nachricht. Andernfalls ist dies die Gesamtzahl der Konten, die der Abfrage entsprechen.

user_info[]

UserInfo

Wenn return_user_info in der Anfrage „wahr“ ist, sind dies die Konten, die der Suchanfrage entsprechen.

RecaptchaVersion

Die reCAPTCHA-Version.

Enums
RECAPTCHA_VERSION_UNSPECIFIED Die reCAPTCHA-Version ist nicht angegeben.
RECAPTCHA_ENTERPRISE reCAPTCHA Enterprise

ResetPasswordRequest

Anfragenachricht für ResetPassword.

Felder
oob_code

string

Ein Out-of-Band-Code (OOB), der durch die GetOobCode-Anfrage generiert wird. Geben Sie nur diesen Parameter (oder nur diesen Parameter und eine Tenant-ID) an, um den Typ des Out-of-Band-Codes in der Antwort abzurufen, ohne den Status des Kontos zu ändern. Über diese Methode kann nur ein Out-of-Band-Code vom Typ PASSWORD_RESET verwendet werden.

new_password

string

Das neue Passwort, das für dieses Konto festgelegt werden soll. Wenn Sie dieses Feld angeben, wird das Konto geändert und der Out-of-Band-Code wird verwendet, falls einer vom Typ PASSWORD_RESET angegeben wurde.

old_password

string

Das aktuelle Passwort des zu ändernden Kontos. Geben Sie diese und die E-Mail-Adresse an, um das Passwort eines Kontos ohne Out-of-Band-Code zu ändern.

email

string

Optional. Die E-Mail-Adresse des Kontos, das geändert werden soll. Geben Sie diese und das alte Passwort an, um das Passwort eines Kontos ohne Out-of-Band-Code zu ändern.

tenant_id

string

Optional. Die Mandanten-ID des Identity Platform-Mandaten, zu dem das Konto gehört.

ResetPasswordResponse

Antwortnachricht für ResetPassword

Felder
kind
(deprecated)

string

email

string

Die E-Mail-Adresse, die mit dem verwendeten externen Code verknüpft ist.

new_email

string

req_type

OobReqType

mfa_info

MfaEnrollment

SendVerificationCodeRequest

Anfragenachricht für SendVerificationCode. „captcha_response“ ist erforderlich, wenn reCAPTCHA Enterprise aktiviert ist. Andernfalls muss mindestens eine der folgenden Optionen angegeben werden: (ios_receipt und ios_secret), recaptcha_token oder safety_net_token, um zu bestätigen, dass der Bestätigungscode im Namen einer echten App und nicht eines Emulators gesendet wird.

Felder
phone_number

string

Die Telefonnummer, an die der Bestätigungscode gesendet werden soll, im E.164-Format.

ios_receipt

string

Erfolgreiche Validierung des iOS-App-Tokens Wenn „captcha_response“ nicht verwendet wird (reCAPTCHA Enterprise ist nicht aktiviert), muss mindestens eine der folgenden Optionen angegeben werden: (ios_receipt und ios_secret), recaptcha_token oder safety_net_token, um zu bestätigen, dass der Bestätigungscode im Namen einer echten App und nicht eines Emulators gesendet wird. Dieser Wert sollte aus der Antwort von [verifyIosClient][v1.accounts.verifyIosClient] stammen. Falls vorhanden, sollte der Aufrufer auch die ios_secret sowie eine Bundle-ID im x-ios-bundle-identifier-Header angeben. Diese muss mit der Bundle-ID aus der [verifyIosClient][v1.accounts.verifyIosClient]-Anfrage übereinstimmen.

ios_secret

string

Das Secret wird als Push-Benachrichtigung an die iOS-App gesendet. Muss mit einem ios_receipt- und dem x-ios-bundle-identifier-Header übergeben werden.

recaptcha_token

string

reCAPTCHA-Token für die App-Überprüfung. Wenn „captcha_response“ nicht verwendet wird (reCAPTCHA Enterprise ist nicht aktiviert), muss mindestens eine der folgenden Optionen angegeben werden, um zu bestätigen, dass der Bestätigungscode im Namen einer echten App und nicht eines Emulators gesendet wird: (ios_receipt und ios_secret), recaptcha_token oder safety_net_token. Das reCAPTCHA sollte durch Aufrufen von [getRecaptchaParams][v1.getRecaptchaParams] generiert werden. Das reCAPTCHA-Token wird generiert, wenn der Nutzer die reCAPTCHA-Herausforderung abgeschlossen hat.

tenant_id

string

Die Mandanten-ID des Identity Platform-Mandanten, bei dem sich der Nutzer anmeldet.

auto_retrieval_info

AutoRetrievalInfo

Nur Android. Wird von den Google Play-Diensten verwendet, um die App für den automatischen Abruf zu identifizieren.

safety_net_token

string

Nur Android. Wird verwendet, um die Anwendungsidentität anstelle eines reCAPTCHA-Tokens zu bestätigen. Wenn „captcha_response“ nicht verwendet wird (reCAPTCHA Enterprise ist nicht aktiviert), muss mindestens eine der folgenden Optionen angegeben werden: (ios_receipt und ios_secret), recaptcha_token oder safety_net_token, um zu bestätigen, dass der Bestätigungscode im Namen einer echten App und nicht eines Emulators gesendet wird. Ein SafetyNet-Token kann über die SafetyNet Android Attestation API generiert werden. Dabei wird die Base64-Codierung des Felds phone_number als Nonce verwendet.

play_integrity_token

string

Nur Android. Wird verwendet, um die Anwendungsidentität anstelle eines reCAPTCHA-Tokens (und eines Safety Net-Tokens) zu bestätigen. Wenn „captcha_response“ nicht verwendet wird (reCAPTCHA Enterprise ist nicht aktiviert), muss mindestens eine der folgenden Optionen angegeben werden, um zu bestätigen, dass der Bestätigungscode im Namen einer echten App und nicht eines Emulators gesendet wird: (ios_receipt und ios_secret), recaptcha_token oder play_integrity_token. Ein Play Integrity-Token kann über die Play Integrity API generiert werden, indem SHA256 auf das Feld phone_number als Nonce angewendet wird.

captcha_response

string

Optional. Das reCAPTCHA Enterprise-Token, das von der clientseitigen reCAPTCHA-Integration bereitgestellt wird. Erforderlich, wenn reCAPTCHA Enterprise aktiviert ist.

client_type

ClientType

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

recaptcha_version

RecaptchaVersion

Optional. Die reCAPTCHA-Version des reCAPTCHA-Tokens in der captcha_response. Erforderlich, wenn reCAPTCHA Enterprise aktiviert ist.

AutoRetrievalInfo

Die Informationen, die zum automatischen Abrufen einer SMS erforderlich sind.

Felder
app_signature_hash

string

Der Signatur-Hash der Android-App für die SMS Retriever API des Google Play-Dienstes.

SendVerificationCodeResponse

Antwortnachricht für SendVerificationCode.

Felder
session_info

string

Verschlüsselte Sitzungsinformationen. Dieser kann in [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber] verwendet werden, um die Telefonnummer zu authentifizieren.

SetAccountInfoRequest

Anfragenachricht für SetAccountInfo.

Felder
id_token

string

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

local_id

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.

display_name

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.

oob_code

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

email_verified

bool

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.

upgrade_to_federated_login

bool

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

captcha_challenge
(deprecated)

string

captcha_response

string

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

valid_since

int64

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

disable_user

bool

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

instance_id
(deprecated)

string

delegated_project_number
(deprecated)

int64

photo_url

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.

delete_attribute[]

UserAttributeName

return_secure_token

bool

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

delete_provider[]

string

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

last_login_at

int64

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

created_at

int64

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

phone_number

string

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

custom_attributes

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.

tenant_id

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.

target_project_id

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
mfa

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.

MfaInfo

Informationen zur Multi-Faktor-Authentifizierung

Felder
enrollments[]

MfaEnrollment

Die vom Nutzer registrierten zweiten Faktoren.

UserAttributeName

Die Attribute des Kontos, die gelöscht werden können.

Enums
USER_ATTRIBUTE_NAME_UNSPECIFIED Der Name des Nutzerattributs ist nicht angegeben.
EMAIL Der Schlüsselname des Nutzerattributs ist „email“.
DISPLAY_NAME Der Schlüsselname des Nutzerattributs lautet „displayName“.
PROVIDER Der Schlüsselname des Nutzerattributs lautet „provider“.
PHOTO_URL Der Schlüsselname des Nutzerattributs lautet „photoURL“.
PASSWORD Der Schlüsselname des Nutzerattributs lautet „password“.
RAW_USER_INFO Der Schlüsselname des Nutzerattributs lautet „rawUserInfo“.

SetAccountInfoResponse

Antwortnachricht für SetAccountInfo

Felder
kind
(deprecated)

string

local_id

string

Die ID des authentifizierten Nutzers.

email
(deprecated)

string

Die E-Mail-Adresse des Kontos.

display_name
(deprecated)

string

Der Anzeigename des Kontos.

id_token

string

Ein Identity Platform-ID-Token für das Konto. Dieser wird für die Registrierung von Legacy-Nutzern verwendet.

provider_user_info[]

ProviderUserInfo

Die verknüpften Identitätsanbieter im Konto.

new_email

string

Die neue E-Mail-Adresse, die in den Kontoattributen des Nutzers festgelegt wurde.

photo_url
(deprecated)

string

Die Foto-URL des Nutzers für das Profilbild des Kontos.

refresh_token

string

Ein Aktualisierungstoken für das Konto. Dieser wird für die Registrierung von Legacy-Nutzern verwendet.

expires_in

int64

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

password_hash
(deprecated)

string

Verworfen. Derzeit wird kein tatsächlicher Passwort-Hash zurückgegeben.

email_verified

bool

Gibt an, ob die E-Mail-Adresse des Kontos bestätigt wurde.

SignInWithCustomTokenRequest

Anfragenachricht für SignInWithCustomToken.

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.

instance_id
(deprecated)

string

return_secure_token

bool

Sollte immer wahr sein.

delegated_project_number
(deprecated)

int64

tenant_id

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.

SignInWithCustomTokenResponse

Antwortnachricht für SignInWithCustomToken

Felder
kind
(deprecated)

string

id_token

string

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

refresh_token

string

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

expires_in

int64

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

is_new_user

bool

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

SignInWithEmailLinkRequest

Anfragenachricht für SignInWithEmailLink

Felder
oob_code

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.

id_token

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.

tenant_id

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.

SignInWithEmailLinkResponse

Antwortnachricht für SignInWithEmailLink.

Felder
kind
(deprecated)

string

id_token

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.

refresh_token

string

Aktualisierungstoken für den authentifizierten Nutzer.

expires_in

int64

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

local_id

string

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

is_new_user

bool

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

mfa_pending_credential

string

Ein nicht transparenter String, der als Nachweis dient, dass der Nutzer die erste Faktorprüfung bestanden hat.

mfa_info[]

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.

SignInWithGameCenterRequest

Anfragenachricht für SignInWithGameCenter

Felder
player_id

string

Pflichtangabe. Die Game Center-Spieler-ID des Nutzers. Von Apple eingestellt.

Gib playerID zusammen mit gamePlayerID und teamPlayerID an, um die Migration der Game Center-Spieler-ID eines Nutzers zu gamePlayerID zu starten.

public_key_url

string

Pflichtangabe. Die URL, unter der der öffentliche Apple-Schlüssel abgerufen wird, um die angegebene Signatur zu überprüfen, ist von Apple signiert.

signature

string

Pflichtangabe. Die von Apple generierten Daten der Bestätigungssignatur.

salt

string

Pflichtangabe. Ein zufälliger String, der zum Generieren der angegebenen Signatur verwendet wird.

timestamp

int64

Pflichtangabe. Der Zeitpunkt, zu dem die Signatur von Apple erstellt wurde, in Millisekunden seit der Epoche.

id_token

string

Ein gültiges ID-Token für ein Identity Platform-Konto. Wenn vorhanden, wird mit dieser Anfrage die Game Center-Spieler-ID mit dem Konto verknüpft, das durch dieses ID-Token dargestellt wird.

display_name

string

Der Game Center-Anzeigename des Nutzers.

tenant_id

string

Die ID des Identity Platform-Mandanten, bei dem sich der Nutzer anmeldet.

team_player_id

string

Die Spieler-ID des Nutzers im Game Center-Team. Eine eindeutige Kennung für einen Spieler aller Spiele, die Sie über Ihr Entwicklerkonto vertreiben. https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid

game_player_id

string

Die Game Center-Spieler-ID des Nutzers. Eine eindeutige Kennung für einen Spieler des Spiels. https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid

SignInWithGameCenterResponse

Antwortnachricht für SignInWithGameCenter

Felder
local_id

string

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

player_id

string

Die Game Center-Spieler-ID des Nutzers.

Gib playerID zusammen mit gamePlayerID und teamPlayerID an, um die Migration der Game Center-Spieler-ID eines Nutzers zu gamePlayerID zu starten.

id_token

string

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

refresh_token

string

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

expires_in

int64

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

is_new_user

bool

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

display_name

string

Anzeigename des authentifizierten Nutzers.

team_player_id

string

Die Spieler-ID des Nutzers im Game Center-Team. Eine eindeutige Kennung für einen Spieler aller Spiele, die Sie über Ihr Entwicklerkonto vertreiben. https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid

game_player_id

string

Die Game Center-Spieler-ID des Nutzers. Eine eindeutige Kennung für einen Spieler des Spiels. https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid

SignInWithIdpRequest

Anfragenachricht für SignInWithIdp.

Felder
request_uri

string

Pflichtangabe. Die URL, an die der IdP den Nutzer zurückleitet. Dieser Wert kann auf http://localhost festgelegt werden, wenn sich der Nutzer mit manuell bereitgestellten IdP-Anmeldedaten anmeldet.

post_body

string

Wenn sich der Nutzer mit einer Autorisierungsantwort anmeldet, die über eine vorherige CreateAuthUri-Autorisierungsanfrage abgerufen wurde, ist dies der Textkörper des HTTP-POST-Callbacks vom IdP, sofern vorhanden.

Andernfalls, wenn sich der Nutzer mit manuell bereitgestellten Anmeldedaten für den Identitätsanbieter anmeldet, sollte dies ein URL-codiertes Formular sein, das die Anmeldedaten (z.B. ein ID-Token oder Zugriffstoken für OAuth 2.0-Identitätsanbieter) und die Anbieter-ID des Identitätsanbieters enthält, der die Anmeldedaten ausgestellt hat.

Wenn sich der Nutzer beispielsweise mit einem Google-ID-Token beim Google-Anbieter anmeldet, sollte dies auf id_token=[GOOGLE_ID_TOKEN]&providerId=google.com festgelegt werden. Dabei muss [GOOGLE_ID_TOKEN] durch das Google-ID-Token ersetzt werden.

Wenn sich der Nutzer mit einem Facebook-Authentifizierungstoken beim Facebook-Anbieter anmeldet, sollte dies auf id_token=[FACEBOOK_AUTHENTICATION_TOKEN]&providerId=facebook. com&nonce= [NONCE] festgelegt werden. Dabei muss [FACEBOOK_AUTHENTICATION_TOKEN] durch das Facebook-Authentifizierungstoken ersetzt werden. Der Nonce ist für die Validierung des Tokens erforderlich. Wenn kein Nonce angegeben wird, schlägt die Anfrage fehl.

Wenn sich der Nutzer mit einem Facebook-Zugriffstoken beim Facebook-Anbieter anmeldet, sollte dies auf access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=facebook. com festgelegt werden. Dabei muss [FACEBOOK_ACCESS_TOKEN] durch das Facebook-Zugriffstoken ersetzt werden.

Wenn sich der Nutzer mit Twitter OAuth 1.0-Anmeldedaten beim Twitter-Anbieter anmeldet, sollte dies auf access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret= [TWITTER_TOKEN_SECRET]&providerId=twitter.com festgelegt werden. Dabei sollten [TWITTER_ACCESS_TOKEN] und [TWITTER_TOKEN_SECRET] durch das Twitter OAuth-Zugriffstoken und das Twitter OAuth-Token-Geheimnis ersetzt werden.

pending_id_token
(deprecated)

string

return_refresh_token

bool

Gibt an, ob das OAuth-Aktualisierungstoken vom Identitätsanbieter zurückgegeben werden soll, falls verfügbar.

session_id

string

Die Sitzungs-ID, die von einem vorherigen CreateAuthUri-Aufruf zurückgegeben wurde. Dieses Feld wird anhand dieser Sitzungs-ID überprüft, um Angriffe über Sitzungsfixierung zu verhindern. Erforderlich, wenn sich der Nutzer mit einer Autorisierungsantwort aus einer vorherigen CreateAuthUri-Autorisierungsanfrage anmeldet.

delegated_project_number
(deprecated)

int64

id_token

string

Ein gültiges Identity Platform-ID-Token. Wenn der Test bestanden wird, wird das Konto des Nutzers beim IdP mit dem Konto verknüpft, das durch dieses ID-Token dargestellt wird.

return_secure_token

bool

Sollte immer wahr sein.

return_idp_credential

bool

Gibt an, ob OAuth-Anmeldedaten vom IdP für die folgenden Fehler zurückgegeben werden sollen: FEDERATED_USER_ID_ALREADY_LINKED und EMAIL_EXISTS.

auto_create
(deprecated)

bool

tenant_id

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.

pending_token

string

Ein undurchsichtiger String aus einer vorherigen SignInWithIdp-Antwort. Wenn dieser Parameter festgelegt ist, kann er verwendet werden, um die Anmeldung aus dem vorherigen SignInWithIdp-Vorgang zu wiederholen. Das kann der Fall sein, wenn der Nutzer seine Kontoinformationen im Rahmen eines vorherigen föderierten Anmeldeversuchs bestätigen oder eine Kontoverknüpfung vornehmen muss.

SignInWithIdpResponse

Antwortnachricht für SignInWithIdp.

Felder
federated_id

string

Die Konto-ID des Nutzers beim IdP. Muss immer in der Antwort vorhanden sein.

provider_id

string

Die Anbieter-ID des Identitätsanbieters, bei dem sich der Nutzer anmeldet. Muss immer in der Antwort vorhanden sein.

email

string

Die E-Mail-Adresse des Kontos des Nutzers beim Identitätsanbieter.

email_verified

bool

Gibt an, ob die E-Mail-Adresse des Nutzerkontos bestätigt wurde.

first_name

string

Der Vorname des Nutzers für sein Konto beim IdP.

full_name

string

Der vollständige Name des Nutzerkontos beim IdP.

last_name

string

Der Nachname des Nutzers für sein Konto beim IdP.

nick_name

string

Der Alias für das Konto des Nutzers beim IdP.

language

string

Die Spracheinstellung für das Konto des Nutzers beim IdP.

time_zone

string

Die Zeitzone für das Konto des Nutzers beim IdP.

photo_url

string

Die URL des Profilbilds des Nutzers beim Identitätsanbieter.

date_of_birth

string

Das Geburtsdatum des Nutzers für sein Konto beim Identitätsanbieter.

input_email
(deprecated)

string

original_email

string

Die Haupt-E-Mail-Adresse (E-Mail-Adresse der obersten Ebene) des Identity Platform-Kontos des Nutzers, sofern sie von der E-Mail-Adresse beim IdP abweicht. Nur vorhanden, wenn die Einstellung „Ein Konto pro E-Mail-Adresse“ aktiviert ist.

local_id

string

Die ID des authentifizierten Identity Platform-Nutzers. Muss immer in der Antwort vorhanden sein.

email_recycled

bool

Ob es ein Identity Platform-Nutzerkonto mit derselben E-Mail-Adresse gibt, das aber mit einem anderen Konto beim selben IdP verknüpft ist. Nur vorhanden, wenn die Einstellung „Ein Konto pro E-Mail-Adresse“ aktiviert ist und die E-Mail-Adresse beim IdP bestätigt wurde.

display_name

string

Der Anzeigename für das Konto des Nutzers beim Identitätsanbieter.

id_token

string

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

context

string

Der in CreateAuthUri festgelegte opake String, der verwendet wird, um Kontextinformationen zwischen der Authentifizierungsanfrage und dem Callback vom IdP aufrechtzuerhalten.

verified_provider[]

string

Eine Liste von Anbieter-IDs, mit denen sich der Nutzer anmelden kann, um einen need_confirmation-Fehler zu beheben. Nur vorhanden, wenn need_confirmation auf true gesetzt ist.

need_confirmation

bool

Ob es ein Identity Platform-Nutzerkonto mit derselben E-Mail-Adresse wie das aktuelle Konto gibt, das beim IdP angemeldet ist, und ob die E-Mail-Adresse des Kontos beim IdP nicht bestätigt wurde. Der Nutzer muss sich im vorhandenen Identity Platform-Konto anmelden und die aktuellen Anmeldedaten des IdP damit verknüpfen. Nur vorhanden, wenn die Einstellung „Ein Konto pro E-Mail-Adresse“ aktiviert ist.

oauth_access_token

string

Das OAuth-Zugriffstoken des Identitätsanbieters, falls verfügbar.

oauth_refresh_token

string

Das OAuth 2.0-Aktualisierungstoken vom IdP, falls verfügbar und return_refresh_token auf true festgelegt ist.

oauth_expire_in

int32

Die Anzahl der Sekunden, bis das OAuth-Zugriffstoken vom IdP abläuft.

oauth_authorization_code

string

Den OAuth 2.0-Autorisierungscode, falls verfügbar. Nur für den Google-Anbieter vorhanden.

need_email
(deprecated)

bool

oauth_token_secret

string

Das OAuth 1.0-Token-Secret des Identitätsanbieters, falls verfügbar. Nur für den Twitter-Anbieter vorhanden.

refresh_token

string

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

expires_in

int64

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

oauth_id_token

string

Das OpenID Connect-ID-Token vom IdP, falls verfügbar.

screen_name

string

Der Alias für das Konto des Nutzers beim Twitter-IdP oder der Anmeldename für das Konto des Nutzers beim GitHub-IdP.

raw_user_info

string

Die String-JSON-Antwort mit allen Daten, die dem Konto des Nutzers beim IdP entsprechen.

error_message

string

Die Fehlermeldung, die zurückgegeben wird, wenn return_idp_credential auf true gesetzt ist und entweder der Fehler FEDERATED_USER_ID_ALREADY_LINKED oder EMAIL_EXISTS auftritt. Der Wert dieses Felds ist entweder FEDERATED_USER_ID_ALREADY_LINKED oder EMAIL_EXISTS.

is_new_user

bool

Gibt an, ob für den authentifizierten Nutzer ein neues Identity Platform-Konto erstellt wurde.

kind
(deprecated)

string

pending_token

string

Ein intransparenter String, der als Anmeldedaten des Identitätsanbieters verwendet werden kann, bei dem sich der Nutzer anmeldet. Das hier erhaltene ausstehende Token kann in einer zukünftigen SignInWithIdp-Anfrage festgelegt werden, um denselben Nutzer noch einmal mit dem IdP anzumelden.

tenant_id

string

Der Wert des Felds tenant_id in der Anfrage.

mfa_pending_credential

string

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

mfa_info[]

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.

SignInWithPasswordRequest

Anfragenachricht für SignInWithPassword

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.

pending_id_token
(deprecated)

string

captcha_challenge
(deprecated)

string

captcha_response

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.

instance_id
(deprecated)

string

delegated_project_number
(deprecated)

int64

id_token
(deprecated)

string

return_secure_token

bool

Sollte immer wahr sein.

tenant_id

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.

client_type

ClientType

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

recaptcha_version

RecaptchaVersion

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

SignInWithPasswordResponse

Antwortnachricht für SignInWithPassword

Felder
kind
(deprecated)

string

local_id

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.

display_name

string

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

id_token

string

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

registered
(deprecated)

bool

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

profile_picture

string

Das Profilbild des Nutzers, das in den Attributen des Kontos gespeichert ist.

oauth_access_token
(deprecated)

string

Das OAuth2-Zugriffstoken.

oauth_expire_in
(deprecated)

int32

Die Ablaufzeit des Zugriffstokens in Sekunden.

oauth_authorization_code
(deprecated)

string

refresh_token

string

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

expires_in

int64

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

mfa_pending_credential

string

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

mfa_info[]

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.

user_notifications[]

UserNotification

Warnmeldungen für den Nutzer.

SignInWithPhoneNumberRequest

Anfragenachricht für SignInWithPhoneNumber.

Felder
session_info

string

Verschlüsselte Sitzungsinformationen aus der Antwort von [sendVerificationCode][v1.accounts.sendVerificationCode]. Bei der Authentifizierung mit einem SMS-Code muss dies angegeben werden, bei der Verwendung eines temporären Nachweises ist dies jedoch nicht erforderlich.

phone_number

string

Die Telefonnummer des Nutzers, mit der er sich anmelden möchte. Dies ist erforderlich, wenn Sie einen temporären Nachweis verwenden. In diesem Fall muss sie mit der Telefonnummer übereinstimmen, die bei der Anfrage authentifiziert wurde, aus der der temporäre Nachweis generiert wurde. Dieses Feld wird ignoriert, wenn Sitzungsinformationen übergeben werden.

code

string

Vom Nutzer eingegebener Bestätigungscode aus einer SMS, die an das Smartphone des Nutzers gesendet wurde.

temporary_proof

string

Ein Nachweis der Bestätigung der Telefonnummer, der aus einer vorherigen [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber]-Anfrage stammt. Wenn dies der Fall ist, muss der Aufrufer auch die Telefonnummer im Feld „phone_number“ angeben, die in der vorherigen Anfrage bestätigt wurde.

verification_proof

string

Nicht verwenden.

id_token

string

Ein gültiges ID-Token für ein Identity Platform-Konto. Wenn die Anfrage erfolgreich ist, wird die Telefonnummer mit dem Nutzer verknüpft, der durch dieses ID-Token vertreten wird, sofern die Telefonnummer nicht verwendet wird. Andernfalls wird der Nutzer noch einmal authentifiziert, wenn die Telefonnummer bereits mit dem Nutzer verknüpft ist.

operation
(deprecated)

VerifyOp

tenant_id

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.

VerifyOp

Vorgesehene Verwendung.

Enums
VERIFY_OP_UNSPECIFIED Vorgang nicht angegeben
SIGN_UP_OR_IN Prüfen Sie, ob die Aktion die Registrierung/Anmeldung ist.
REAUTH Prüfen, ob der Vorgang die erneute Autorisierung ist.
UPDATE Prüfen Sie, ob die Operation eine Aktualisierung ist.

SignInWithPhoneNumberResponse

Antwortnachricht für SignInWithPhoneNumber

Felder
id_token

string

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

refresh_token

string

Aktualisierungstoken für den authentifizierten Nutzer.

expires_in

int64

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

local_id

string

Die ID des authentifizierten Nutzers. Ist bei einer erfolgreichen Authentifizierung vorhanden. Wenn das Smartphone zwar bestätigt werden konnte, der Kontovorgang aber nicht ausgeführt werden konnte, wird stattdessen ein temporärer Nachweis zurückgegeben.

is_new_user

bool

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

temporary_proof

string

Ein Nachweis der Bestätigung der Telefonnummer, der bei einer erfolgreichen Telefonauthentifizierung, aber einem fehlgeschlagenen Nutzervorgang vorgelegt wird. Das passiert, wenn bei der Anfrage versucht wird, eine Telefonnummer mit einem Nutzer mit einem ID-Token zu verknüpfen oder sich mit einem ID-Token noch einmal zu authentifizieren, die Telefonnummer aber mit einem anderen Nutzer verknüpft ist.

verification_proof

string

Nicht verwenden.

verification_proof_expires_in

int64

Nicht verwenden.

phone_number

string

Telefonnummer des authentifizierten Nutzers. Muss immer in der Antwort vorhanden sein.

temporary_proof_expires_in

int64

Die Anzahl der Sekunden, bis der temporäre Nachweis abläuft.

SignUpRequest

Anfragenachricht für SignUp.

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.

display_name

string

Der Anzeigename des zu erstellenden Nutzers.

captcha_challenge
(deprecated)

string

captcha_response

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.

instance_id
(deprecated)

string

id_token

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 local_id nicht festgelegt sein.

email_verified

bool

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.

photo_url

string

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

disabled

bool

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.

local_id

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.

phone_number

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.

tenant_id

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.

target_project_id

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 entsprechenden Berechtigungen erforderlich. Wenn dies nicht festgelegt ist, wird das Zielprojekt aus dem Umfang abgeleitet, der dem Bearer-Zugriffstoken zugewiesen ist.

mfa_info[]

MfaFactor

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

client_type

ClientType

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

recaptcha_version

RecaptchaVersion

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

MfaFactor

Felder
display_name

string

Anzeigename für diese MFA-Option, z.B. „Firmenhandy“.

Union-Feld mfa_value.

Für mfa_value ist nur einer der folgenden Werte zulässig:

phone_info

string

Telefonnummer, unter der Sie das OTP für die Bestätigung in zwei Schritten erhalten.

SignUpResponse

Antwortnachricht für SignUp.

Felder
kind

string

id_token

string

Ein Identity Platform-ID-Token für den erstellten Nutzer. Dieses Feld wird nur für Anfragen festgelegt, die nicht von Administratoren stammen.

display_name

string

Der Anzeigename des erstellten Nutzers.

email

string

Die E-Mail-Adresse des erstellten Nutzers.

refresh_token

string

Ein Identity Platform-Aktualisierungstoken für den erstellten Nutzer. Dieses Feld wird nur für Anfragen festgelegt, die nicht von Administratoren stammen.

expires_in

int64

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

local_id

string

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

TotpInfo

Dieser Typ hat keine Felder.

Informationen zur TOTP-MFA

UploadAccountRequest

Anfragenachricht für UploadAccount.

Felder
hash_algorithm

string

Pflichtangabe. Die Hash-Funktion, die zum Hashen der Kontopasswörter verwendet wird. Muss einer der folgenden Werte sein: * HMAC_SHA256 * HMAC_SHA1 * HMAC_MD5 * SCRYPT * PBKDF_SHA1 * MD5 * HMAC_SHA512 * SHA1 * BCRYPT * PBKDF2_SHA256 * SHA256 * SHA512 * STANDARD_SCRYPT * ARGON2

signer_key

bytes

Der Signaturschlüssel, der zum Hashen des Passworts verwendet wird. Erforderlich für die folgenden Hash-Funktionen: * SCRYPT, * HMAC_MD5, * HMAC_SHA1, * HMAC_SHA256, * HMAC_SHA512

salt_separator

bytes

Ein oder mehrere Bytes, die zwischen dem Salt und dem Klartextpasswort eingefügt werden. Für eine bessere Sicherheit sollte dies ein einzelnes nicht druckbares Zeichen sein.

rounds

int32

Die Anzahl der Runden, die für die Hash-Berechnung verwendet werden. Nur für die folgenden Hash-Funktionen erforderlich: * MD5 * SHA1 * SHA256 * SHA512 * PBKDF_SHA1 * PBKDF2_SHA256 * SCRYPT

memory_cost

int32

Speicherkosten für die Hash-Berechnung. Nur erforderlich, wenn die Hash-Funktion SCRYPT ist.

users[]

UserInfo

Eine Liste der Konten, die hochgeladen werden sollen. local_id ist für jeden Nutzer erforderlich. Alle anderen Angaben sind optional.

delegated_project_number
(deprecated)

int64

sanity_check

bool

Wenn diese Option aktiviert ist, führt der Dienst vor dem Hochladen eines Kontos die folgenden Prüfungen durch: * Duplizierte E-Mail-Adressen * Duplizierte föderierte IDs * Überprüfung des Anbieters der föderierten ID Wenn die Duplizierung in der Liste der hochzuladenden Konten vorhanden ist, wird der Upload der gesamten Liste verhindert. Wenn die E-Mail-Adresse oder die föderierte ID einem Nutzer im Projekt/Tenant entspricht, wird das Konto nicht hochgeladen. Die übrigen Konten sind davon nicht betroffen. Wenn „false“ festgelegt ist, werden diese Prüfungen übersprungen.

target_project_id

string

Die Projekt-ID des Identity Platform-Projekts, zu dem das Konto gehört.

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

  • firebaseauth.users.create
allow_overwrite

bool

Gibt an, ob ein vorhandenes Konto in Identity Platform mit einem übereinstimmenden local_id in der Anfrage überschrieben werden soll. Wenn diese Option aktiviert ist, wird das vorhandene Konto überschrieben. Andernfalls wird ein Fehler zurückgegeben.

cpu_mem_cost

int32

Der Parameter für die CPU-Speicherkosten, der von der Hash-Funktion STANDARD_SCRYPT verwendet werden soll. Dieser Parameter sowie „block_size“ und „cpu_mem_cost“ helfen dabei, die Ressourcen zu optimieren, die zum Hashen eines Passworts erforderlich sind. Sie sollten angepasst werden, wenn sich die Prozessorgeschwindigkeiten und Speichertechnologien weiterentwickeln.

parallelization

int32

Der Parameter für Parallelisierungskosten, der von der Hash-Funktion STANDARD_SCRYPT verwendet werden soll. Dieser Parameter sowie „block_size“ und „cpu_mem_cost“ helfen dabei, die Ressourcen zu optimieren, die zum Hashen eines Passworts erforderlich sind. Sie sollten angepasst werden, wenn sich die Prozessorgeschwindigkeiten und Speichertechnologien weiterentwickeln.

block_size

int32

Der Blockgrößenparameter, der von der Hash-Funktion STANDARD_SCRYPT verwendet wird. Dieser Parameter sowie „parallelization“ und „cpu_mem_cost“ helfen dabei, die Ressourcen zu optimieren, die zum Hashen eines Passworts erforderlich sind. Sie sollten angepasst werden, wenn sich die Prozessorgeschwindigkeiten und Speichertechnologien weiterentwickeln.

dk_len

int32

Die gewünschte Schlüssellänge für die Hash-Funktion STANDARD_SCRYPT. Muss mindestens 1 sein.

password_hash_order

PasswordHashOrder

tenant_id

string

Die ID des Identity Platform-Mandans, zu dem das Konto gehört.

argon2_parameters

Argon2Parameters

Die Parameter für den Argon2-Hash-Algorithmus.

PasswordHashOrder

Ob beim Hashen von Passwörtern das Passwort vor oder nach dem Salt stehen soll.

Enums
UNSPECIFIED_ORDER Die Reihenfolge ist nicht angegeben.
SALT_AND_PASSWORD Die Reihenfolge ist zuerst das Salz und dann das Passwort.
PASSWORD_AND_SALT Die Reihenfolge ist zuerst Passwort und dann Salt.

UploadAccountResponse

Antwortnachricht für UploadAccount

Felder
kind
(deprecated)

string

error[]

ErrorInfo

Detaillierte Fehlerinformationen für Konten, die nicht hochgeladen werden können.

UserInfo

Informationen zu einem Identity Platform-Konto.

Felder
local_id

string

Nicht veränderbar. Die eindeutige ID des Kontos.

email

string

Die E-Mail-Adresse des Kontos. 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.

display_name

string

Der Anzeigename des Kontos. Dieses Kontoattribut wird von Identity Platform nicht verwendet. Sie dienen nur zu Informationszwecken.

language

string

Nur Ausgabe. Die Spracheinstellung des Kontos. Dieses Kontoattribut wird von Identity Platform nicht verwendet. Sie dienen nur zu Informationszwecken.

photo_url

string

Die URL des Profilbilds des Kontos. Dieses Kontoattribut wird von Identity Platform nicht verwendet. Sie dienen nur zu Informationszwecken.

time_zone

string

Nur Ausgabe. Die Zeitzone des Kontos. Dieses Kontoattribut wird von Identity Platform nicht verwendet. Sie dienen nur zu Informationszwecken.

date_of_birth

string

Nur Ausgabe. Das für das Konto festgelegte Geburtsdatum. Dieses Kontoattribut wird von Identity Platform nicht verwendet. Sie dienen nur zu Informationszwecken.

password

bytes

Das gehashte Passwort des Kontos. Nur über Anfragen mit Google OAuth2-Anmeldedaten mit den richtigen Berechtigungen zugänglich.

salt

bytes

Das Salt des Kontopassworts. Nur über Anfragen mit Google OAuth2-Anmeldedaten mit den entsprechenden Berechtigungen zugänglich.

version

int32

Die Version des Passworts des Kontos. Nur über Anfragen mit Google OAuth2-Anmeldedaten mit den entsprechenden Berechtigungen zugänglich.

email_verified

bool

Gibt an, ob die E-Mail-Adresse des Kontos bestätigt wurde.

password_updated_at

double

Der Zeitstempel in Millisekunden seit der Epoche 1970-01-01T00:00:00Z, zu dem das Passwort des Kontos zuletzt aktualisiert wurde.

provider_user_info[]

ProviderUserInfo

Informationen zum Nutzer, die von verschiedenen Identitätsanbietern bereitgestellt werden.

valid_since

int64

Der älteste Zeitstempel in Sekunden seit der Epoche, bis zu dem ein ID-Token als gültig betrachtet werden sollte. Alle vor diesem Zeitpunkt ausgestellten ID-Tokens gelten als ungültig.

disabled

bool

Gibt an, ob das Konto deaktiviert ist. Deaktivierte Konten sind nur für Anfragen mit Google OAuth2-Anmeldedaten mit den entsprechenden Berechtigungen zugänglich.

last_login_at

int64

Das Datum und die Uhrzeit der letzten Anmeldung in diesem Konto in Millisekunden seit der Epoche.

created_at

int64

Die Zeit in Millisekunden seit der Epoche, zu der das Konto erstellt wurde.

screen_name

string

Nur Ausgabe. Der Alias dieses Kontos bei Twitter oder der Anmeldename bei GitHub.

custom_auth

bool

Nur Ausgabe. Gibt an, ob dieses Konto mit „SignInWithCustomToken“ authentifiziert wurde.

raw_password

string

Nur Eingabe. Passwort im Klartext, mit dem das Passwort eines Kontos aktualisiert wird. Dieses Feld wird nur als Eingabe in einer Anfrage verwendet. Identity Platform verwendet beim Verwalten von Passwörtern kryptografisch sichere Hash-Technologie und speichert oder überträgt das Passwort eines Nutzers niemals im Klartext.

phone_number

string

Die Telefonnummer des Kontos.

custom_attributes

string

Benutzerdefinierte Ansprüche, die allen ID-Tokens hinzugefügt werden, die für das Konto erstellt werden. Sie darf maximal 1.000 Zeichen lang sein und muss im gültigen JSON-Format vorliegen.

tenant_id

string

ID des Mandanten, dem dieses Konto zugewiesen ist. Nur festlegen, wenn dieses Konto zu einem Tenant gehört.

mfa_info[]

MfaEnrollment

Informationen dazu, welche Anbieter für die Multi-Faktor-Authentifizierung für dieses Konto aktiviert sind.

initial_email

string

Die erste E-Mail-Adresse, die mit diesem Konto verknüpft ist. Die erste E-Mail-Adresse des Kontos kann nach dem Festlegen nicht mehr geändert werden. Sie wird verwendet, um den Zugriff auf dieses Konto wiederherzustellen, falls er über den Ablauf RECOVER_EMAIL in GetOobCode verloren gegangen ist. Muss der Adressenspezifikation von RFC 822 entsprechen.

last_refresh_at

Timestamp

Zeitstempel, zu dem ein ID-Token zuletzt für dieses Konto erstellt wurde.

UserNotification

Warnmeldungen für den Nutzer.

Felder
notification_code

NotificationCode

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

notification_message

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.

VerifyIosClientRequest

Anfragenachricht für VerifyIosClient

Felder
app_token

string

Ein Gerätetoken, das der iOS-Client nach der Registrierung bei APNs (Apple Push Notification Service) erhält.

is_sandbox

bool

Gibt an, ob sich das App-Token in der iOS-Sandbox befindet. Wenn „false“ festgelegt ist, befindet sich das App-Token in der Produktionsumgebung.

VerifyIosClientResponse

Antwortnachricht für VerifyIosClient.

Felder
receipt

string

Erfolgreiche Bestätigung des App-Tokens

suggested_timeout

int64

Empfohlene Zeit in Sekunden, die der Client auf die Zustellung der Push-Benachrichtigung warten sollte.