代表租户配置。
多租户支持需要 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 可序列化表示。