Package google.cloud.identitytoolkit.v2

Index

AccountManagementService

Kontoverwaltung für Identity Toolkit

FinalizeMfaEnrollment

rpc FinalizeMfaEnrollment(FinalizeMfaEnrollmentRequest) returns (FinalizeMfaEnrollmentResponse)

Die Registrierung eines zweiten Faktors für den Nutzer wird abgeschlossen.

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.
StartMfaEnrollment

rpc StartMfaEnrollment(StartMfaEnrollmentRequest) returns (StartMfaEnrollmentResponse)

Schritt 1 der MFA-Registrierung Im Fall einer SMS wird ein SMS-Bestätigungscode an den Nutzer gesendet.

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.
WithdrawMfa

rpc WithdrawMfa(WithdrawMfaRequest) returns (WithdrawMfaResponse)

Entfernt einen der registrierten zweiten Faktoren für ein Konto.

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.

AuthenticationService

Authentifizierung für Identity Toolkit

FinalizeMfaSignIn

rpc FinalizeMfaSignIn(FinalizeMfaSignInRequest) returns (FinalizeMfaSignInResponse)

Prüft die MFA-Abfrage und führt die Anmeldung durch

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.
GetPasswordPolicy

rpc GetPasswordPolicy(GetPasswordPolicyRequest) returns (PasswordPolicy)

Ruft die Konfiguration der Passwortrichtlinie für das Projekt oder den Mandanten 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.
GetRecaptchaConfig

rpc GetRecaptchaConfig(GetRecaptchaConfigRequest) returns (RecaptchaConfig)

Ruft Parameter ab, die für die reCAPTCHA-Analyse 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.
RevokeToken

rpc RevokeToken(RevokeTokenRequest) returns (RevokeTokenResponse)

Hiermit wird das Token eines Nutzers bei einem Identitätsanbieter (IdP) widerrufen. Dazu müssen Sie manuell Anmeldedaten für den Identitätsanbieter und die Tokentypen für den Widerruf angeben.

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.
StartMfaSignIn

rpc StartMfaSignIn(StartMfaSignInRequest) returns (StartMfaSignInResponse)

MFA-Herausforderung 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.

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.

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“.

FinalizeMfaEnrollmentRequest

Die Registrierung eines zweiten Faktors für den Nutzer wird abgeschlossen.

Felder
id_token

string

Pflichtangabe. ID-Token
display_name

string

Anzeigename, der von Nutzern eingegeben wird, um zwischen verschiedenen zweiten Faktoren mit demselben oder einem anderen Typ zu unterscheiden.
tenant_id

string

Die ID des Identity Platform-Mandanten, zu dem der Nutzer gehört, der die Bestätigung in zwei Schritten registriert. Wenn nicht festgelegt, gehört der Nutzer zum Standard-Identity Platform-Projekt.
Union-Feld verification_info. Informationen zur MFA-Registrierung müssen bestätigt werden. Für verification_info ist nur einer der folgenden Werte zulässig:
phone_verification_info

FinalizeMfaPhoneRequestInfo

Bestätigungsinformationen, um das Senden einer SMS zur Bestätigung des Smartphones zu autorisieren.
totp_verification_info

FinalizeMfaTotpEnrollmentRequestInfo

Bestätigungsinformationen für TOTP

FinalizeMfaEnrollmentResponse

Antwort von FinalizeMfaEnrollment

Felder
id_token

string

ID-Token wurde aktualisiert, um die MFA-Registrierung widerzuspiegeln.
refresh_token

string

Aktualisierungstoken wurde entsprechend der MFA-Registrierung aktualisiert.
Union-Feld auxiliary_auth_info. Informationen zur Anmeldung, die mit der Multi-Faktor-Authentifizierung bestätigt wurden. Für auxiliary_auth_info ist nur einer der folgenden Werte zulässig:
phone_auth_info

FinalizeMfaPhoneResponseInfo

Zusätzliche Authentifizierungsinformationen, die für die Telefonauthentifizierung spezifisch sind.
totp_auth_info

FinalizeMfaTotpEnrollmentResponseInfo

Informationen zur sekundären Authentifizierung, die für die TOTP-Authentifizierung spezifisch sind.

FinalizeMfaPhoneRequestInfo

Informationen zur Bestätigung der Telefonnummer für eine FinalizeMfa-Anfrage.

Felder
session_info

string

Ein nicht transparenter String, der die Registrierungssitzung darstellt.
code

string

Vom Nutzer eingegebener Bestätigungscode.
android_verification_proof

string

Nur Android. Verwendung für die „sofortige“ Bestätigung der Telefonnummer über GmsCore.
phone_number

string

Erforderlich, wenn ein Android-Bestätigungsnachweis vorgelegt wird.

FinalizeMfaPhoneResponseInfo

Informationen zur Bestätigung der Telefonnummer für eine FinalizeMfa-Antwort.

Felder
android_verification_proof

string

Nur Android. Langlebiger Ersatz für einen gültigen Code, der mit einem Android-Gerät verknüpft ist.
android_verification_proof_expire_time

Timestamp

Nur Android. Ablaufzeit des Bestätigungsnachweises in Sekunden.
phone_number

string

Für den Nachweis der Android-Bestätigung.

FinalizeMfaSignInRequest

Die Anmeldung wird durch die Bestätigung der MFA-Aufforderung abgeschlossen.

Felder
mfa_pending_credential

string

Pflichtangabe. Anmeldedaten aus der Anmeldung mit dem ersten Faktor ausstehend.
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.
mfa_enrollment_id

string

Die MFA-Registrierungs-ID aus der Liste der aktuellen MFA-Registrierungen des Nutzers.
Union-Feld verification_info. Nachweis, dass die MFA-Abfrage abgeschlossen wurde. Für verification_info ist nur einer der folgenden Werte zulässig:
phone_verification_info

FinalizeMfaPhoneRequestInfo

Nachweis, dass die SMS-basierte MFA-Herausforderung abgeschlossen wurde.
totp_verification_info

MfaTotpSignInRequestInfo

Nachweis, dass die TOTP-basierte MFA-Herausforderung abgeschlossen wurde.

FinalizeMfaSignInResponse

Antwort von FinalizeMfaSignIn

Felder
id_token

string

ID-Token für den authentifizierten Nutzer.
refresh_token

string

Aktualisierungstoken für den authentifizierten Nutzer.
Union-Feld auxiliary_auth_info. Anmeldedaten, die mit der Multi-Faktor-Authentifizierung bestätigt wurden Für auxiliary_auth_info ist nur einer der folgenden Werte zulässig:
phone_auth_info

FinalizeMfaPhoneResponseInfo

Zusätzliche Informationen zur Smartphone-Authentifizierung, einschließlich Nachweis der Android-Bestätigung

FinalizeMfaTotpEnrollmentRequestInfo

Informationen zur MFA-Anfrage, die speziell für die TOTP-Authentifizierung für FinalizeMfa gelten.

Felder
session_info

string

Ein nicht transparenter String, der die Registrierungssitzung darstellt.
verification_code

string

Vom Nutzer eingegebener Bestätigungscode.

FinalizeMfaTotpEnrollmentResponseInfo

Dieser Typ hat keine Felder.

Informationen zur MFA-Antwort, die speziell für die TOTP-Authentifizierung für FinalizeMfa gelten.

GetPasswordPolicyRequest

Die Anfrage für GetPasswordPolicy.

Felder
tenant_id

string

Die ID eines Mandanten.

GetRecaptchaConfigRequest

Die Anfrage für GetRecaptchaConfig.

Felder
tenant_id

string

Die ID eines Mandanten.
client_type

ClientType

reCAPTCHA Enterprise verwendet separate Websiteschlüssel für verschiedene Clienttypen. Geben Sie den Clienttyp an, um den entsprechenden Schlüssel abzurufen.
version

RecaptchaVersion

Die reCAPTCHA-Version.

MfaTotpSignInRequestInfo

TOTP-Bestätigungsinformationen für FinalizeMfaSignInRequest.

Felder
verification_code

string

Vom Nutzer eingegebener Bestätigungscode.

PasswordPolicy

Konfiguration der Passwortrichtlinie.

Felder
custom_strength_options

CustomStrengthOptions

Die benutzerdefinierten Stärkeoptionen, die von der Passwortrichtlinie erzwungen werden.
schema_version

int32

Nur Ausgabe. Schemaversion für die Passwortrichtlinie
allowed_non_alphanumeric_characters[]

string

Nur Ausgabe. Zulässige Zeichen, die die Anforderung „non_alphanumeric“ erfüllen.
enforcement_state

EnforcementState

Nur Ausgabe. Welcher Erzwingungsmodus für die Passwortrichtlinie verwendet werden soll.
force_upgrade_on_signin

bool

Nutzer müssen ein Passwort haben, das der Passwortrichtlinie entspricht, um sich anzumelden.

CustomStrengthOptions

Benutzerdefinierte Optionen für die Passwortstärke, die für Nutzerpasswörter erzwungen werden sollen.

Felder
min_password_length

int32

Mindestlänge des Passworts. Liegt im Bereich von 6 bis 30
max_password_length

int32

Maximale Passwortlänge. Keine Standardmaximallänge
contains_lowercase_character

bool

Das Passwort muss einen Kleinbuchstaben enthalten.
contains_uppercase_character

bool

Das Passwort muss einen Großbuchstaben enthalten.
contains_numeric_character

bool

Das Passwort muss eine Ziffer enthalten.
contains_non_alphanumeric_character

bool

Das Passwort muss ein nicht alphanumerisches Zeichen enthalten.

EnforcementState

Erzwingungsstatus für die Passwortrichtlinie

Enums
ENFORCEMENT_STATE_UNSPECIFIED Der Status der Erzwingung wurde nicht festgelegt.
OFF Die Passwortrichtlinie wird für das Projekt nicht verwendet.
ENFORCE Passwörter, die nicht der Passwortrichtlinie entsprechen, werden abgelehnt und es wird ein Fehler ausgegeben.

RecaptchaConfig

Konfiguration für reCAPTCHA

Felder
recaptcha_enforcement_state[]

RecaptchaEnforcementState

Der Status der reCAPTCHA-Erzwingung für die Anbieter, für die GCIP den reCAPTCHA-Schutz unterstützt.
recaptcha_key

string

Der Name der reCAPTCHA Enterprise-Schlüsselressource, z.B. „projects/{project}/keys/{key}“. Dieser Wert wird nur zurückgegeben, wenn der Status der reCAPTCHA-Durchsetzung für mindestens einen der reCAPTCHA-Anbieter „AUDIT“ oder „ENFORCE“ ist.
use_sms_bot_score

bool

Gibt an, ob der rCE-Bot-Score für den reCAPTCHA-Telefonanbieter verwendet werden soll.
use_sms_toll_fraud_protection

bool

Ob der Risikowert für den SMS-Gebührenbetrugsschutz von reCAPTCHA für den Telefonanbieter verwendet werden soll.

RecaptchaEnforcementState

Erzwingungsstatus für den reCAPTCHA-Schutz

Felder
provider

RecaptchaProvider

Der Anbieter, der reCAPTCHA-Schutz verwendet.
enforcement_state

EnforcementState

Der Status der reCAPTCHA-Erzwingung für den Anbieter.

EnforcementState

Erzwingungsstatus für den reCAPTCHA-Schutz pro Anbieter.

Enums
ENFORCEMENT_STATE_UNSPECIFIED Der Status der Erzwingung wurde nicht festgelegt.
OFF Nicht erzwungen.
AUDIT Die reCAPTCHA-Bewertung wird erstellt, das Ergebnis wird jedoch nicht erzwungen.
ENFORCE Die reCAPTCHA-Bewertung wird erstellt und das Ergebnis wird erzwungen.

RecaptchaProvider

Die GCIP-Anbieter, die den reCAPTCHA-Schutz unterstützen.

Enums
RECAPTCHA_PROVIDER_UNSPECIFIED reCAPTCHA-Anbieter nicht angegeben
EMAIL_PASSWORD_PROVIDER Anbieter des E-Mail-Passworts
PHONE_PROVIDER Anbieter der Telefonauthentifizierung

RecaptchaVersion

Die reCAPTCHA-Version.

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

RevokeTokenRequest

Anfragenachricht für RevokeToken

Felder
provider_id

string

Pflichtangabe. Der IDP-Anbieter für das Token. Derzeit wird nur Apple-IdP unterstützt. Das Format sollte „apple.com“ sein.
token_type

TokenType

Pflichtangabe. Der Typ des zu widerrufenden Tokens.
token

string

Pflichtangabe. Das Token, das widerrufen werden soll. Wenn ein Autorisierungscode übergeben wird, tauscht die API den Code zuerst gegen ein Zugriffstoken aus und widerruft dann das getauschte Token.
id_token

string

Pflichtangabe. Ein gültiges Identity Platform-ID-Token zum Verknüpfen des Kontos. Wenn für das Konto eine erfolgreiche Tokenentzugsanfrage erfolgt ist und nach dem Widerruf keine Tokens generiert werden, werden die doppelten Anfragen ignoriert und sofort zurückgegeben.
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.
redirect_uri

string

Der Weiterleitungs-URI, der in der ersten Autorisierungsanfrage des Clients an den Identitätsanbieter angegeben wurde. Der URI muss das HTTPS-Protokoll verwenden, einen Domainnamen enthalten und darf keine IP-Adresse oder „localhost“ enthalten. Erforderlich, wenn „token_type“ den Wert „CODE“ hat.

Tokentyp

Der Typ des zu widerrufenden Tokens.

Enums
TOKEN_TYPE_UNSPECIFIED Standardwert, nicht verwenden
REFRESH_TOKEN Der Tokentyp ist „refresh_token“.
ACCESS_TOKEN Der Tokentyp ist „access_token“.
CODE Der Tokentyp ist „authorization_code“.

RevokeTokenResponse

Dieser Typ hat keine Felder.

Antwortnachricht für RevokeToken. Noch leer.

StartMfaEnrollmentRequest

Sendet eine SMS zur Bestätigung der MFA-Registrierung für einen Nutzer.

Felder
id_token

string

Pflichtangabe. ID-Token des Nutzers.
tenant_id

string

Die ID des Identity Platform-Mandanten, zu dem der Nutzer gehört, der die Bestätigung in zwei Schritten registriert. Wenn nicht festgelegt, gehört der Nutzer zum Standard-Identity Platform-Projekt.
Union-Feld enrollment_info. Informationen zur MFA nach Art des zweiten Faktors. Für enrollment_info ist nur einer der folgenden Werte zulässig:
phone_enrollment_info

StartMfaPhoneRequestInfo

Bestätigungsinformationen, um das Senden einer SMS zur Bestätigung des Smartphones zu autorisieren.
totp_enrollment_info

StartMfaTotpEnrollmentRequestInfo

Anmeldedaten für die TOTP-Authentifizierung

StartMfaEnrollmentResponse

Antwort auf StartMfaEnrollment

Felder
Union-Feld enrollment_response. MFA-Registrierungsantwort nach dem Typ des zweiten Faktors Für enrollment_response ist nur einer der folgenden Werte zulässig:
phone_session_info

StartMfaPhoneResponseInfo

Bestätigungsinformationen, um das Senden einer SMS zur Bestätigung des Smartphones zu autorisieren.
totp_session_info

StartMfaTotpEnrollmentResponseInfo

Informationen zur Registrierungsantwort, die speziell für die TOTP-Authentifizierung gelten.

StartMfaPhoneRequestInfo

Informationen zur App-Überprüfung für einen StartMfa-Antrag.

Felder
phone_number

string

Für die Registrierung erforderlich. Telefonnummer, die als Bestätigung in zwei Schritten registriert werden soll.
ios_receipt

string

Nur iOS. Erfolgreiche Validierung des App-Tokens mit APNS
ios_secret

string

Nur iOS. Secret wird über APNS an die iOS-App gesendet.
recaptcha_token

string

Nur Web. reCAPTCHA-Lösung
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. 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 Identität der Anwendung anstelle eines reCAPTCHA-Tokens (oder eines Safety Net-Tokens) zu bestätigen. 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

Das reCAPTCHA Enterprise-Token, das von der clientseitigen reCAPTCHA-Integration bereitgestellt wird. Erforderlich, wenn reCAPTCHA Enterprise aktiviert ist.
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. Erforderlich, wenn reCAPTCHA Enterprise aktiviert ist.

StartMfaPhoneResponseInfo

Informationen zur Bestätigung der Telefonnummer für eine StartMfa-Antwort.

Felder
session_info

string

Ein nicht transparenter String, der die Registrierungssitzung darstellt.

StartMfaSignInRequest

Startet die Multi-Faktor-Anmeldung, indem die Multi-Faktor-Authentifizierungsanfrage gesendet wird.

Felder
mfa_pending_credential

string

Pflichtangabe. Anmeldedaten aus der Anmeldung mit dem ersten Faktor ausstehend.
mfa_enrollment_id

string

Pflichtangabe. MFA-Registrierungs-ID aus der Liste der aktuellen MFA-Registrierungen des Nutzers.
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.
Union-Feld sign_in_info. Informationen zur MFA nach Art des zweiten Faktors. Für sign_in_info ist nur einer der folgenden Werte zulässig:
phone_sign_in_info

StartMfaPhoneRequestInfo

Bestätigungsinformationen, um das Senden einer SMS zur Bestätigung des Smartphones zu autorisieren.

StartMfaSignInResponse

StartMfaSignIn-Antwort.

Felder
Union-Feld response_info. MultiFactor start sign-in response by 2nd factor type. Für response_info ist nur einer der folgenden Werte zulässig:
phone_response_info

StartMfaPhoneResponseInfo

Informationen zur Multi-Faktor-Anmeldesitzung, die sich auf zweite Faktoren vom Typ „SMS“ beziehen. Zusammen mit dem Einmalcode, der aus der gesendeten SMS abgerufen wurde, sollten die Inhalte dieser Sitzungsinformationen an FinalizeMfaSignIn übergeben werden, um die Anmeldung abzuschließen.

StartMfaTotpEnrollmentRequestInfo

Dieser Typ hat keine Felder.

Informationen zur MFA-Anfrage, die speziell für die TOTP-Authentifizierung für StartMfa gelten.

StartMfaTotpEnrollmentResponseInfo

Informationen zur MFA-Antwort, die speziell für die TOTP-Authentifizierung für StartMfa gelten.

Felder
shared_secret_key

string

Ein Base32-codierter String, der das gemeinsame TOTP-Secret darstellt.

Die Base32-Codierung ist die in RFC4648#section-6 angegebene Codierung. Das entspricht der Base32-Codierung aus RFC3548#section-5.
verification_code_length

int32

Die Länge des zu generierenden Bestätigungscodes.
hashing_algorithm

string

Der Hash-Algorithmus, der zum Generieren des Bestätigungscodes verwendet wird.
period_sec

int32

Dauer in Sekunden, nach der sich der Bestätigungscode ändert.
session_info

string

Ein codierter String, der die Registrierungssitzung darstellt.
finalize_enrollment_time

Timestamp

Der Zeitpunkt, bis zu dem die Registrierung abgeschlossen sein muss.

WithdrawMfaRequest

MFA wird widerrufen.

Felder
id_token

string

Pflichtangabe. ID-Token des Nutzers.
mfa_enrollment_id

string

Pflichtangabe. MFA-Registrierungs-ID aus einer aktuellen MFA-Registrierung.
tenant_id

string

Die ID des Identity Platform-Mandanten, zu dem der Nutzer gehört, der die Anmeldung mit mehrstufiger Authentifizierung aufhebt. Wenn nicht festgelegt, gehört der Nutzer zum Standard-Identity Platform-Projekt.

WithdrawMfaResponse

Widerruft die Multi-Faktor-Authentifizierungsantwort.

Felder
id_token

string

Das ID-Token wurde aktualisiert, um das Entfernen des zweiten Faktors widerzuspiegeln.
refresh_token

string

Das Aktualisierungstoken wurde aktualisiert, um das Entfernen des zweiten Faktors widerzuspiegeln.