Kiracı yapılandırmasını temsil eder.
Çoklu kiracılık desteği, Google Cloud'un Kimlik Platformunu (GCIP) gerektirir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerine bakın. .
Çoklu kiracılığın bir Google Cloud Identity Platform projesinde kullanılabilmesi için önce Cloud Console kullanıcı arayüzü aracılığıyla o projede kiracılara izin verilmesi gerekir.
Kiracı yapılandırması, görünen ad, kiracı tanımlayıcısı ve e-posta kimlik doğrulama yapılandırması gibi bilgiler sağlar. OIDC/SAML sağlayıcı yapılandırma yönetimi için, kiracıdaki yapılandırılmış IdP'lerin listesini almak üzere Tenant yerine TenantAwareAuth örnekleri kullanılmalıdır. Bu sağlayıcıları yapılandırırken kiracıların, üst projelerinin beyaz listeye alınmış etki alanlarını ve kimliği doğrulanmış yönlendirme URI'lerini devralacağını unutmayın.
Kiracının diğer tüm ayarları da devralınır. Bunların Cloud Console kullanıcı arayüzünden yönetilmesi gerekecektir.
İmza:
export declare class Tenant
Özellikler
| Mülk | Değiştiriciler | Tip | Tanım |
|---|---|---|---|
| anonimSignInEnabled | boolean | ||
| ekran adı | sicim | Kiracının görünen adı. | |
| e-postaGizlilikYapılandırması | 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 | MultiFactorYapılandırma | Tanımsız | Geçerli kiracıdaki çok faktörlü kimlik doğrulama yapılandırması. | |
| şifrePolicyConfig | Şifre Politikası Yapılandırması | Kiracı için parola ilkesi yapılandırması | |
| recaptchaConfig | RecaptchaYapılandırması | Tanımsız | Geçerli kiracının recaptcha config kimlik doğrulama yapılandırması. | |
| smsRegionConfig | SmsRegionConfig | Kiracıyı güncellemek için SMS Bölgeleri Yapılandırması. Kullanıcıların doğrulama SMS'i göndermesine izin verilen bölgeleri yapılandırır. Bu, hedef telefon numarasının arama koduna dayanmaktadır. | |
| kiracı kimliği | sicim | Kiracı tanımlayıcısı. | |
| testTelefonNumaraları | { [telefonNumarası: string]: string; } | Kiracının test telefon numarasını/kod çiftlerini içeren harita. |
Yöntemler
| Yöntem | Değiştiriciler | Tanım |
|---|---|---|
| JSON()'a | Bu nesnenin JSON ile seri hale getirilebilir gösterimini döndürür. |
Tenant.anonymousSignInEnabled
İmza:
readonly anonymousSignInEnabled: boolean;
Kiracı.görünenAdı
Kiracının görünen adı.
İmza:
readonly displayName?: string;
Tenant.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;
Tenant.multiFactorConfig
Geçerli kiracıdaki çok faktörlü kimlik doğrulama yapılandırması.
İmza:
get multiFactorConfig(): MultiFactorConfig | undefined;
Tenant.passwordPolicyConfig
Kiracı için parola ilkesi yapılandırması
İmza:
readonly passwordPolicyConfig?: PasswordPolicyConfig;
Kiracı.recaptchaConfig
Geçerli kiracının recaptcha config kimlik doğrulama yapılandırması.
İmza:
get recaptchaConfig(): RecaptchaConfig | undefined;
Tenant.smsRegionConfig
Kiracıyı güncellemek için SMS Bölgeleri Yapılandırması. Kullanıcıların doğrulama SMS'i göndermesine izin verilen bölgeleri yapılandırır. Bu, hedef telefon numarasının arama koduna dayanmaktadır.
İmza:
readonly smsRegionConfig?: SmsRegionConfig;
Kiracı.kiracıId
Kiracı tanımlayıcısı.
İmza:
readonly tenantId: string;
Tenant.testPhoneNumbers
Kiracının test telefon numarasını/kod çiftlerini içeren harita.
İmza:
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Kiracı.toJSON()
Bu nesnenin JSON ile seri hale getirilebilir gösterimini döndürür.
İmza:
toJSON(): object;
İadeler:
nesne
Bu nesnenin JSON ile serileştirilebilir temsili.