Reprezentuje konfigurację najemcy.
Obsługa środowiska wielu najemców wymaga Google Cloud Identity Platform (GCIP). Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS.
Aby móc używać środowiska wielu najemców w projekcie Google Cloud Identity Platform, musisz zezwolić na najemców w tym projekcie w interfejsie konsoli Cloud.
Konfiguracja najemcy dostarcza informacji takich jak wyświetlana nazwa, identyfikator najemcy i konfiguracja uwierzytelniania poczty e-mail. W przypadku zarządzania konfiguracją dostawcy OIDC/SAML do pobrania listy skonfigurowanych dostawców tożsamości u najemcy należy używać instancji TenantAwareAuth zamiast Tenant. Konfigurując tych dostawców, pamiętaj, że najemcy odziedziczą białą listę domen i uwierzytelnione identyfikatory URI przekierowania z projektu nadrzędnego.
Zostaną też odziedziczone wszystkie pozostałe ustawienia najemcy. Należy nimi zarządzać z poziomu interfejsu Cloud Console.
Podpis:
export declare class Tenant
Właściwości
| Właściwość | Modyfikatory | Typ | Opis |
|---|---|---|---|
| anonymousSignInEnabled | wartość logiczna | ||
| nazwawyświetlana | ciąg znaków | Wyświetlana nazwa najemcy. | |
| emailPrivacyConfig | EmailPrivacyConfig | Konfiguracja prywatności poczty e-mail dla najemcy | |
| emailSignInConfig | EmailSignInProviderConfig | nie zdefiniowano | Konfiguracja dostawcy logowania za pomocą adresu e-mail. | |
| multiFactorConfig, | MultiFactorConfig | nie zdefiniowano | Konfiguracja uwierzytelniania wielopoziomowego dla bieżącego najemcy. | |
| passwordPolicyConfig, | PasswordPolicyConfig, | Konfiguracja zasad dotyczących haseł dla najemcy | |
| recaptchaConfig | RecaptchaConfig | nie zdefiniowano | Konfiguracja uwierzytelniania konfiguracji reCAPTCHA bieżącego najemcy. | |
| Konfiguracja regionu sms | Konfiguracja regionu SMS-ów | Konfiguracja regionów SMS-ów do aktualizacji najemcy. Konfiguruje regiony, z których użytkownicy mogą wysyłać weryfikacyjne SMS-y. który zależy od kodu kierunkowego docelowego numeru telefonu. | |
| tenantId, | ciąg znaków | Identyfikator najemcy. | |
| testPhoneNumbers, | { [phoneNumber: string]: string; | Mapa zawierająca testowe pary numeru telefonu i kodu najemcy. |
Metody
| Metoda | Modyfikatory | Opis |
|---|---|---|
| toJSON(), | Zwraca możliwą do serializowania reprezentację tego obiektu w formacie JSON. |
Tenant.anonymousSignInEnabled
Podpis:
readonly anonymousSignInEnabled: boolean;
Najemca.wyświetlanaNazwa
Wyświetlana nazwa najemcy.
Podpis:
readonly displayName?: string;
Konfiguracja prywatności e-maila najemcy
Konfiguracja prywatności poczty e-mail dla najemcy
Podpis:
readonly emailPrivacyConfig?: EmailPrivacyConfig;
Konfiguracja logowania e-mail najemcy
Konfiguracja dostawcy logowania za pomocą adresu e-mail.
Podpis:
get emailSignInConfig(): EmailSignInProviderConfig | undefined;
Konfiguracja najemcy.multiFactor
Konfiguracja uwierzytelniania wielopoziomowego dla bieżącego najemcy.
Podpis:
get multiFactorConfig(): MultiFactorConfig | undefined;
Konfiguracja zasad najemcy
Konfiguracja zasad dotyczących haseł dla najemcy
Podpis:
readonly passwordPolicyConfig?: PasswordPolicyConfig;
Konfiguracja najemcy.recaptchaConfig
Konfiguracja uwierzytelniania konfiguracji reCAPTCHA bieżącego najemcy.
Podpis:
get recaptchaConfig(): RecaptchaConfig | undefined;
Konfiguracja regionu najemcy.sms
Konfiguracja regionów SMS-ów do aktualizacji najemcy. Konfiguruje regiony, z których użytkownicy mogą wysyłać weryfikacyjne SMS-y. który zależy od kodu kierunkowego docelowego numeru telefonu.
Podpis:
readonly smsRegionConfig?: SmsRegionConfig;
Identyfikator najemcy.
Identyfikator najemcy.
Podpis:
readonly tenantId: string;
Numer telefonu najemcy.testowego
Mapa zawierająca testowe pary numeru telefonu i kodu najemcy.
Podpis:
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Tenant.toJSON()
Zwraca możliwą do serializowania reprezentację tego obiektu w formacie JSON.
Podpis:
toJSON(): object;
Zwroty:
Obiekt
Możliwa do serializowania reprezentacja tego obiektu w formacie JSON.