Representa uma configuração de locatário.
O suporte para multilocação requer a plataforma de identidade do Google Cloud (GCIP). Para saber mais sobre o GCIP, incluindo preços e recursos, consulte a documentação do GCIP .
Antes que a multilocação possa ser usada em um projeto do Google Cloud Identity Platform, os locatários precisam ter permissão nesse projeto por meio da IU do Console do Cloud.
Uma configuração de locatário fornece informações como nome de exibição, identificador de locatário e configuração de autenticação de email. Para o gerenciamento de configuração do provedor OIDC/SAML, as instâncias TenantAwareAuth devem ser usadas em vez de um Tenant para recuperar a lista de IdPs configurados em um locatário. Ao configurar esses provedores, observe que os locatários herdarão domínios na lista de permissões e 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 IU do Cloud Console.
Assinatura:
export declare class Tenant
Propriedades
| Propriedade | Modificadores | Tipo | Descrição |
|---|---|---|---|
| anônimoSignInEnabled | boleano | ||
| nome de exibição | corda | O nome de exibição do locatário. | |
| emailPrivacyConfig | EmailPrivacyConfig | A configuração de privacidade de email para o locatário | |
| emailSignInConfig | EmailSignInProviderConfig | indefinido | A configuração do provedor de login de e-mail. | |
| multiFactorConfig | MultiFactorConfig | indefinido | A configuração de autenticação multifator no locatário atual. | |
| passwordPolicyConfig | PasswordPolicyConfig | A configuração da política de senha para o locatário | |
| recaptchaConfig | RecaptchaConfig | indefinido | A configuração de autenticação recaptcha config do locatário atual. | |
| smsRegionConfig | SmsRegionConfig | A configuração de regiões SMS para atualizar um locatário. Configura as regiões onde os usuários têm permissão para enviar SMS de verificação. Isto se baseia no código de chamada do número de telefone de destino. | |
| inquilinoId | corda | O identificador do locatário. | |
| testePhoneNumbers | { [número de telefone: string]: string; } | O mapa que contém os pares de número de telefone/código de teste do locatário. |
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| paraJSON() | Retorna uma representação serializável JSON deste objeto. |
Locatário.anonymousSignInEnabled
Assinatura:
readonly anonymousSignInEnabled: boolean;
Locatário.displayName
O nome de exibição do locatário.
Assinatura:
readonly displayName?: string;
Locatário.emailPrivacyConfig
A configuração de privacidade de email para o locatário
Assinatura:
readonly emailPrivacyConfig?: EmailPrivacyConfig;
Locatário.emailSignInConfig
A configuração do provedor de login de e-mail.
Assinatura:
get emailSignInConfig(): EmailSignInProviderConfig | undefined;
Locatário.multiFactorConfig
A configuração de autenticação multifator no locatário atual.
Assinatura:
get multiFactorConfig(): MultiFactorConfig | undefined;
Locatário.passwordPolicyConfig
A configuração da política de senha para o locatário
Assinatura:
readonly passwordPolicyConfig?: PasswordPolicyConfig;
Locatário.recaptchaConfig
A configuração de autenticação recaptcha config do locatário atual.
Assinatura:
get recaptchaConfig(): RecaptchaConfig | undefined;
Locatário.smsRegionConfig
A configuração de regiões SMS para atualizar um locatário. Configura as regiões onde os usuários têm permissão para enviar SMS de verificação. Isto se baseia no código de chamada do número de telefone de destino.
Assinatura:
readonly smsRegionConfig?: SmsRegionConfig;
Inquilino.tenantId
O identificador do locatário.
Assinatura:
readonly tenantId: string;
Inquilino.testPhoneNumbers
O mapa que contém os pares de número de telefone/código de teste do locatário.
Assinatura:
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Inquilino.toJSON()
Retorna uma representação serializável JSON deste objeto.
Assinatura:
toJSON(): object;
Retorna:
objeto
Uma representação serializável JSON deste objeto.