Reprezentuje konfigurację dzierżawy.
Obsługa wielu dzierżaw wymaga platformy tożsamości Google Cloud (GCIP). Aby dowiedzieć się więcej o GCIP, w tym o cenach i funkcjach, zapoznaj się z dokumentacją GCIP .
Zanim w projekcie Google Cloud Identity Platform będzie można używać wielu dzierżawców, należy zezwolić dzierżawcom na udział w tym projekcie za pośrednictwem interfejsu użytkownika Cloud Console.
Konfiguracja dzierżawy udostępnia informacje, takie jak nazwa wyświetlana, identyfikator dzierżawy i konfiguracja uwierzytelniania poczty e-mail. W przypadku zarządzania konfiguracją dostawcy OIDC/SAML należy używać instancji TenantAwareAuth
zamiast Tenant
w celu pobrania listy skonfigurowanych dostawców tożsamości w dzierżawie. Podczas konfigurowania tych dostawców należy pamiętać, że dzierżawcy będą dziedziczyć domeny umieszczone na białej liście i uwierzytelnione identyfikatory URI przekierowań swojego projektu nadrzędnego.
Wszystkie inne ustawienia dzierżawcy również zostaną odziedziczone. Należy nimi zarządzać w interfejsie Cloud Console.
Podpis:
export declare class Tenant
Nieruchomości
Nieruchomość | Modyfikatory | Typ | Opis |
---|---|---|---|
anonimowe logowanie włączone | wartość logiczna | ||
wyświetlana nazwa | strunowy | Nazwa wyświetlana dzierżawy. | |
e-mailPrivacyConfig | Konfiguracja prywatności poczty e-mail | Konfiguracja prywatności poczty e-mail dla dzierżawcy | |
e-mailSignInConfig | EmailSignInProviderConfig | nieokreślony | Konfiguracja dostawcy logowania do poczty e-mail. | |
konfiguracja multiFactor | Konfiguracja MultiFactor | nieokreślony | Konfiguracja uwierzytelniania wieloskładnikowego w bieżącej dzierżawie. | |
hasłoPolicyConfig | HasłoPolicyConfig | Konfiguracja zasad haseł dla dzierżawy | |
recaptchaConfig | Konfiguracja Recaptcha | nieokreślony | Konfiguracja uwierzytelniania konfiguracji recaptcha bieżącego dzierżawcy. | |
smsRegionConfig | Konfiguracja SmsRegion | Konfiguracja regionów programu SMS w celu zaktualizowania dzierżawy. Konfiguruje regiony, w których użytkownicy mogą wysyłać weryfikacyjne wiadomości SMS. Opiera się to na kodzie wywołującym docelowego numeru telefonu. | |
identyfikator najemcy | strunowy | Identyfikator dzierżawy. | |
testoweNumery Telefonu | { [Numer telefonu: ciąg]: ciąg; } | Mapa zawierająca testowy numer telefonu/pary kodów dla najemcy. |
Metody
metoda | Modyfikatory | Opis |
---|---|---|
doJSON() | Zwraca reprezentację tego obiektu nadającą się do serializacji w formacie JSON. |
Tenant.anonymousSignInEnabled
Podpis:
readonly anonymousSignInEnabled: boolean;
Nazwa wyświetlana najemcy
Nazwa wyświetlana dzierżawy.
Podpis:
readonly displayName?: string;
Tenant.emailPrivacyConfig
Konfiguracja prywatności poczty e-mail dla dzierżawcy
Podpis:
readonly emailPrivacyConfig?: EmailPrivacyConfig;
Tenant.emailSignInConfig
Konfiguracja dostawcy logowania do poczty e-mail.
Podpis:
get emailSignInConfig(): EmailSignInProviderConfig | undefined;
Tenant.multiFactorConfig
Konfiguracja uwierzytelniania wieloskładnikowego w bieżącej dzierżawie.
Podpis:
get multiFactorConfig(): MultiFactorConfig | undefined;
Tenant.passwordPolicyConfig
Konfiguracja zasad haseł dla dzierżawy
Podpis:
readonly passwordPolicyConfig?: PasswordPolicyConfig;
Tenant.recaptchaConfig
Konfiguracja uwierzytelniania konfiguracji recaptcha bieżącego dzierżawcy.
Podpis:
get recaptchaConfig(): RecaptchaConfig | undefined;
Tenant.smsRegionConfig
Konfiguracja regionów programu SMS w celu zaktualizowania dzierżawy. Konfiguruje regiony, w których użytkownicy mogą wysyłać weryfikacyjne wiadomości SMS. Opiera się to na kodzie wywołującym docelowego numeru telefonu.
Podpis:
readonly smsRegionConfig?: SmsRegionConfig;
Tenant.tenantId
Identyfikator dzierżawy.
Podpis:
readonly tenantId: string;
Tenant.testPhoneNumbers
Mapa zawierająca testowy numer telefonu/pary kodów dla najemcy.
Podpis:
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Najemca.do JSON()
Zwraca reprezentację tego obiektu nadającą się do serializacji w formacie JSON.
Podpis:
toJSON(): object;
Zwroty:
obiekt
Reprezentacja tego obiektu możliwa do serializacji w formacie JSON.