Representa uma configuração de locatário.
O suporte à multilocação exige o Identity Platform (GCIP) do Google Cloud. Para saber mais sobre o GCIP, incluindo preços e recursos, consulte a documentação do GCIP.
Para que a multilocação possa ser usada em um projeto do Google Cloud Identity Platform, os locatários precisam ter permissão no projeto na IU do Console do Cloud.
Uma configuração de locatário fornece informações como o nome de exibição, o identificador do locatário e a configuração de autenticação de e-mail. Para o gerenciamento de configuração do provedor OIDC/SAML, em vez de um Tenant, é preciso usar instâncias TenantAwareAuth para recuperar a lista de IdPs configurados em um locatário. Ao configurar esses provedores, observe que os locatários herdarão os domínios permitidos e os URIs de redirecionamento autenticados do projeto pai.
Todas as outras configurações de um locatário também serão herdadas. Eles precisarão ser gerenciados na interface do console do Cloud.
Assinatura:
export declare class Tenant
Propriedades
| Propriedade | Modificadores | Tipo | Descrição |
|---|---|---|---|
| anonymousSignInEnabled | booleano | ||
| displayName | string | O nome de exibição do locatário. | |
| emailPrivacyConfig (em inglês) | EmailPrivacyConfig (em inglês) | A configuração de privacidade de e-mail para o locatário | |
| emailSignInConfig (em inglês) | EmailSignInProviderConfig | indefinido | Configuração do provedor de login de e-mail. | |
| multiFactorConfig (em inglês) | MultiFactorConfig | indefinido | A configuração de autenticação multifator no locatário atual. | |
| passwordPolicyConfig. | PasswordPolicyConfig (link em inglês) | A configuração da política de senha para o locatário | |
| recaptchaConfig (em inglês) | RecaptchaConfig | indefinido | A configuração de autenticação de reCAPTCHA do locatário atual. | |
| smsRegionConfig (link em inglês) | SmsRegionConfig (link em inglês) | A configuração de regiões de SMS para atualizar um locatário. Configura as regiões para onde os usuários têm permissão para enviar SMS de verificação. Isso é baseado no código de chamada do número de telefone de destino. | |
| tenantId (em inglês) | string | É o identificador do locatário. | |
| testNumbers | { [phoneNumber: string]: string; } | O mapa que contém os pares de número de telefone / código de teste para o locatário. |
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| toJSON() (link em inglês) | Retorna uma representação serializável do JSON desse objeto. |
Locatário.anonymousSignInEnabled
Assinatura:
readonly anonymousSignInEnabled: boolean;
Locatário.displayName
O nome de exibição do locatário.
Assinatura:
readonly displayName?: string;
Tenant.emailPrivacyConfig
A configuração de privacidade de e-mail para o locatário
Assinatura:
readonly emailPrivacyConfig?: EmailPrivacyConfig;
Tenant.emailSignInConfig
Configuração do provedor de login de e-mail.
Assinatura:
get emailSignInConfig(): EmailSignInProviderConfig | undefined;
Tenant.multiFactorConfig
A configuração de autenticação multifator no locatário atual.
Assinatura:
get multiFactorConfig(): MultiFactorConfig | undefined;
Tenant.passwordPolicyConfig
A configuração da política de senha para o locatário
Assinatura:
readonly passwordPolicyConfig?: PasswordPolicyConfig;
Tenant.recaptchaConfig
A configuração de autenticação de reCAPTCHA do locatário atual.
Assinatura:
get recaptchaConfig(): RecaptchaConfig | undefined;
Tenant.smsRegionConfig
A configuração de regiões de SMS para atualizar um locatário. Configura as regiões para onde os usuários têm permissão para enviar SMS de verificação. Isso é baseado no código de chamada do número de telefone de destino.
Assinatura:
readonly smsRegionConfig?: SmsRegionConfig;
Tenant.tenantId
É o identificador do locatário.
Assinatura:
readonly tenantId: string;
Tenant.testNumbers
O mapa que contém os pares de número de telefone / código de teste para o locatário.
Assinatura:
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Tenant.toJSON().
Retorna uma representação serializável do JSON desse objeto.
Assinatura:
toJSON(): object;
Retorna:
objeto
Uma representação serializável do JSON desse objeto.