Stellt eine Mandantenkonfiguration dar.
Für die Mandantenfähigkeitsunterstützung ist die Identity Platform (GCIP) von Google Cloud erforderlich. Weitere Informationen zu GCIP, einschließlich Preisen und Funktionen, finden Sie in der GCIP-Dokumentation .
Bevor die Mandantenfähigkeit in einem Google Cloud Identity Platform-Projekt verwendet werden kann, müssen Mandanten über die Cloud Console-Benutzeroberfläche für dieses Projekt zugelassen werden.
Eine Mandantenkonfiguration stellt Informationen wie den Anzeigenamen, die Mandantenkennung und die E-Mail-Authentifizierungskonfiguration bereit. Für die Konfigurationsverwaltung des OIDC/SAML-Anbieters sollten TenantAwareAuth Instanzen anstelle eines Tenant verwendet werden, um die Liste der konfigurierten IdPs auf einem Mandanten abzurufen. Beachten Sie bei der Konfiguration dieser Anbieter, dass Mandanten Domänen auf der Whitelist und authentifizierte Umleitungs-URIs ihres übergeordneten Projekts erben.
Alle anderen Einstellungen eines Mandanten werden ebenfalls übernommen. Diese müssen über die Cloud Console-Benutzeroberfläche verwaltet werden.
Unterschrift:
export declare class Tenant
Eigenschaften
| Eigentum | Modifikatoren | Typ | Beschreibung |
|---|---|---|---|
| anonymSignInEnabled | Boolescher Wert | ||
| Anzeigename | Zeichenfolge | Der Anzeigename des Mandanten. | |
| emailPrivacyConfig | EmailPrivacyConfig | Die E-Mail-Datenschutzkonfiguration für den Mandanten | |
| emailSignInConfig | EmailSignInProviderConfig | nicht definiert | Die Konfiguration des E-Mail-Anmeldeanbieters. | |
| multiFactorConfig | MultiFactorConfig | nicht definiert | Die Multi-Faktor-Authentifizierungskonfiguration für den aktuellen Mandanten. | |
| passwortPolicyConfig | PasswordPolicyConfig | Die Passwortrichtlinienkonfiguration für den Mandanten | |
| recaptchaConfig | RecaptchaConfig | nicht definiert | Die Recaptcha-Konfigurationsauthentifizierungskonfiguration des aktuellen Mandanten. | |
| smsRegionConfig | SMSRegionConfig | Die SMS-Regionskonfiguration zum Aktualisieren eines Mandanten. Konfiguriert die Regionen, in denen Benutzer Bestätigungs-SMS senden dürfen. Dies basiert auf der Rufvorwahl der Zielrufnummer. | |
| Mieter-ID | Zeichenfolge | Die Mandanten-ID. | |
| testPhoneNumbers | { [phoneNumber: string]: string; } | Die Karte mit den Testtelefonnummern/Code-Paaren für den Mieter. |
Methoden
| Methode | Modifikatoren | Beschreibung |
|---|---|---|
| toJSON() | Gibt eine JSON-serialisierbare Darstellung dieses Objekts zurück. |
Tenant.anonymousSignInEnabled
Unterschrift:
readonly anonymousSignInEnabled: boolean;
Tenant.displayName
Der Anzeigename des Mandanten.
Unterschrift:
readonly displayName?: string;
Tenant.emailPrivacyConfig
Die E-Mail-Datenschutzkonfiguration für den Mandanten
Unterschrift:
readonly emailPrivacyConfig?: EmailPrivacyConfig;
Tenant.emailSignInConfig
Die Konfiguration des E-Mail-Anmeldeanbieters.
Unterschrift:
get emailSignInConfig(): EmailSignInProviderConfig | undefined;
Tenant.multiFactorConfig
Die Multi-Faktor-Authentifizierungskonfiguration für den aktuellen Mandanten.
Unterschrift:
get multiFactorConfig(): MultiFactorConfig | undefined;
Tenant.passwordPolicyConfig
Die Passwortrichtlinienkonfiguration für den Mandanten
Unterschrift:
readonly passwordPolicyConfig?: PasswordPolicyConfig;
Tenant.recaptchaConfig
Die Recaptcha-Konfigurationsauthentifizierungskonfiguration des aktuellen Mandanten.
Unterschrift:
get recaptchaConfig(): RecaptchaConfig | undefined;
Tenant.smsRegionConfig
Die SMS-Regionskonfiguration zum Aktualisieren eines Mandanten. Konfiguriert die Regionen, in denen Benutzer Bestätigungs-SMS senden dürfen. Dies basiert auf der Rufvorwahl der Zielrufnummer.
Unterschrift:
readonly smsRegionConfig?: SmsRegionConfig;
Tenant.tenantId
Die Mandanten-ID.
Unterschrift:
readonly tenantId: string;
Tenant.testPhoneNumbers
Die Karte mit den Testtelefonnummern/Code-Paaren für den Mieter.
Unterschrift:
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Tenant.toJSON()
Gibt eine JSON-serialisierbare Darstellung dieses Objekts zurück.
Unterschrift:
toJSON(): object;
Kehrt zurück:
Objekt
Eine JSON-serialisierbare Darstellung dieses Objekts.