Kiracı yapılandırmasını temsil eder.
Çok kiracılı destek için Google Cloud Identity Platform (GCIP) gereklidir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP dokümanlarına bakın.
Bir Google Cloud Identity Platform projesinde çok kiracılı kümenin kullanılabilmesi için öncelikle Cloud Console kullanıcı arayüzü üzerinden söz konusu projede kiracılara izin verilmelidir.
Kiracı yapılandırması; görünen ad, kiracı tanımlayıcısı ve e-posta kimlik doğrulaması yapılandırması gibi bilgiler sağlar. OIDC/SAML sağlayıcı yapılandırma yönetiminde, kiracıdaki yapılandırılmış IdP'lerin listesini almak için Tenant yerine TenantAwareAuth örnekleri kullanılmalıdır. Bu sağlayıcıları yapılandırırken kiracıların üst projelerinin beyaz listeye eklenen alanlarını ve kimliği doğrulanmış yönlendirme URI'lerini devralacağını unutmayın.
Bir kiracının diğer tüm ayarları da devralınır. Bunların Cloud Console kullanıcı arayüzünden yönetilmesi gerekir.
İmza:
export declare class Tenant
Özellikler
| Özellik | Değiştiriciler | Tür | Açıklama |
|---|---|---|---|
| anonymousSignInEnabled | boolean | ||
| görünenAd | dize | Görünen kiracı adı. | |
| emailPrivacyConfig | EmailPrivacyConfig | Kiracı için e-posta gizlilik yapılandırması | |
| emailSignInConfig | EmailSignInProviderConfig | tanımsız | E-posta oturum açma sağlayıcısı yapılandırması. | |
| multiFactorConfig | MultiFactorConfig | tanımsız | Mevcut kiracıdaki çok öğeli kimlik doğrulaması yapılandırması. | |
| passwordPolicyConfig | PasswordPolicyConfig | Kiracı için şifre politikası yapılandırması | |
| recaptchaConfig | RecaptchaConfig | tanımsız | Mevcut kiracının reCAPTCHA config kimlik doğrulaması yapılandırması. | |
| smsRegionConfig | SmsRegionConfig | Bir kiracıyı güncellemek için SMS Regions Config. Kullanıcıların doğrulama SMS'i göndermesine izin verilen bölgeleri yapılandırır. Bu değer, hedef telefon numarasının arama koduna göre belirlenir. | |
| kiracıNo | dize | Kiracı tanımlayıcısı. | |
| testPhoneNumbers | { [phoneNumber: string]: string; } | Kiracının test telefon numarasını / kod çiftlerini içeren harita. |
Yöntemler
| Yöntem | Değiştiriciler | Açıklama |
|---|---|---|
| toJSON() | Bu nesnenin JSON'de seri hale getirilebilir bir temsilini döndürür. |
Tenant.anonymousSignInEnabled
İmza:
readonly anonymousSignInEnabled: boolean;
Kiracı.görünenAdı
Görünen kiracı adı.
İmza:
readonly displayName?: string;
Kiracı.emailPrivacyConfig
Kiracı için e-posta gizlilik yapılandırması
İmza:
readonly emailPrivacyConfig?: EmailPrivacyConfig;
Tenant.emailSignInConfig
E-posta oturum açma sağlayıcısı yapılandırması.
İmza:
get emailSignInConfig(): EmailSignInProviderConfig | undefined;
Kiracı.multiFactorConfig
Mevcut kiracıdaki çok öğeli kimlik doğrulaması yapılandırması.
İmza:
get multiFactorConfig(): MultiFactorConfig | undefined;
Kiracı.passwordPolicyConfig
Kiracı için şifre politikası yapılandırması
İmza:
readonly passwordPolicyConfig?: PasswordPolicyConfig;
Kiracı.recaptchaConfig
Mevcut kiracının reCAPTCHA config kimlik doğrulaması yapılandırması.
İmza:
get recaptchaConfig(): RecaptchaConfig | undefined;
Kiracı.smsRegionConfig
Bir kiracıyı güncellemek için SMS Regions Config. Kullanıcıların doğrulama SMS'i göndermesine izin verilen bölgeleri yapılandırır. Bu değer, hedef telefon numarasının arama koduna göre belirlenir.
İmza:
readonly smsRegionConfig?: SmsRegionConfig;
Kiracı.KiracıNo
Kiracı tanımlayıcısı.
İmza:
readonly tenantId: string;
Kiracı.testPhoneNumbers
Kiracının test telefon numarasını / kod çiftlerini içeren harita.
İmza:
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Kiracı.toJSON()
Bu nesnenin JSON'de seri hale getirilebilir bir temsilini döndürür.
İmza:
toJSON(): object;
Şunu döndürür:
nesne
Bu nesnenin JSON'de seri hale getirilebilir bir temsili.