代表用戶群設定。
必須採用 Google Cloud 的 Identity Platform (GCIP)，才能支援多用戶群架構。如要進一步瞭解 GCIP (包括定價和功能)，請參閱 GCIP 說明文件。
Google Cloud Identity Platform 專案必須先允許用戶群，才能透過 Cloud 控制台 UI 存取多用戶群架構，您才能在該專案中使用多用戶群架構。
用戶群設定可提供顯示名稱、用戶群 ID 和電子郵件驗證設定等資訊。如要管理 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 | 用於更新用戶群的簡訊區域設定。設定使用者可在哪些地區傳送驗證簡訊。視目的地電話號碼的通話代碼而定。 | |
| 用戶群 ID | 字串 | 用戶群 ID。 | |
| 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;
Tenant.用戶群 Id
用戶群 ID。
簽名：
readonly tenantId: string;
Tenant.testPhoneNumbers
包含用戶群測試電話號碼和代碼組合的地圖。
簽名：
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Tenant.toJSON()
傳回此物件的 JSON 可序列化表示法。
簽名：
toJSON(): object;
傳回：
物件
此物件的 JSON 可序列化表示法。