テナント構成を表します。
マルチテナンシーのサポートには、Google Cloud の Identity Platform（GCIP）が必要です。料金や機能など、GCIP の詳細については、GCIP のドキュメントをご覧ください。
Google Cloud Identity Platform プロジェクトでマルチテナンシーを使用するには、Cloud コンソール UI を介してそのプロジェクトでテナントを許可する必要があります。
テナント構成には、表示名、テナント ID、メール認証構成などの情報が含まれます。OIDC/SAML プロバイダの構成管理では、テナントで構成された IdP のリストを取得するために、Tenant ではなく TenantAwareAuth インスタンスを使用する必要があります。これらのプロバイダを構成する場合、テナントは親プロジェクトの許可リストドメインと認証済みリダイレクト URI を継承することに注意してください。
テナントの他のすべての設定も継承されます。これらは Cloud コンソール UI から管理する必要があります。
署名:
export declare class Tenant
プロパティ
| プロパティ | 修飾キー | タイプ | 説明 |
|---|---|---|---|
| anonymousSignInEnabled | ブール値 | ||
| displayName | 文字列 | テナントの表示名。 | |
| emailPrivacyConfig | EmailPrivacyConfig | テナントのメール プライバシー構成 | |
| emailSignInConfig | EmailSignInProviderConfig |未定義 | メールログイン プロバイダの構成。 | |
| multiFactorConfig | MultiFactorConfig |未定義 | 現在のテナントの多要素認証の構成。 | |
| passwordPolicyConfig | PasswordPolicyConfig | テナントのパスワード ポリシー構成 | |
| recaptchaConfig | RecaptchaConfig |未定義 | 現在のテナントの reCAPTCHA 構成認証構成。 | |
| smsRegionConfig | SmsRegionConfig | テナントを更新するための SMS リージョン構成。ユーザーが確認 SMS を送信できるリージョンを設定します。発信先の電話番号の通話コードに基づきます。 | |
| tenantId | 文字列 | テナント 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
テナントを更新するための SMS リージョン構成。ユーザーに確認 SMS の送信を許可するリージョンを設定します。発信先の電話番号の通話コードに基づきます。
署名:
readonly smsRegionConfig?: SmsRegionConfig;
Tenant.tenantId
テナント ID。
署名:
readonly tenantId: string;
Tenant.testPhoneNumbers
テナントのテスト電話番号 / コードペアを含むマップ。
署名:
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Tenant.toJSON()
このオブジェクトの JSON シリアル化可能な表現を返します。
署名:
toJSON(): object;
戻り値:
オブジェクト
このオブジェクトの JSON シリアル化可能な表現。