Index
ProjectConfigService
(Schnittstelle)TenantManagementService
(Schnittstelle)BlockingFunctionsConfig
(Meldung)BlockingFunctionsConfig.Trigger
(Meldung)ClientConfig
(Meldung)ClientConfig.Permissions
(Meldung)Config
(Meldung)Config.Subtype
(Aufzählung)CreateDefaultSupportedIdpConfigRequest
(Meldung)CreateInboundSamlConfigRequest
(Meldung)CreateOAuthIdpConfigRequest
(Meldung)CreateTenantRequest
(Meldung)DefaultSupportedIdp
(Meldung)DefaultSupportedIdpConfig
(Meldung)DeleteDefaultSupportedIdpConfigRequest
(Meldung)DeleteInboundSamlConfigRequest
(Meldung)DeleteOAuthIdpConfigRequest
(Meldung)DeleteTenantRequest
(Meldung)EnableCicpRequest
(Meldung)EnableCicpResponse
(Meldung)GetConfigRequest
(Meldung)GetDefaultSupportedIdpConfigRequest
(Meldung)GetInboundSamlConfigRequest
(Meldung)GetOAuthIdpConfigRequest
(Meldung)GetTenantRequest
(Meldung)HashConfig
(Meldung)HashConfig.HashAlgorithm
(Aufzählung)IdpCertificate
(Meldung)InboundSamlConfig
(Meldung)InboundSamlConfig.IdpConfig
(Meldung)InboundSamlConfig.SpConfig
(Meldung)ListDefaultSupportedIdpConfigsRequest
(Meldung)ListDefaultSupportedIdpConfigsResponse
(Meldung)ListDefaultSupportedIdpsRequest
(Meldung)ListDefaultSupportedIdpsResponse
(Meldung)ListInboundSamlConfigsRequest
(Meldung)ListInboundSamlConfigsResponse
(Meldung)ListOAuthIdpConfigsRequest
(Meldung)ListOAuthIdpConfigsResponse
(Meldung)ListTenantsRequest
(Meldung)ListTenantsResponse
(Meldung)MonitoringConfig
(Meldung)MonitoringConfig.RequestLogging
(Meldung)MultiFactorAuthConfig
(Meldung)MultiFactorAuthConfig.Provider
(enum)MultiFactorAuthConfig.State
(enum)NotificationConfig
(Meldung)NotificationConfig.SendEmail
(Meldung)NotificationConfig.SendEmail.DnsInfo
(Meldung)NotificationConfig.SendEmail.DnsInfo.VerificationState
(Aufzählung)NotificationConfig.SendEmail.EmailTemplate
(Meldung)NotificationConfig.SendEmail.EmailTemplate.BodyFormat
(enum)NotificationConfig.SendEmail.Method
(enum)NotificationConfig.SendEmail.Smtp
(Meldung)NotificationConfig.SendEmail.Smtp.SecurityMode
(Aufzählung)NotificationConfig.SendSms
(Meldung)NotificationConfig.SendSms.SmsTemplate
(Meldung)OAuthIdpConfig
(Meldung)OAuthIdpConfig.OAuthResponseType
(Meldung)QuotaConfig
(Meldung)QuotaConfig.TemporaryQuota
(Meldung)SignInConfig
(Meldung)SignInConfig.Anonymous
(Meldung)SignInConfig.Email
(Meldung)SignInConfig.PhoneNumber
(Meldung)SpCertificate
(Meldung)Tenant
(Meldung)UpdateConfigRequest
(Meldung)UpdateDefaultSupportedIdpConfigRequest
(Meldung)UpdateInboundSamlConfigRequest
(Meldung)UpdateOAuthIdpConfigRequest
(Meldung)UpdateTenantRequest
(Meldung)VerifyDomainRequest
(Meldung)VerifyDomainRequest.DomainVerificationAction
(Aufzählung)VerifyDomainResponse
(Meldung)
ProjectConfigService
Projektkonfiguration für Identity Toolkit
CreateDefaultSupportedIdpConfig |
---|
Erstellen Sie eine standardmäßig unterstützte IdP-Konfiguration für ein Identity Toolkit-Projekt.
|
CreateInboundSamlConfig |
---|
Erstellen Sie eine eingehende SAML-Konfiguration für ein Identity Toolkit-Projekt.
|
CreateOAuthIdpConfig |
---|
Erstellen Sie eine OIDC-IdP-Konfiguration für ein Identity Toolkit-Projekt.
|
DeleteDefaultSupportedIdpConfig |
---|
Löschen Sie eine standardmäßig unterstützte IdP-Konfiguration für ein Identity Toolkit-Projekt.
|
DeleteInboundSamlConfig |
---|
Eine eingehende SAML-Konfiguration für ein Identity Toolkit-Projekt löschen
|
DeleteOAuthIdpConfig |
---|
OIDC-IdP-Konfiguration für ein Identity Toolkit-Projekt löschen
|
EnableCicp |
---|
Aktivieren Sie CICP für ein Cloud-Projekt. Cloud Identity for Customers and Partners (CICP) ist ein End-to-End-Authentifizierungssystem, mit dem Drittanbieternutzer auf Ihre Apps und Dienste zugreifen können. Dazu gehören z. B. mobile Apps, Web-Apps, Spiele und APIs.
|
GetConfig |
---|
Eine Identity Toolkit-Projektkonfiguration abrufen
|
GetDefaultSupportedIdpConfig |
---|
Eine standardmäßig unterstützte IdP-Konfiguration für ein Identity Toolkit-Projekt abrufen.
|
GetInboundSamlConfig |
---|
Rufen Sie eine eingehende SAML-Konfiguration für ein Identity Toolkit-Projekt ab.
|
GetOAuthIdpConfig |
---|
Rufen Sie eine OIDC-IdP-Konfiguration für ein Identity Toolkit-Projekt ab.
|
ListDefaultSupportedIdpConfigs |
---|
Listet alle standardmäßig unterstützten IdP-Konfigurationen für ein Identity Toolkit-Projekt auf.
|
ListDefaultSupportedIdps |
---|
Liste aller standardmäßig unterstützten Identitätsanbieter auflisten.
|
ListInboundSamlConfigs |
---|
Liste aller eingehenden SAML-Konfigurationen für ein Identity Toolkit-Projekt auflisten
|
ListOAuthIdpConfigs |
---|
Liste aller OIDC-IdP-Konfigurationen für ein Identity Toolkit-Projekt auflisten
|
UpdateConfig |
---|
Aktualisieren Sie eine Identity Toolkit-Projektkonfiguration.
|
UpdateDefaultSupportedIdpConfig |
---|
Aktualisieren Sie eine standardmäßig unterstützte IdP-Konfiguration für ein Identity Toolkit-Projekt.
|
UpdateInboundSamlConfig |
---|
Aktualisieren Sie eine eingehende SAML-Konfiguration für ein Identity Toolkit-Projekt.
|
UpdateOAuthIdpConfig |
---|
Aktualisieren Sie die OIDC-IdP-Konfiguration für ein Identity Toolkit-Projekt.
|
VerifyDomain |
---|
Prüfen Sie, ob die angeforderte benutzerdefinierte Domain die erforderlichen DNS-Einträge hat.
|
TenantManagementService
Mieterverwaltungsdienst für GCIP.
CreateTenant |
---|
Erstellen Sie einen Mandanten. Erfordert Schreibberechtigung für das Agent-Projekt.
|
DeleteTenant |
---|
Mandanten löschen Erfordert Schreibberechtigung für das Agent-Projekt.
|
GetTenant |
---|
Mandanten abrufen Leseberechtigung für die Ressourcen des Tenants erforderlich.
|
ListTenants |
---|
Listen Sie die Kunden unter dem jeweiligen Kundenservicemitarbeiterprojekt auf. Erfordert Leseberechtigung für das Agent-Projekt.
|
UpdateTenant |
---|
Mandanten aktualisieren Erfordert Schreibberechtigung für die Ressourcen des Tenants.
|
BlockingFunctionsConfig
Konfiguration im Zusammenhang mit Blockierfunktionen.
Felder | |
---|---|
triggers |
Zuordnung von Triggern zu Ereignistypen. „key“ muss einer der unterstützten Ereignistypen sein: „beforeCreate“ oder „beforeSignIn“. |
Trigger
Synchrone Cloud Functions-Funktion mit HTTP-Trigger
Felder | |
---|---|
function_uri |
HTTP-URI-Trigger für die Cloud-Funktion. |
update_time |
Wann der Trigger geändert wurde. |
ClientConfig
Optionen zur Konfiguration von Kunden, die Anfragen im Namen eines Projekts stellen.
Felder | |
---|---|
api_key |
Nur Ausgabe. API-Schlüssel, der für Anfragen für dieses Projekt verwendet werden kann. |
permissions |
Konfiguration zur Einschränkung der Möglichkeiten eines Nutzers, Änderungen an seinem Konto vorzunehmen. |
firebase_subdomain |
Nur Ausgabe. Firebase-Subdomain. |
Berechtigungen
Konfiguration zur Einschränkung der Möglichkeiten eines Nutzers, sein Konto zu beeinflussen.
Felder | |
---|---|
disabled_user_signup |
Wenn diese Option aktiviert ist, können Endnutzer sich nicht über eine unserer API-Methoden für ein neues Konto im zugehörigen Projekt registrieren. |
disabled_user_deletion |
Wenn „wahr“ festgelegt ist, können Endnutzer ihr Konto im zugehörigen Projekt nicht über eine unserer API-Methoden löschen. |
Konfiguration
Stellt ein Identity Toolkit-Projekt dar.
Felder | |
---|---|
name |
Nur Ausgabe. Der Name der Config-Ressource. Beispiel: „projects/my-awesome-project/config“ |
sign_in |
Konfiguration im Zusammenhang mit lokalen Anmeldemethoden. |
notification |
Konfiguration zum Senden von Benachrichtigungen an Nutzer. |
quota |
Konfiguration im Zusammenhang mit Kontingenten. |
monitoring |
Konfiguration im Zusammenhang mit der Überwachung von Projektaktivitäten. |
authorized_domains[] |
Liste der für OAuth-Weiterleitungen autorisierten Domains |
subtype |
Nur Ausgabe. Der Untertyp dieser Konfiguration. |
client |
Optionen zur Konfiguration von Kunden, die Anfragen im Namen eines Projekts stellen. |
mfa |
Konfiguration der Multi-Faktor-Authentifizierung für dieses Projekt, einschließlich der Informationen dazu, ob sie aktiv ist und welche Faktoren für den zweiten Faktor verwendet werden können |
blocking_functions |
Konfiguration im Zusammenhang mit Blockierfunktionen. |
Subtyp
Der Untertyp dieser Konfiguration.
Enums | |
---|---|
SUBTYPE_UNSPECIFIED |
Standardwert. Nicht verwenden. |
CUSTOMER_IDENTITY |
Ein Kundenidentitätsprojekt. |
FIREBASE_AUTH |
Ein Firebase Authentication-Projekt |
CreateDefaultSupportedIdpConfigRequest
Anfrage für CreateDefaultSupportedIdpConfig
Felder | |
---|---|
parent |
Der Name der übergeordneten Ressource, in der die Konfiguration erstellt werden soll, z. B. „projects/my-awesome-project“. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
idp_id |
Die ID des Identitätsanbieters, für den eine Konfiguration erstellt werden soll. Rufen Sie „ListDefaultSupportedIdps“ auf, um eine Liste aller standardmäßig unterstützten Identitätsanbieter aufzurufen. |
default_supported_idp_config |
Die Konfigurationsressource, die die Ressource auf dem Server ersetzt. |
CreateInboundSamlConfigRequest
Anfrage für CreateInboundSamlConfig
Felder | |
---|---|
parent |
Der Name der übergeordneten Ressource, in der die Konfiguration erstellt werden soll, z. B. „projects/my-awesome-project“. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
inbound_saml_config_id |
Die ID, die für diese Konfiguration verwendet werden soll. |
inbound_saml_config |
Die zu erstellende Konfigurationsressource. Der Client darf das Feld |
CreateOAuthIdpConfigRequest
Anfrage für CreateOAuthIdpConfig
Felder | |
---|---|
parent |
Der Name der übergeordneten Ressource, in der die Konfiguration erstellt werden soll, z. B. „projects/my-awesome-project“. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
oauth_idp_config_id |
Die ID, die für diese Konfiguration verwendet werden soll. |
oauth_idp_config |
Die zu erstellende Konfigurationsressource. Der Client darf das Feld |
CreateTenantRequest
Anfragenachricht für CreateTenant.
Felder | |
---|---|
parent |
Der Name der übergeordneten Ressource, in der der Tenant erstellt wird. Beispiel: „projects/project1“. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
tenant |
Pflichtangabe. Der zu erstellende Mieter |
DefaultSupportedIdp
Standard-Identity Toolkit-vertrauenswürdige Identitätsanbieter
Felder | |
---|---|
idp_id |
Id des IdP |
description |
Beschreibung des Identitätsanbieters |
DefaultSupportedIdpConfig
Konfigurationsoptionen für die Authentifizierung mit den standardmäßigen Identity Toolkit-vertrauenswürdigen Identitätsanbietern.
Felder | |
---|---|
name |
Der Name der DefaultSupportedIdpConfig-Ressource, z. B. „projects/my-awesome-project/defaultSupportedIdpConfigs/google.com“ |
enabled |
„Wahr“, wenn der Nutzer sich beim Anbieter anmelden kann. |
client_id |
OAuth-Client-ID. |
client_secret |
OAuth-Clientschlüssel |
display_on_cloud_console |
Nur Ausgabe. Gibt an, ob die IdP-Konfiguration in Pantheon angezeigt werden soll, wenn der IdP deaktiviert ist. |
DeleteDefaultSupportedIdpConfigRequest
Anfrage für DeleteDefaultSupportedIdpConfig
Felder | |
---|---|
name |
Der Ressourcenname der Konfiguration, z. B. „projects/my-awesome-project/defaultSupportedIdpConfigs/google.com“. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
DeleteInboundSamlConfigRequest
Anfrage für DeleteInboundSamlConfig
Felder | |
---|---|
name |
Der Ressourcenname der zu löschenden Konfiguration, z. B. „projects/my-awesome-project/inboundSamlConfigs/my-config-id“. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
DeleteOAuthIdpConfigRequest
Anfrage für DeleteOAuthIdpConfig
Felder | |
---|---|
name |
Der Ressourcenname der zu löschenden Konfiguration, z. B. „projects/my-awesome-project/oauthIdpConfigs/oauth-config-id“. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
DeleteTenantRequest
Anfragenachricht für DeleteTenant.
Felder | |
---|---|
name |
Ressourcenname des zu löschenden Mieters. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
EnableCicpRequest
Anfrage für EnableCicp.
Felder | |
---|---|
project |
Der Ressourcenname des Zielprojekts, für das der Entwickler CICP aktivieren möchte. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
EnableCicpResponse
Dieser Typ hat keine Felder.
Antwort für EnableCicp. Noch leer.
GetConfigRequest
Anfrage für GetConfig
Felder | |
---|---|
name |
Der Ressourcenname der Konfiguration, z. B. „projects/my-awesome-project/config“. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
GetDefaultSupportedIdpConfigRequest
Anfrage für GetDefaultSupportedIdpConfig
Felder | |
---|---|
name |
Der Ressourcenname der Konfiguration, z. B. „projects/my-awesome-project/defaultSupportedIdpConfigs/google.com“. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
GetInboundSamlConfigRequest
Anfrage für GetInboundSamlConfig
Felder | |
---|---|
name |
Der Ressourcenname der Konfiguration, z. B. „projects/my-awesome-project/inboundSamlConfigs/my-config-id“. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
GetOAuthIdpConfigRequest
GetOAuthIdpConfig-Anfrage
Felder | |
---|---|
name |
Der Ressourcenname der Konfiguration, z. B. „projects/my-awesome-project/oauthIdpConfigs/oauth-config-id“. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
GetTenantRequest
Anfragenachricht für GetTenant
Felder | |
---|---|
name |
Ressourcenname des zu rufenden Mieters. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
HashConfig
Verlaufsinformationen zum Hash-Algorithmus und zum Schlüssel. Die Passwörter für verschiedene Konten können von verschiedenen Versionen generiert werden.
Felder | |
---|---|
algorithm |
Nur Ausgabe. Unterschiedliche Passwort-Hash-Algorithmen, die in Identity Toolkit verwendet werden |
signer_key |
Nur Ausgabe. Signaturschlüssel in Base64. |
salt_separator |
Nur Ausgabe. Nicht ausdruckbares Zeichen, das zwischen dem Salt und dem Klartextpasswort in Base64 eingefügt werden soll. |
rounds |
Nur Ausgabe. Anzahl der Runden für die Hash-Berechnung. Wird von scrypt und anderen ähnlichen Passwortableitungsalgorithmen verwendet. |
memory_cost |
Nur Ausgabe. Speicherkosten für die Hash-Berechnung. Wird von scrypt und anderen ähnlichen Passwortableitungsalgorithmen verwendet. Eine Erläuterung des Felds finden Sie unter https://tools.ietf.org/html/rfc7914. |
HashAlgorithm
Unterschiedliche Passwort-Hash-Algorithmen, die in Identity Toolkit verwendet werden.
Enums | |
---|---|
HASH_ALGORITHM_UNSPECIFIED |
Standardwert. Nicht verwenden. |
HMAC_SHA256 |
HMAC_SHA256 |
HMAC_SHA1 |
HMAC_SHA1 |
HMAC_MD5 |
HMAC_MD5 |
SCRYPT |
SCRYPT |
PBKDF_SHA1 |
PBKDF_SHA1 |
MD5 |
MD5 |
HMAC_SHA512 |
HMAC_SHA512 |
SHA1 |
SHA1 |
BCRYPT |
BCRYPT |
PBKDF2_SHA256 |
PBKDF2_SHA256 |
SHA256 |
SHA256 |
SHA512 |
SHA512 |
STANDARD_SCRYPT |
STANDARD_SCRYPT |
IdpCertificate
Das Proto für die Zertifikatsdaten des IdP zur Überprüfung der Signatur in der vom IdP ausgestellten SAMLResponse.
Felder | |
---|---|
x509_certificate |
Das X509-Zertifikat |
InboundSamlConfig
Das Proto zum Speichern eines Paars von SAML-RP-IdP-Konfigurationen, wenn das Projekt als vertrauende Partei fungiert.
Felder | |
---|---|
name |
Der Name der InboundSamlConfig-Ressource, z. B. „projects/my-awesome-project/inboundSamlConfigs/my-config-id“. Wird bei Erstellungsanfragen ignoriert. |
idp_config |
Das Proto zum Speichern der SAML-IdP-Konfiguration (Identity Provider), wenn das Projekt als vertrauende Seite fungiert. |
sp_config |
Das Proto zum Speichern der SAML-SP-Konfiguration (Service Provider), wenn das Projekt als vertrauende Partei fungiert, um eine von einem SAML-Identitätsanbieter ausgestellte Authentifizierungsbestätigung zu empfangen und zu akzeptieren. |
display_name |
Der von den Entwicklern festgelegte Anzeigename der Konfiguration. |
enabled |
„Wahr“, wenn der Nutzer sich beim Anbieter anmelden kann. |
IdpConfig
Das Proto zum Speichern der SAML-Identitätsanbieterkonfiguration, wenn das Projekt als vertrauende Seite fungiert.
Felder | |
---|---|
idp_entity_id |
Eindeutige Kennung für alle SAML-Entitäten. |
sso_url |
URL, an die die Authentifizierungsanfrage gesendet werden soll. |
idp_certificates[] |
Öffentliche Schlüssel des IDP zur Überprüfung der Signatur in den Behauptungen. |
sign_request |
Gibt an, ob ausgehende SAML-Anfragen signiert werden sollen. |
SpConfig
Das Proto zum Speichern der SAML-SP-Konfiguration (Service Provider), wenn das Projekt als vertrauende Partei fungiert, um eine von einem SAML-Identitätsanbieter ausgestellte Authentifizierungsbestätigung zu empfangen und zu akzeptieren.
Felder | |
---|---|
sp_entity_id |
Eindeutige Kennung für alle SAML-Entitäten. |
callback_uri |
Callback-URI, unter der Antworten vom IdP verarbeitet werden. |
sp_certificates[] |
Nur Ausgabe. Öffentliche Zertifikate, die vom Server generiert werden, um die Signatur in SAMLRequest im vom SP initiierten Ablauf zu überprüfen. |
ListDefaultSupportedIdpConfigsRequest
Anfrage für ListDefaultSupportedIdpConfigs
Felder | |
---|---|
parent |
Der Name der übergeordneten Ressource, z. B. „projects/my-awesome-project“. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
page_size |
Die maximale Anzahl der Elemente, die zurückzugeben sind. |
page_token |
Der Wert next_page_token wurde gegebenenfalls von einer vorherigen Listenanfrage zurückgegeben. |
ListDefaultSupportedIdpConfigsResponse
Antwort für ListDefaultSupportedIdpConfigs
Felder | |
---|---|
default_supported_idp_configs[] |
Die Konfigurationen. |
next_page_token |
Token zum Abrufen der nächsten Ergebnisseite. Leer, wenn keine weiteren Ergebnisse in der Liste vorhanden sind. |
ListDefaultSupportedIdpsRequest
Anfrage für ListDefaultSupportedIdps
Felder | |
---|---|
page_size |
Die maximale Anzahl der Elemente, die zurückzugeben sind. |
page_token |
Der Wert next_page_token wurde gegebenenfalls von einer vorherigen Listenanfrage zurückgegeben. |
ListDefaultSupportedIdpsResponse
Antwort für ListDefaultSupportedIdps
Felder | |
---|---|
default_supported_idps[] |
Die Konfigurationen. |
next_page_token |
Token zum Abrufen der nächsten Ergebnisseite. Leer, wenn keine weiteren Ergebnisse in der Liste vorhanden sind. |
ListInboundSamlConfigsRequest
Anfrage für ListInboundSamlConfigs
Felder | |
---|---|
parent |
Der Name der übergeordneten Ressource, z. B. „projects/my-awesome-project“. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
page_size |
Die maximale Anzahl der Elemente, die zurückzugeben sind. |
page_token |
Der Wert next_page_token wurde gegebenenfalls von einer vorherigen Listenanfrage zurückgegeben. |
ListInboundSamlConfigsResponse
Antwort für ListInboundSamlConfigs
Felder | |
---|---|
inbound_saml_configs[] |
Die Konfigurationen. |
next_page_token |
Token zum Abrufen der nächsten Ergebnisseite. Leer, wenn keine weiteren Ergebnisse in der Liste vorhanden sind. |
ListOAuthIdpConfigsRequest
Anfrage für ListOAuthIdpConfigs
Felder | |
---|---|
parent |
Der Name der übergeordneten Ressource, z. B. „projects/my-awesome-project“. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
page_size |
Die maximale Anzahl der Elemente, die zurückzugeben sind. |
page_token |
Der Wert next_page_token wurde gegebenenfalls von einer vorherigen Listenanfrage zurückgegeben. |
ListOAuthIdpConfigsResponse
Antwort für ListOAuthIdpConfigs
Felder | |
---|---|
oauth_idp_configs[] |
Die Konfigurationen. |
next_page_token |
Token zum Abrufen der nächsten Ergebnisseite. Leer, wenn keine weiteren Ergebnisse in der Liste vorhanden sind. |
ListTenantsRequest
Anfragenachricht für ListTenants
Felder | |
---|---|
parent |
Pflichtangabe. Der Name der übergeordneten Ressource, für die Mieter aufgelistet werden sollen. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
page_token |
Das Paginierungstoken aus der Antwort einer vorherigen Anfrage. |
page_size |
Die maximale Anzahl der zurückzugebenden Ergebnisse, maximal 1.000. Wenn keine Angabe erfolgt, beträgt der Standardwert 20. |
ListTenantsResponse
Antwortnachricht für ListTenants
Felder | |
---|---|
tenants[] |
Eine Liste der Mandanten im jeweiligen Kundenservicemitarbeiterprojekt. |
next_page_token |
Das Token, mit dem die nächste Ergebnisseite abgerufen wird. |
MonitoringConfig
Konfiguration im Zusammenhang mit der Überwachung von Projektaktivitäten.
Felder | |
---|---|
request_logging |
Konfiguration für das Logging von Anfragen an dieses Projekt in Stackdriver Logging |
RequestLogging
Konfiguration für das Logging von Anfragen an dieses Projekt in Stackdriver Logging
Felder | |
---|---|
enabled |
Gibt an, ob die Protokollierung für dieses Projekt aktiviert ist. |
MultiFactorAuthConfig
Optionen im Zusammenhang mit der Multi-Faktor-Authentifizierung für das Projekt.
Felder | |
---|---|
state |
Gibt an, ob die Multi-Faktor-Authentifizierung für dieses Projekt aktiviert ist. |
enabled_providers[] |
Eine Liste der für dieses Projekt verwendbaren zweiten Faktoren. |
Anbieter
Eine Liste der für dieses Projekt verwendbaren zweiten Faktoren.
Enums | |
---|---|
PROVIDER_UNSPECIFIED |
Illegaler Anbieter, sollte nicht verwendet werden |
PHONE_SMS |
SMS ist für dieses Projekt als zweiter Faktor aktiviert. |
Bundesland
Gibt an, ob die Multi-Faktor-Authentifizierung für dieses Projekt aktiviert ist.
Enums | |
---|---|
STATE_UNSPECIFIED |
Unzulässiger Status, sollte nicht verwendet werden. |
DISABLED |
Die Multi-Faktor-Authentifizierung kann für dieses Projekt nicht verwendet werden |
ENABLED |
Für dieses Projekt kann die Multi-Faktor-Authentifizierung verwendet werden |
ADMIN_ENABLED |
Die Multi-Faktor-Authentifizierung kann für dieses Projekt verwendet werden, aber nur von Projektadministratoren eingerichtet werden. |
NotificationConfig
Konfiguration zum Senden von Benachrichtigungen an Nutzer.
Felder | |
---|---|
send_email |
Optionen für das Senden von E-Mails. |
send_sms |
Optionen für das Senden von SMS. |
default_locale |
Standard-Gebietsschema für E-Mails und SMS im IETF BCP 47-Format. |
SendEmail
Optionen für das Senden von E-Mails.
Felder | |
---|---|
method |
Die Methode, die zum Senden einer E-Mail verwendet wird. |
reset_password_template |
E-Mail-Vorlage zum Zurücksetzen des Passworts |
verify_email_template |
E-Mail-Vorlage für die Bestätigung der E-Mail-Adresse |
change_email_template |
E-Mail-Vorlage für die Änderung der E-Mail-Adresse |
legacy_reset_password_template |
E-Mail-Vorlage zum Zurücksetzen des Passworts für die alte Firebase V1-App. |
callback_uri |
Aktions-URL in der E-Mail-Vorlage |
dns_info |
Informationen zur DNS-Bestätigung für benutzerdefinierte Domains. |
Union-Feld email_provider_config . Die Konfiguration des E-Mail-Anbieters, die zum Senden von E-Mails email_provider_config verwendet wird, kann nur eine der folgenden sein: |
|
smtp |
Benutzerdefiniertes SMTP-Relay verwenden |
DnsInfo
Informationen zur DNS-Bestätigung für benutzerdefinierte Domains. Standardmäßig wird „default_domain“ verwendet. Eine benutzerdefinierte Domain kann mit VerifyCustomDomain konfiguriert werden.
Felder | |
---|---|
custom_domain |
Nur Ausgabe. Die angewendete bestätigte benutzerdefinierte Domain. |
use_custom_domain |
Ob eine benutzerdefinierte Domain verwendet werden soll. |
pending_custom_domain |
Nur Ausgabe. Die benutzerdefinierte Domain, die bestätigt werden soll. |
custom_domain_state |
Nur Ausgabe. Der aktuelle Bestätigungsstatus der benutzerdefinierten Domain. Die benutzerdefinierte Domain wird erst verwendet, wenn die Domainbestätigung erfolgreich war. |
domain_verification_request_time |
Nur Ausgabe. Der Zeitstempel der ursprünglichen Anfrage für die aktuelle Domainbestätigung. |
VerificationState
Der aktuelle Bestätigungsstatus der benutzerdefinierten Domain.
Enums | |
---|---|
VERIFICATION_STATE_UNSPECIFIED |
Standardwert. Nicht verwenden. |
NOT_STARTED |
Die Überprüfung hat noch nicht begonnen. |
IN_PROGRESS |
Die Überprüfung läuft. |
FAILED |
Die Bestätigung ist fehlgeschlagen. |
SUCCEEDED |
Die Bestätigung war erfolgreich und kann angewendet werden. |
EmailTemplate
E-Mail-Vorlage Die Felder „Subject“ (Betreff) und „Body“ (Text) können die folgenden Platzhalter enthalten, die durch die entsprechenden Werte ersetzt werden: %LINK% – Der Link, über den der per E-Mail gesendete OOB-Code eingelöst werden kann. %EMAIL%: Die E-Mail-Adresse, an die die E-Mail gesendet wird. %NEW_EMAIL%: Die neue E-Mail-Adresse, die für das Konto festgelegt wird (falls zutreffend). %APP_NAME% – Der Anzeigename des Google Cloud-Projekts. %DISPLAY_NAME%: Der Anzeigename des Nutzers.
Felder | |
---|---|
sender_local_part |
Lokaler Teil der Absenderadresse |
subject |
Betreff der E-Mail |
sender_display_name |
Anzeigename des Absenders |
body |
E-Mail-Text |
body_format |
Format des E-Mail-Texts |
reply_to |
Antwortadresse |
customized |
Nur Ausgabe. Ob der Text oder Betreff der E-Mail angepasst ist. |
BodyFormat
Format des E-Mail-Texts
Enums | |
---|---|
BODY_FORMAT_UNSPECIFIED |
Standardwert. Nicht verwenden. |
PLAIN_TEXT |
Nur Text |
HTML |
HTML |
Methode
Die Methode, die zum Senden einer E-Mail verwendet wird.
Enums | |
---|---|
METHOD_UNSPECIFIED |
E-Mail-Methode nicht angegeben. |
DEFAULT |
E-Mail wird im Namen des Entwicklers gesendet. |
CUSTOM_SMTP |
E-Mails werden mit der von den Entwicklern bereitgestellten SMTP-Konfiguration gesendet. |
SMTP
Konfiguration für SMTP-Relay
Felder | |
---|---|
sender_email |
Absender-E-Mail-Adresse für das SMTP-Relay |
host |
SMTP-Relay-Host |
port |
SMTP-Relay-Port |
username |
SMTP-Relay-Nutzername |
password |
Passwort für das SMTP-Relay |
security_mode |
SMTP-Sicherheitsmodus |
SecurityMode
SMTP-Sicherheitsmodus
Enums | |
---|---|
SECURITY_MODE_UNSPECIFIED |
Standardwert. Nicht verwenden. |
SSL |
SSL-Modus |
START_TLS |
START_TLS-Modus |
SendSms
Optionen für das Senden von SMS.
Felder | |
---|---|
use_device_locale |
Gibt an, ob der Header „accept_language“ für SMS verwendet werden soll. |
sms_template |
Nur Ausgabe. Die Vorlage, die beim Senden einer SMS verwendet werden soll. |
SmsTemplate
Die Vorlage, die beim Senden einer SMS verwendet werden soll.
Felder | |
---|---|
content |
Nur Ausgabe. Der Inhalt der SMS. Kann die folgenden Platzhalter enthalten, die durch die entsprechenden Werte ersetzt werden: %APP_NAME% – Der Anzeigename der App für Android- oder iOS-Apps. Bei Web-Apps die Domain, auf der die Anwendung gehostet wird. %LOGIN_CODE% – der OOB-Code, der in der SMS gesendet wird. |
OAuthIdpConfig
Konfigurationsoptionen für die Authentifizierung mit einem OAuth-IdP.
Felder | |
---|---|
name |
Der Name der OAuthIdpConfig-Ressource, z. B. „projects/my-awesome-project/oauthIdpConfigs/oauth-config-id“. Wird bei Erstellungsanfragen ignoriert. |
client_id |
Die Client-ID eines OAuth-Clients. |
issuer |
Für OIDC-Identitätsanbieter die Aussteller-ID. |
display_name |
Der von den Entwicklern festgelegte Anzeigename der Konfiguration. |
enabled |
„Wahr“, wenn der Nutzer sich beim Anbieter anmelden kann. |
client_secret |
Der Clientschlüssel des OAuth-Clients, um den OIDC-Codeablauf zu aktivieren. |
response_type |
Der Antworttyp, der im OAuth-Autorisierungsablauf angefordert werden soll. Sie können entweder |
OAuthResponseType
Der Antworttyp, der im OAuth-Autorisierungsablauf angefordert werden soll. Sie können entweder id_token
oder code
auf „wahr“ setzen, aber nicht beide. Die gleichzeitige Einstellung beider Typen auf „wahr“ ({code: true, id_token: true}
) wird noch nicht unterstützt.
Eine Zuordnung des Antworttyps zum OAuth 2.0-Ablauf finden Sie unter https://openid.net/specs/openid-connect-core-1_0.html#Authentication.
Felder | |
---|---|
id_token |
Wenn „wahr“ festgelegt ist, wird das ID-Token vom Autorisierungsendpunkt des IdP zurückgegeben. |
code |
Wenn „wahr“ festgelegt ist, wird der Autorisierungscode vom Autorisierungsendpunkt des IdP zurückgegeben. |
token |
Nicht verwenden. Der Antworttyp |
QuotaConfig
Konfiguration im Zusammenhang mit Kontingenten.
Felder | |
---|---|
sign_up_quota_config |
Kontingent für den Registrierungsendpunkt, falls überschrieben. Das Registrierungskontingent wird in Registrierungen pro Projekt und Stunde und pro IP-Adresse gemessen. |
TemporaryQuota
Temporäre Kontingenterhöhung/-senkung
Felder | |
---|---|
quota |
Entspricht dem Feld „refill_token_count“ in der QuotaServer-Konfiguration |
start_time |
Wann tritt dieses Kontingent in Kraft? |
quota_duration |
Wie lange dieses Kontingent aktiv ist |
SignInConfig
Konfiguration im Zusammenhang mit lokalen Anmeldemethoden.
Felder | |
---|---|
email |
Konfigurationsoptionen zur Authentifizierung eines Nutzers anhand seiner E-Mail-Adresse. |
phone_number |
Konfigurationsoptionen zur Authentifizierung eines Nutzers über seine Telefonnummer. |
anonymous |
Konfigurationsoptionen für die Authentifizierung eines anonymen Nutzers. |
allow_duplicate_emails |
Ob mehrere Konten dieselbe E-Mail-Adresse haben dürfen. |
hash_config |
Nur Ausgabe. Informationen zur Hash-Konfiguration. |
Anonym
Konfigurationsoptionen für die Authentifizierung eines anonymen Nutzers.
Felder | |
---|---|
enabled |
Gibt an, ob die Authentifizierung für anonyme Nutzer für das Projekt aktiviert ist. |
Konfigurationsoptionen zur Authentifizierung eines Nutzers anhand seiner E-Mail-Adresse.
Felder | |
---|---|
enabled |
Gibt an, ob die E-Mail-Authentifizierung für das Projekt aktiviert ist. |
password_required |
Gibt an, ob für die E-Mail-Authentifizierung ein Passwort erforderlich ist oder nicht. Wenn „true“ festgelegt ist, müssen sowohl eine E-Mail-Adresse als auch ein Passwort angegeben werden, um sich anzumelden. Wenn „false“ festgelegt ist, kann sich ein Nutzer entweder über E-Mail-Adresse und Passwort oder über einen E-Mail-Link anmelden. |
hash_config |
Nur Ausgabe. Informationen zur Hash-Konfiguration. |
PhoneNumber
Konfigurationsoptionen zur Authentifizierung eines Nutzers über seine Telefonnummer.
Felder | |
---|---|
enabled |
Gibt an, ob die Telefonauthentifizierung für das Projekt aktiviert ist. |
test_phone_numbers |
Eine Zuordnung von <Testtelefonnummer, Fake-Code>, die für Tests der Telefonauthentifizierung verwendet werden kann. |
SpCertificate
Das Proto für die Zertifikatsdaten des Dienstanbieters für den IdP, um die vom Dienstanbieter generierte SAML-Anfrage zu überprüfen.
Felder | |
---|---|
x509_certificate |
Selbst signiertes öffentliches Zertifikat |
expires_at |
Zeitstempel des Ablaufdatums des Zertifikats. |
Mandant
Ein Mandant enthält die Konfiguration für den Mandanten in einem mehrmandantenfähigen Projekt.
Felder | |
---|---|
name |
Ressourcenname eines Mandanten. Beispiel: „projects/project1/tenants/tenant1“ |
display_name |
Anzeigename des Mandanten. |
saml_configs[] |
SAML-Konfigurationen angefordert. |
idp_configs[] |
IdP-Konfigurationen angefordert. |
allow_password_signup |
Gibt an, ob die Anmeldung per E-Mail-Adresse und Passwort zulässig ist. |
enable_email_link_signin |
Gibt an, ob die Registrierung über einen E-Mail-Link aktiviert werden soll. |
disable_auth |
Gibt an, ob die Authentifizierung für den Mandanten deaktiviert ist. Die Nutzer des deaktivierten Kontos können sich nicht anmelden. Administratoren des deaktivierten Mandanten können seine Nutzer nicht mehr verwalten. |
UpdateConfigRequest
Anfrage für UpdateConfig
Felder | |
---|---|
config |
Die Konfigurationsressource, die die Ressource auf dem Server ersetzt. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
update_mask |
Die Aktualisierungsmaske gilt für die Ressource. Felder, die in der Konfiguration festgelegt, aber nicht in dieser Aktualisierungsmaske enthalten sind, werden ignoriert. Informationen zur |
UpdateDefaultSupportedIdpConfigRequest
Anfrage für UpdateDefaultSupportedIdpConfig
Felder | |
---|---|
default_supported_idp_config |
Die Konfigurationsressource, die die Ressource auf dem Server ersetzt. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
update_mask |
Die Aktualisierungsmaske gilt für die Ressource. Informationen zur |
UpdateInboundSamlConfigRequest
Anfrage für UpdateInboundSamlConfig
Felder | |
---|---|
inbound_saml_config |
Die Konfigurationsressource, die die Ressource auf dem Server ersetzt. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
update_mask |
Die Aktualisierungsmaske gilt für die Ressource. Eine leere Aktualisierungsmaske führt dazu, dass nichts aktualisiert wird. Informationen zur |
UpdateOAuthIdpConfigRequest
Anfrage für UpdateOAuthIdpConfig
Felder | |
---|---|
oauth_idp_config |
Die Konfigurationsressource, die die Ressource auf dem Server ersetzt. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
update_mask |
Die Aktualisierungsmaske gilt für die Ressource. Eine leere Aktualisierungsmaske führt dazu, dass nichts aktualisiert wird. Informationen zur |
UpdateTenantRequest
Anfragenachricht für UpdateTenant.
Felder | |
---|---|
tenant |
Pflichtangabe. Der zu aktualisierende Tenant. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
update_mask |
Die Aktualisierungsmaske gilt für die Ressource. Informationen zur |
VerifyDomainRequest
Anfrage, um zu bestätigen, dass die angeforderte benutzerdefinierte Domain die erforderlichen DNS-Einträge hat.
Felder | |
---|---|
resource |
Der Name der Ressource, für die die Domain bestätigt werden soll. Mit dieser Methode können derzeit Domains für Projekte (z. B. „projects/my-awesome-project“) oder für Kunden (z. B. „projects/my-awesome-project/tenants/my-awesome-tenant“) bestätigt werden. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource
|
domain |
Die Zieldomain dieser Anfrage. |
action |
Die Aktion, die auf der angegebenen Domain versucht wird. |
DomainVerificationAction
Die Aktion, die auf der angegebenen Domain versucht wird.
Enums | |
---|---|
DOMAIN_VERIFICATION_ACTION_UNSPECIFIED |
Standardwert. Nicht verwenden. |
VERIFY |
Bestätige die Domain in der Anfrage. |
CANCEL |
Brechen Sie den aktuellen Bestätigungsvorgang ab. |
APPLY |
Benutzerdefinierte Domain beim Senden von E-Mails anwenden |
VerifyDomainResponse
Antwort auf die VerifyDomain-Anfrage.
Felder | |
---|---|
verification_state |
Der resultierende Status für die angegebene Domain nach der Verarbeitung dieser Anfrage. |
verification_error |
Gegebenenfalls eine textliche Erklärung, warum die Domain nicht bestätigt werden konnte. |