Mewakili konfigurasi penyewa.
Dukungan multi-tenancy memerlukan Identity Platform (GCIP) Google Cloud. Untuk mempelajari lebih lanjut tentang GCIP, termasuk harga dan fitur, lihat dokumentasi GCIP .
Sebelum multi-penyewa dapat digunakan pada proyek Google Cloud Identity Platform, penyewa harus diizinkan pada proyek tersebut melalui UI Cloud Console.
Konfigurasi penyewa memberikan informasi seperti nama tampilan, pengidentifikasi penyewa, dan konfigurasi autentikasi email. Untuk manajemen konfigurasi penyedia OIDC/SAML, instans TenantAwareAuth
harus digunakan sebagai ganti Tenant
untuk mengambil daftar IdP yang dikonfigurasi pada penyewa. Saat mengonfigurasi penyedia ini, perhatikan bahwa penyewa akan mewarisi domain yang masuk daftar putih dan mengautentikasi URI pengalihan dari proyek induknya.
Semua pengaturan penyewa lainnya juga akan diwariskan. Ini perlu dikelola dari UI Cloud Console.
Tanda tangan:
export declare class Tenant
Properti
Properti | Pengubah | Jenis | Keterangan |
---|---|---|---|
anonimSignInEnabled | boolean | ||
nama tampilan | rangkaian | Nama tampilan penyewa. | |
emailPrivacyConfig | Konfigurasi Privasi Email | Konfigurasi privasi email untuk penyewa | |
emailSignInConfig | EmailSignInProviderConfig | belum diartikan | Konfigurasi penyedia masuk email. | |
multiFactorConfig | Konfigurasi MultiFaktor | belum diartikan | Konfigurasi autentikasi multifaktor pada penyewa saat ini. | |
kata sandiPolicyConfig | Konfigurasi Kebijakan Kata Sandi | Konfigurasi kebijakan kata sandi untuk penyewa | |
recaptchaConfig | Konfigurasi Recaptcha | belum diartikan | Konfigurasi autentikasi konfigurasi recaptcha dari penyewa saat ini. | |
smsRegionConfig | SmsRegionConfig | Konfigurasi Wilayah SMS untuk memperbarui penyewa. Mengonfigurasi wilayah di mana pengguna diperbolehkan mengirim SMS verifikasi. Hal ini berdasarkan kode panggilan nomor telepon tujuan. | |
penyewaId | rangkaian | Pengidentifikasi penyewa. | |
tesNomor Telepon | { [Nomor Telepon: string]: string; } | Peta yang berisi tes nomor telepon/pasangan kode untuk penyewa. |
Metode
metode | Pengubah | Keterangan |
---|---|---|
keJSON() | Mengembalikan representasi objek ini yang dapat diserialkan JSON. |
Penyewa.anonymousSignInEnabled
Tanda tangan:
readonly anonymousSignInEnabled: boolean;
Penyewa.namatampilan
Nama tampilan penyewa.
Tanda tangan:
readonly displayName?: string;
Penyewa.emailPrivacyConfig
Konfigurasi privasi email untuk penyewa
Tanda tangan:
readonly emailPrivacyConfig?: EmailPrivacyConfig;
Penyewa.emailSignInConfig
Konfigurasi penyedia masuk email.
Tanda tangan:
get emailSignInConfig(): EmailSignInProviderConfig | undefined;
Penyewa.multiFactorConfig
Konfigurasi autentikasi multifaktor pada penyewa saat ini.
Tanda tangan:
get multiFactorConfig(): MultiFactorConfig | undefined;
Penyewa.passwordPolicyConfig
Konfigurasi kebijakan kata sandi untuk penyewa
Tanda tangan:
readonly passwordPolicyConfig?: PasswordPolicyConfig;
Penyewa.recaptchaConfig
Konfigurasi autentikasi konfigurasi recaptcha dari penyewa saat ini.
Tanda tangan:
get recaptchaConfig(): RecaptchaConfig | undefined;
Penyewa.smsRegionConfig
Konfigurasi Wilayah SMS untuk memperbarui penyewa. Mengonfigurasi wilayah di mana pengguna diperbolehkan mengirim SMS verifikasi. Hal ini berdasarkan kode panggilan nomor telepon tujuan.
Tanda tangan:
readonly smsRegionConfig?: SmsRegionConfig;
Penyewa.tenantId
Pengidentifikasi penyewa.
Tanda tangan:
readonly tenantId: string;
Penyewa.testPhoneNumbers
Peta yang berisi tes nomor telepon/pasangan kode untuk penyewa.
Tanda tangan:
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Penyewa.toJSON()
Mengembalikan representasi objek ini yang dapat diserialkan JSON.
Tanda tangan:
toJSON(): object;
Pengembalian:
obyek
Representasi objek ini yang dapat diserialkan JSON.