Config

Stellt ein Identity Toolkit-Projekt dar.

JSON-Darstellung 
{
  "name": string,
  "signIn": {
    object (SignInConfig)
  },
  "notification": {
    object (NotificationConfig)
  },
  "quota": {
    object (QuotaConfig)
  },
  "monitoring": {
    object (MonitoringConfig)
  },
  "multiTenant": {
    object (MultiTenantConfig)
  },
  "authorizedDomains": [
    string
  ],
  "subtype": enum (Subtype),
  "client": {
    object (ClientConfig)
  },
  "mfa": {
    object (MultiFactorAuthConfig)
  },
  "blockingFunctions": {
    object (BlockingFunctionsConfig)
  },
  "recaptchaConfig": {
    object (RecaptchaConfig)
  },
  "smsRegionConfig": {
    object (SmsRegionConfig)
  },
  "autodeleteAnonymousUsers": boolean,
  "passwordPolicyConfig": {
    object (PasswordPolicyConfig)
  },
  "emailPrivacyConfig": {
    object (EmailPrivacyConfig)
  },
  "mobileLinksConfig": {
    object (MobileLinksConfig)
  },
  "defaultHostingSite": string
}
Felder
name

string

Nur Ausgabe. Der Name der Config-Ressource. Beispiel: „projects/my-awesome-project/config“
signIn

object (SignInConfig)

Konfiguration im Zusammenhang mit lokalen Anmeldemethoden.
notification

object (NotificationConfig)

Konfiguration zum Senden von Benachrichtigungen an Nutzer.
quota

object (QuotaConfig)

Konfiguration im Zusammenhang mit Kontingenten.
monitoring

object (MonitoringConfig)

Konfiguration im Zusammenhang mit der Überwachung von Projektaktivitäten.
multiTenant

object (MultiTenantConfig)

Konfiguration im Zusammenhang mit der mehrmandantenfähigen Funktion.
authorizedDomains[]

string

Liste der für OAuth-Weiterleitungen autorisierten Domains
subtype

enum (Subtype)

Nur Ausgabe. Der Untertyp dieser Konfiguration.
client

object (ClientConfig)

Optionen zur Konfiguration von Kunden, die Anfragen im Namen eines Projekts stellen.
mfa

object (MultiFactorAuthConfig)

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
blockingFunctions

object (BlockingFunctionsConfig)

Konfiguration im Zusammenhang mit Blockierfunktionen.
recaptchaConfig

object (RecaptchaConfig)

Die reCAPTCHA-Konfiguration auf Projektebene.
smsRegionConfig

object (SmsRegionConfig)

Hiermit wird konfiguriert, welche Regionen für das Senden von SMS-Bestätigungscodes aktiviert sind.
autodeleteAnonymousUsers

boolean

Ob anonyme Nutzer nach 30 Tagen automatisch gelöscht werden.
passwordPolicyConfig

object (PasswordPolicyConfig)

Die Konfiguration der Passwortrichtlinie auf Projektebene.
emailPrivacyConfig

object (EmailPrivacyConfig)

Konfiguration der Einstellungen für den E-Mail-Datenschutz und die öffentliche Sichtbarkeit.
defaultHostingSite

string

Nur Ausgabe. Standardname der Firebase-Hosting-Website

SignInConfig

Konfiguration im Zusammenhang mit lokalen Anmeldemethoden.

JSON-Darstellung 
{
  "email": {
    object (Email)
  },
  "phoneNumber": {
    object (PhoneNumber)
  },
  "anonymous": {
    object (Anonymous)
  },
  "allowDuplicateEmails": boolean,
  "hashConfig": {
    object (HashConfig)
  }
}
Felder
email

object (Email)

Konfigurationsoptionen zur Authentifizierung eines Nutzers anhand seiner E-Mail-Adresse.
phoneNumber

object (PhoneNumber)

Konfigurationsoptionen zur Authentifizierung eines Nutzers über seine Telefonnummer.
anonymous

object (Anonymous)

Konfigurationsoptionen für die Authentifizierung eines anonymen Nutzers.
allowDuplicateEmails

boolean

Ob mehrere Konten dieselbe E-Mail-Adresse haben dürfen.
hashConfig

object (HashConfig)

Nur Ausgabe. Informationen zur Hash-Konfiguration.

E-Mail

Konfigurationsoptionen zur Authentifizierung eines Nutzers anhand seiner E-Mail-Adresse.

JSON-Darstellung 
{
  "enabled": boolean,
  "passwordRequired": boolean
}
Felder
enabled

boolean

Gibt an, ob die E-Mail-Authentifizierung für das Projekt aktiviert ist.
passwordRequired

boolean

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.

PhoneNumber

Konfigurationsoptionen zur Authentifizierung eines Nutzers über seine Telefonnummer.

JSON-Darstellung 
{
  "enabled": boolean,
  "testPhoneNumbers": {
    string: string,
    ...
  }
}
Felder
enabled

boolean

Gibt an, ob die Telefonauthentifizierung für das Projekt aktiviert ist.
testPhoneNumbers

map (key: string, value: string)

Eine Zuordnung von <Testtelefonnummer, Fake-Code>, die für Tests der Telefonauthentifizierung verwendet werden kann.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Anonym

Konfigurationsoptionen für die Authentifizierung eines anonymen Nutzers.

JSON-Darstellung 
{
  "enabled": boolean
}
Felder
enabled

boolean

Gibt an, ob die Authentifizierung für anonyme Nutzer für das Projekt aktiviert ist.

NotificationConfig

Konfiguration zum Senden von Benachrichtigungen an Nutzer.

JSON-Darstellung 
{
  "sendEmail": {
    object (SendEmail)
  },
  "sendSms": {
    object (SendSms)
  },
  "defaultLocale": string
}
Felder
sendEmail

object (SendEmail)

Optionen für das Senden von E-Mails.
sendSms

object (SendSms)

Optionen für das Senden von SMS.
defaultLocale

string

Standard-Gebietsschema für E-Mails und SMS im IETF BCP 47-Format.

SendEmail

Optionen für das Senden von E-Mails.

JSON-Darstellung 
{
  "method": enum (Method),
  "resetPasswordTemplate": {
    object (EmailTemplate)
  },
  "verifyEmailTemplate": {
    object (EmailTemplate)
  },
  "changeEmailTemplate": {
    object (EmailTemplate)
  },
  "legacyResetPasswordTemplate": {
    object (EmailTemplate)
  },
  "callbackUri": string,
  "dnsInfo": {
    object (DnsInfo)
  },
  "revertSecondFactorAdditionTemplate": {
    object (EmailTemplate)
  },

  // Union field email_provider_config can be only one of the following:
  "smtp": {
    object (Smtp)
  }
  // End of list of possible types for union field email_provider_config.
}
Felder
method

enum (Method)

Die Methode, die zum Senden einer E-Mail verwendet wird.
resetPasswordTemplate

object (EmailTemplate)

E-Mail-Vorlage zum Zurücksetzen des Passworts
verifyEmailTemplate

object (EmailTemplate)

E-Mail-Vorlage für die Bestätigung der E-Mail-Adresse
changeEmailTemplate

object (EmailTemplate)

E-Mail-Vorlage für die Änderung der E-Mail-Adresse
legacyResetPasswordTemplate

object (EmailTemplate)

E-Mail-Vorlage zum Zurücksetzen des Passworts für die alte Firebase V1-App.
callbackUri

string

Aktions-URL in der E-Mail-Vorlage
dnsInfo

object (DnsInfo)

Informationen zur DNS-Bestätigung für benutzerdefinierte Domains.
revertSecondFactorAdditionTemplate

object (EmailTemplate)

E-Mail-Vorlage zum Rückgängigmachen von E-Mails zum Hinzufügen eines zweiten Faktors
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

object (Smtp)

Benutzerdefiniertes SMTP-Relay verwenden

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

JSON-Darstellung 
{
  "senderEmail": string,
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "securityMode": enum (SecurityMode)
}
Felder
senderEmail

string

Absender-E-Mail-Adresse für das SMTP-Relay
host

string

SMTP-Relay-Host
port

integer

SMTP-Relay-Port
username

string

SMTP-Relay-Nutzername
password

string

Passwort für das SMTP-Relay
securityMode

enum (SecurityMode)

SMTP-Sicherheitsmodus

SecurityMode

SMTP-Sicherheitsmodus

Enums
SECURITY_MODE_UNSPECIFIED Standardwert. Nicht verwenden.
SSL SSL-Modus
START_TLS START_TLS-Modus

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.

JSON-Darstellung 
{
  "senderLocalPart": string,
  "subject": string,
  "senderDisplayName": string,
  "body": string,
  "bodyFormat": enum (BodyFormat),
  "replyTo": string,
  "customized": boolean
}
Felder
senderLocalPart

string

Lokaler Teil der Absenderadresse
subject

string

Betreff der E-Mail
senderDisplayName

string

Anzeigename des Absenders
body

string

E-Mail-Text
bodyFormat

enum (BodyFormat)

Format des E-Mail-Texts
replyTo

string

Antwortadresse
customized

boolean

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

DnsInfo

Informationen zur DNS-Bestätigung für benutzerdefinierte Domains. Standardmäßig wird „default_domain“ verwendet. Eine benutzerdefinierte Domain kann mit VerifyCustomDomain konfiguriert werden.

JSON-Darstellung 
{
  "customDomain": string,
  "useCustomDomain": boolean,
  "pendingCustomDomain": string,
  "customDomainState": enum (VerificationState),
  "domainVerificationRequestTime": string
}
Felder
customDomain

string

Nur Ausgabe. Die angewendete bestätigte benutzerdefinierte Domain.
useCustomDomain

boolean

Ob eine benutzerdefinierte Domain verwendet werden soll.
pendingCustomDomain

string

Nur Ausgabe. Die benutzerdefinierte Domain, die bestätigt werden soll.
customDomainState

enum (VerificationState)

Nur Ausgabe. Der aktuelle Bestätigungsstatus der benutzerdefinierten Domain. Die benutzerdefinierte Domain wird erst verwendet, wenn die Domainbestätigung erfolgreich war.
domainVerificationRequestTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel der ursprünglichen Anfrage für die aktuelle Domainbestätigung.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

SendSms

Optionen für das Senden von SMS.

JSON-Darstellung 
{
  "useDeviceLocale": boolean,
  "smsTemplate": {
    object (SmsTemplate)
  }
}
Felder
useDeviceLocale

boolean

Gibt an, ob der Header „accept_language“ für SMS verwendet werden soll.
smsTemplate

object (SmsTemplate)

Nur Ausgabe. Die Vorlage, die beim Senden einer SMS verwendet werden soll.

SmsTemplate

Die Vorlage, die beim Senden einer SMS verwendet werden soll.

JSON-Darstellung 
{
  "content": string
}
Felder
content

string

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.

QuotaConfig

Konfiguration im Zusammenhang mit Kontingenten.

JSON-Darstellung 
{
  "signUpQuotaConfig": {
    object (TemporaryQuota)
  }
}
Felder
signUpQuotaConfig

object (TemporaryQuota)

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

JSON-Darstellung 
{
  "quota": string,
  "startTime": string,
  "quotaDuration": string
}
Felder
quota

string (int64 format)

Entspricht dem Feld „refill_token_count“ in der QuotaServer-Konfiguration
startTime

string (Timestamp format)

Wann tritt dieses Kontingent in Kraft?

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
quotaDuration

string (Duration format)

Wie lange dieses Kontingent aktiv ist

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".

MultiTenantConfig

Konfiguration im Zusammenhang mit der mehrmandantenfähigen Funktion.

JSON-Darstellung 
{
  "allowTenants": boolean,
  "defaultTenantLocation": string
}
Felder
allowTenants

boolean

Gibt an, ob dieses Projekt Mandanten haben kann oder nicht.
defaultTenantLocation

string

Die übergeordnete Cloud-Organisation oder der übergeordnete Cloud-Ordner, in der bzw. dem das Mieterprojekt erstellt werden soll. Der Name der übergeordneten Ressource muss das Format /haben, z. B. „ordner/123“ oder „organisationen/456“. Wenn der Wert nicht festgelegt ist, wird der Tenant in derselben Organisation oder im selben Ordner wie das Kundenservicemitarbeiterprojekt erstellt.

Subtyp

Der Untertyp dieser Konfiguration.

Enums
SUBTYPE_UNSPECIFIED Standardwert. Nicht verwenden.
IDENTITY_PLATFORM Ein Identity Platform-Projekt.
FIREBASE_AUTH Ein Firebase Authentication-Projekt

ClientConfig

Optionen zur Konfiguration von Kunden, die Anfragen im Namen eines Projekts stellen.

JSON-Darstellung 
{
  "apiKey": string,
  "permissions": {
    object (Permissions)
  },
  "firebaseSubdomain": string
}
Felder
apiKey

string

Nur Ausgabe. API-Schlüssel, der für Anfragen für dieses Projekt verwendet werden kann.
permissions

object (Permissions)

Konfiguration zur Einschränkung der Möglichkeiten eines Nutzers, sein Konto zu beeinflussen.
firebaseSubdomain

string

Nur Ausgabe. Firebase-Subdomain.

Berechtigungen

Konfiguration zur Einschränkung der Möglichkeiten eines Nutzers, sein Konto zu beeinflussen.

JSON-Darstellung 
{
  "disabledUserSignup": boolean,
  "disabledUserDeletion": boolean
}
Felder
disabledUserSignup

boolean

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

boolean

Wenn „wahr“ festgelegt ist, können Endnutzer ihr Konto im zugehörigen Projekt nicht über eine unserer API-Methoden löschen.

BlockingFunctionsConfig

Konfiguration im Zusammenhang mit Sperrfunktionen.

JSON-Darstellung 
{
  "triggers": {
    string: {
      object (Trigger)
    },
    ...
  },
  "forwardInboundCredentials": {
    object (ForwardInboundCredentials)
  }
}
Felder
triggers

map (key: string, value: object (Trigger))

Zuordnung von Triggern zu Ereignistypen. „key“ muss einer der unterstützten Ereignistypen sein: „beforeCreate“ oder „beforeSignIn“.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
forwardInboundCredentials

object (ForwardInboundCredentials)

Die Anmeldedaten des Nutzers, die in die JWT-Nutzlast aufgenommen werden, die an die registrierten Blockierfunktionen gesendet wird.

Trigger

Synchrone Cloud Functions-Funktion mit HTTP-Trigger

JSON-Darstellung 
{
  "functionUri": string,
  "updateTime": string
}
Felder
functionUri

string

HTTP-URI-Trigger für die Cloud-Funktion.
updateTime

string (Timestamp format)

Wann der Trigger geändert wurde.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

ForwardInboundCredentials

Gibt an, welche Anmeldedaten an die registrierten Blockierfunktionen übergeben werden sollen.

JSON-Darstellung 
{
  "idToken": boolean,
  "accessToken": boolean,
  "refreshToken": boolean
}
Felder
idToken

boolean

Gibt an, ob das ID-Token des OIDC-Identitätsanbieters des Nutzers übergeben werden soll.
accessToken

boolean

Gibt an, ob das Zugriffstoken des OAuth-Identitätsanbieters des Nutzers übergeben werden soll.
refreshToken

boolean

Gibt an, ob das Aktualisierungstoken des OAuth-Identitätsanbieters des Nutzers übergeben werden soll.