Представляет конфигурацию клиента.
Для поддержки мультитенантности требуется платформа идентификации Google Cloud (GCIP). Дополнительную информацию о GCIP, включая цены и функции, см. в документации GCIP. .
Прежде чем использовать мультитенантность в проекте Google Cloud Identity Platform, арендаторам необходимо разрешить участие в этом проекте через пользовательский интерфейс Cloud Console.
Конфигурация клиента предоставляет такую информацию, как отображаемое имя, идентификатор клиента и конфигурация аутентификации электронной почты. Для управления конфигурацией поставщика OIDC/SAML вместо Tenant следует использовать экземпляры TenantAwareAuth для получения списка настроенных IdP в арендаторе. При настройке этих поставщиков обратите внимание, что клиенты будут наследовать домены из белого списка и URI перенаправления с проверкой подлинности своего родительского проекта.
Все остальные настройки арендатора также будут унаследованы. Им необходимо будет управлять из пользовательского интерфейса Cloud Console.
Подпись:
export declare class Tenant
Характеристики
| Свойство | Модификаторы | Тип | Описание |
|---|---|---|---|
| анонимсингиненаблед | логическое значение | ||
| отображаемое имя | нить | Отображаемое имя арендатора. | |
| электронная почтаКонфиденциальностьКонфигурация | Конфигурация конфиденциальности электронной почты | Конфигурация конфиденциальности электронной почты для клиента | |
| электронная почтаSignInConfig | EmailSignInProviderConfig | неопределенный | Вход по электронной почте в конфигурацию провайдера. | |
| multiFactorConfig | Мультифакторная конфигурация | неопределенный | Конфигурация многофакторной аутентификации в текущем клиенте. | |
| парольполитикаконфиг | Конфигурация политики паролей | Конфигурация политики паролей для клиента | |
| рекапчаконфиг | РекапчаКонфигурация | неопределенный | Конфигурация аутентификации recaptcha текущего клиента. | |
| смсрегионконфиг | СмсРегионКонфиг | Конфигурация регионов SMS для обновления клиента. Настраивает регионы, в которых пользователям разрешено отправлять проверочные SMS. Это основано на коде вызова телефонного номера пункта назначения. | |
| идентификатор арендатора | нить | Идентификатор арендатора. | |
| testPhoneNumbers | {[phoneNumber: строка]: строка; } | Карта, содержащая тестовые пары телефонный номер/код арендатора. |
Методы
| Метод | Модификаторы | Описание |
|---|---|---|
| toJSON() | Возвращает сериализуемое в формате JSON представление этого объекта. |
Tenant.anonymousSignInEnabled
Подпись:
readonly anonymousSignInEnabled: boolean;
Тенант.displayName
Отображаемое имя арендатора.
Подпись:
readonly displayName?: string;
Tenant.emailPrivacyConfig
Конфигурация конфиденциальности электронной почты для клиента
Подпись:
readonly emailPrivacyConfig?: EmailPrivacyConfig;
Тенант.emailSignInConfig
Вход по электронной почте в конфигурацию провайдера.
Подпись:
get emailSignInConfig(): EmailSignInProviderConfig | undefined;
Тенант.multiFactorConfig
Конфигурация многофакторной аутентификации в текущем клиенте.
Подпись:
get multiFactorConfig(): MultiFactorConfig | undefined;
Tenant.passwordPolicyConfig
Конфигурация политики паролей для клиента
Подпись:
readonly passwordPolicyConfig?: PasswordPolicyConfig;
Тенант.recaptchaConfig
Конфигурация аутентификации recaptcha текущего клиента.
Подпись:
get recaptchaConfig(): RecaptchaConfig | undefined;
Тенант.smsRegionConfig
Конфигурация регионов SMS для обновления клиента. Настраивает регионы, в которых пользователям разрешено отправлять проверочные SMS. Это основано на коде вызова телефонного номера пункта назначения.
Подпись:
readonly smsRegionConfig?: SmsRegionConfig;
Тенант.tenantId
Идентификатор арендатора.
Подпись:
readonly tenantId: string;
Tenant.testPhoneNumbers
Карта, содержащая тестовые пары телефонный номер/код арендатора.
Подпись:
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Тенант.toJSON()
Возвращает сериализуемое в формате JSON представление этого объекта.
Подпись:
toJSON(): object;
Возврат:
объект
Сериализуемое в формате JSON представление этого объекта.