表示租户配置。
如需支持多租户，需要使用 Google Cloud 的 Identity Platform (GCIP)。如需详细了解 GCIP（包括价格和功能），请参阅 GCIP 文档。
要在 Google Cloud Identity Platform 项目上使用多租户，必须通过 Cloud Console 界面允许该项目使用租户。
租户配置提供显示名称、租户标识符和电子邮件身份验证配置等信息。对于 OIDC/SAML 提供方配置管理，应使用 TenantAwareAuth 实例（而不是 Tenant）来检索租户上已配置的 IdP 的列表。配置这些提供商时，请注意，租户将继承其父级项目的已列入白名单的网域和经过身份验证的重定向 URI。
租户的所有其他设置也将继承。这些项目需要通过 Cloud 控制台界面进行管理。
签名：
export declare class Tenant
属性
| 属性 | 修饰符 | 类型 | 说明 |
|---|---|---|---|
| anonymousSignInEnabled | 布尔值 | ||
| displayName | 字符串 | 租户显示名称。 | |
| emailPrivacyConfig | EmailPrivacyConfig | 租户的电子邮件隐私权配置 | |
| emailSignInConfig | EmailSignInProviderConfig |未定义 | 电子邮件登录提供方配置。 | |
| multiFactorConfig | MultiFactorConfig |未定义 | 当前租户的多重身份验证配置。 | |
| passwordPolicyConfig | PasswordPolicyConfig | 租户的密码政策配置 | |
| recaptchaConfig | RecaptchaConfig |未定义 | 当前租户的 reCAPTCHA 配置身份验证配置。 | |
| smsRegionConfig | SmsRegionConfig | 用于更新租户的短信区域配置。配置允许用户发送验证短信的区域。此电话号码依据的是目标电话号码的呼叫代码。 | |
| tenantId | 字符串 | 租户标识符。 | |
| testPhoneNumbers | { [phoneNumber: string]: string;} | 包含租户的测试电话号码 / 代码对的地图。 |
方法
| 方法 | 修饰符 | 说明 |
|---|---|---|
| toJSON() | 返回此对象的可序列化 JSON 表示法。 |
Tenant.anonymousSignInEnabled
签名：
readonly anonymousSignInEnabled: boolean;
Tenant.displayName
租户显示名称。
签名：
readonly displayName?: string;
Tenant.emailPrivacyConfig
租户的电子邮件隐私权配置
签名：
readonly emailPrivacyConfig?: EmailPrivacyConfig;
Tenant.emailSignInConfig
电子邮件登录提供方配置。
签名：
get emailSignInConfig(): EmailSignInProviderConfig | undefined;
Tenant.multiFactorConfig
当前租户的多重身份验证配置。
签名：
get multiFactorConfig(): MultiFactorConfig | undefined;
Tenant.passwordPolicyConfig
租户的密码政策配置
签名：
readonly passwordPolicyConfig?: PasswordPolicyConfig;
Tenant.recaptchaConfig
当前租户的 reCAPTCHA 配置身份验证配置。
签名：
get recaptchaConfig(): RecaptchaConfig | undefined;
Tenant.smsRegionConfig
用于更新租户的短信区域配置。配置允许用户发送验证短信的区域。此电话号码依据的是目标电话号码的呼叫代码。
签名：
readonly smsRegionConfig?: SmsRegionConfig;
租户 ID
租户标识符。
签名：
readonly tenantId: string;
Tenant.testPhoneNumbers
包含租户的测试电话号码 / 代码对的地图。
签名：
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Tenant.toJSON()
返回此对象的可序列化 JSON 表示法。
签名：
toJSON(): object;
返回：
对象
此对象的可序列化 JSON 表示法。