代表租戶配置。
多租戶支援需要 Google Cloud 的 Identity Platform (GCIP)。要了解有關 GCIP 的更多信息，包括定價和功能，請參閱GCIP 文檔。
在 Google Cloud Identity Platform 專案上使用多租戶之前，必須透過 Cloud Console UI 允許租戶使用該專案。
租用戶配置提供顯示名稱、租用戶識別碼和電子郵件身份驗證設定等資訊。對於 OIDC/SAML 提供者設定管理，應使用TenantAwareAuth實例而不是Tenant來檢索租用戶上已配置的 IdP 清單。設定這些提供者時，請注意租用戶將繼承其父項目的白名單網域和經過驗證的重新導向 URI。
租戶的所有其他設定也將被繼承。這些需要透過 Cloud Console UI 進行管理。
簽名：
export declare class Tenant
特性
| 財產 | 修飾符 | 類型 | 描述 |
|---|---|---|---|
| 匿名登入已啟用 | 布林值 | ||
| 顯示名稱 | 細繩 | 租戶顯示名稱。 | |
| 電子郵件隱私配置 | 電子郵件隱私配置 | 租戶的電子郵件隱私配置 | |
| 電子郵件登入配置 | 電子郵件登入提供者配置|不明確的 | 電子郵件登入提供者配置。 | |
| 多因素配置 | 多因素配置|不明確的 | 目前租用戶的多重身份驗證配置。 | |
| 密碼策略配置 | 密碼策略配置 | 租用戶的密碼原則配置 | |
| 驗證碼配置 | 驗證碼配置|不明確的 | 目前租戶的 recaptcha config auth 配置。 | |
| 簡訊區域配置 | 簡訊區域配置 | 用於更新租用戶的 SMS 區域配置。配置允許使用者發送驗證簡訊的區域。這是基於目標電話號碼的呼叫代碼。 | |
| 租戶ID | 細繩 | 租戶識別碼。 | |
| 測試電話號碼 | { [電話號碼：字串]：字串； } | 包含租戶的測試電話號碼/代碼對的地圖。 |
方法
| 方法 | 修飾符 | 描述 |
|---|---|---|
| toJSON() | 傳回此物件的 JSON 可序列化表示形式。 |
租戶.anonymousSignInEnabled
簽名：
readonly anonymousSignInEnabled: boolean;
租用戶.displayName
租戶顯示名稱。
簽名：
readonly displayName?: string;
租戶.emailPrivacyConfig
租戶的電子郵件隱私配置
簽名：
readonly emailPrivacyConfig?: EmailPrivacyConfig;
租戶.emailSignInConfig
電子郵件登入提供者配置。
簽名：
get emailSignInConfig(): EmailSignInProviderConfig | undefined;
租戶.multiFactorConfig
目前租用戶的多重身份驗證配置。
簽名：
get multiFactorConfig(): MultiFactorConfig | undefined;
租戶.passwordPolicyConfig
租用戶的密碼原則配置
簽名：
readonly passwordPolicyConfig?: PasswordPolicyConfig;
租戶.recaptchaConfig
目前租戶的 recaptcha config auth 配置。
簽名：
get recaptchaConfig(): RecaptchaConfig | undefined;
租戶.smsRegionConfig
用於更新租用戶的 SMS 區域配置。配置允許使用者發送驗證簡訊的區域。這是基於目標電話號碼的呼叫代碼。
簽名：
readonly smsRegionConfig?: SmsRegionConfig;
租戶.tenantId
租戶識別碼。
簽名：
readonly tenantId: string;
租戶.testPhoneNumbers
包含租戶的測試電話號碼/代碼對的地圖。
簽名：
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
租戶.toJSON()
傳回此物件的 JSON 可序列化表示形式。
簽名：
toJSON(): object;
返回：
目的
該物件的 JSON 可序列化表示。