Merepresentasikan konfigurasi tenant.
Dukungan multi-tenancy memerlukan Identity Platform (GCIP) Google Cloud. Untuk mempelajari GCIP lebih lanjut, termasuk harga dan fitur, lihat dokumentasi GCIP.
Sebelum multi-tenancy dapat digunakan di project Google Cloud Identity Platform, tenant harus diizinkan di project tersebut melalui UI Konsol Cloud.
Konfigurasi tenant memberikan informasi seperti nama tampilan, ID tenant, dan konfigurasi autentikasi email. Untuk pengelolaan konfigurasi penyedia OIDC/SAML, instance TenantAwareAuth harus digunakan sebagai pengganti Tenant untuk mengambil daftar IdP yang dikonfigurasi pada tenant. Saat mengonfigurasi penyedia ini, perhatikan bahwa tenant akan mewarisi domain yang diizinkan dan URI pengalihan yang diautentikasi dari project induknya.
Semua setelan tenant lainnya juga akan diwarisi. Keduanya harus dikelola dari UI Cloud Console.
Tanda Tangan:
export declare class Tenant
Properti
| Properti | Pengubah | Jenis | Deskripsi |
|---|---|---|---|
| anonymousSignInEnabled | boolean | ||
| namatampilan | string | Nama tampilan tenant. | |
| emailPrivacyConfig | EmailPrivacyConfig | Konfigurasi privasi email untuk tenant | |
| emailSignInConfig | EmailSignInProviderConfig | tidak ditentukan | Konfigurasi penyedia login email. | |
| multiFactorConfig | MultiFactorConfig | tidak ditentukan | Konfigurasi autentikasi multi-faktor pada tenant saat ini. | |
| passwordPolicyConfig | PasswordPolicyConfig | Konfigurasi kebijakan sandi untuk tenant | |
| recaptchaConfig | RecaptchaConfig | tidak ditentukan | Konfigurasi autentikasi konfigurasi recaptcha dari tenant saat ini. | |
| smsRegionConfig | SmsRegionConfig | Konfigurasi Wilayah SMS untuk mengupdate tenant. Mengonfigurasi wilayah tempat pengguna diizinkan untuk mengirim SMS verifikasi. Hal ini didasarkan pada kode panggilan dari nomor telepon tujuan. | |
| tenantId | string | ID tenant. | |
| testPhoneNumber | { [phoneNumber: string]: string; } | Peta yang berisi pasangan kode / nomor telepon pengujian untuk tenant. |
Metode
| Metode | Pengubah | Deskripsi |
|---|---|---|
| toJSON() | Menampilkan representasi JSON-serial yang dapat diserialisasi dari objek ini. |
Tenant.anonymousSignInEnabled
Tanda Tangan:
readonly anonymousSignInEnabled: boolean;
Tenant.namadisplay
Nama tampilan tenant.
Tanda Tangan:
readonly displayName?: string;
Tenant.emailPrivacyConfig
Konfigurasi privasi email untuk tenant
Tanda Tangan:
readonly emailPrivacyConfig?: EmailPrivacyConfig;
Tenant.emailSignInConfig
Konfigurasi penyedia login email.
Tanda Tangan:
get emailSignInConfig(): EmailSignInProviderConfig | undefined;
Tenant.multiFactorConfig
Konfigurasi autentikasi multi-faktor pada tenant saat ini.
Tanda Tangan:
get multiFactorConfig(): MultiFactorConfig | undefined;
Tenant.passwordPolicyConfig
Konfigurasi kebijakan sandi untuk tenant
Tanda Tangan:
readonly passwordPolicyConfig?: PasswordPolicyConfig;
Tenant.recaptchaConfig
Konfigurasi autentikasi konfigurasi recaptcha dari tenant saat ini.
Tanda Tangan:
get recaptchaConfig(): RecaptchaConfig | undefined;
Tenant.smsRegionConfig
Konfigurasi Wilayah SMS untuk mengupdate tenant. Mengonfigurasi wilayah tempat pengguna diizinkan untuk mengirim SMS verifikasi. Hal ini didasarkan pada kode panggilan dari nomor telepon tujuan.
Tanda Tangan:
readonly smsRegionConfig?: SmsRegionConfig;
Tenant.tenantId
ID tenant.
Tanda Tangan:
readonly tenantId: string;
Tenant.testPhoneNumbers
Peta yang berisi pasangan kode / nomor telepon pengujian untuk tenant.
Tanda Tangan:
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Tenant.toJSON()
Menampilkan representasi JSON-serial yang dapat diserialisasi untuk objek ini.
Tanda Tangan:
toJSON(): object;
Hasil:
objek
Representasi JSON yang dapat diserialisasi untuk objek ini.