テナント構成を表します。
マルチテナンシーのサポートには、Google Cloud の ID プラットフォーム (GCIP) が必要です。価格や機能など、GCIP の詳細については、 GCIP のドキュメントを参照してください。 。
Google Cloud Identity Platform プロジェクトでマルチテナントを使用するには、Cloud Console UI を介してそのプロジェクトでテナントを許可する必要があります。
テナント構成では、表示名、テナント識別子、電子メール認証構成などの情報が提供されます。 OIDC/SAML プロバイダー構成管理の場合、 Tenantの代わりにTenantAwareAuthインスタンスを使用して、テナント上に構成された IdP のリストを取得する必要があります。これらのプロバイダーを構成する場合、テナントは親プロジェクトのホワイトリストに登録されたドメインと認証されたリダイレクト URI を継承することに注意してください。
テナントのその他の設定もすべて継承されます。これらは Cloud Console UI から管理する必要があります。
サイン：
export declare class Tenant
プロパティ
| 財産 | 修飾子 | タイプ | 説明 |
|---|---|---|---|
| 匿名サインイン有効 | ブール値 | ||
| 表示名 | 弦 | テナントの表示名。 | |
| メールプライバシー設定 | 電子メールプライバシー設定 | テナントの電子メール プライバシー構成 | |
| 電子メールサインイン設定 | 電子メールサインインプロバイダー構成|未定義 | 電子メールサインインプロバイダー構成。 | |
| マルチファクター構成 | マルチファクター構成|未定義 | 現在のテナントの多要素認証構成。 | |
| パスワードポリシー構成 | パスワードポリシー構成 | テナントのパスワードポリシー構成 | |
| recaptchaConfig | 再キャプチャ構成|未定義 | 現在のテナントの recaptcha config 認証構成。 | |
| smsRegionConfig | SmsRegionConfig | テナントを更新するための SMS リージョン構成。ユーザーが確認 SMS の送信を許可される地域を構成します。これは、宛先電話番号の発信者コードに基づいています。 | |
| テナントID | 弦 | テナント識別子。 | |
| テスト電話番号 | { [電話番号: 文字列]: 文字列; } | テナントのテスト用の電話番号とコードのペアを含むマップ。 |
メソッド
| 方法 | 修飾子 | 説明 |
|---|---|---|
| toJSON() | このオブジェクトの JSON シリアル化可能な表現を返します。 |
Tenant.anonymousSignInEnabled
サイン：
readonly anonymousSignInEnabled: boolean;
テナント.表示名
テナントの表示名。
サイン：
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 config 認証構成。
サイン：
get recaptchaConfig(): RecaptchaConfig | undefined;
Tenant.smsRegionConfig
テナントを更新するための SMS リージョン構成。ユーザーが確認 SMS の送信を許可される地域を構成します。これは、宛先電話番号の発信者コードに基づいています。
サイン：
readonly smsRegionConfig?: SmsRegionConfig;
Tenant.tenantId
テナント識別子。
サイン：
readonly tenantId: string;
Tenant.testPhoneNumbers
テナントのテスト用の電話番号とコードのペアを含むマップ。
サイン：
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Tenant.toJSON()
このオブジェクトの JSON シリアル化可能な表現を返します。
サイン：
toJSON(): object;
戻り値：
物体
このオブジェクトの JSON シリアル化可能な表現。