Representa una configuración de inquilino.
La compatibilidad con múltiples inquilinos requiere Identity Platform (GCIP) de Google Cloud. Para obtener más información sobre GCIP, incluidos precios y funciones, consulte la documentación de GCIP. .
Antes de que se pueda utilizar el arrendamiento múltiple en un proyecto de Google Cloud Identity Platform, los inquilinos deben tener permiso para participar en ese proyecto a través de la interfaz de usuario de Cloud Console.
Una configuración de inquilino proporciona información como el nombre para mostrar, el identificador de inquilino y la configuración de autenticación de correo electrónico. Para la gestión de la configuración del proveedor OIDC/SAML, se deben usar instancias TenantAwareAuth en lugar de un Tenant para recuperar la lista de IdP configurados en un inquilino. Al configurar estos proveedores, tenga en cuenta que los inquilinos heredarán los dominios incluidos en la lista blanca y los URI de redireccionamiento autenticados de su proyecto principal.
Todas las demás configuraciones de un inquilino también se heredarán. Estos deberán administrarse desde la interfaz de usuario de Cloud Console.
Firma:
export declare class Tenant
Propiedades
| Propiedad | Modificadores | Tipo | Descripción |
|---|---|---|---|
| inicio de sesión anónimo habilitado | booleano | ||
| nombre para mostrar | cadena | El nombre para mostrar del inquilino. | |
| correo electrónicoPrivacyConfig | Configuración de privacidad de correo electrónico | La configuración de privacidad del correo electrónico para el inquilino. | |
| correo electrónicoSignInConfig | Correo electrónicoSignInProviderConfig | indefinido | La configuración del proveedor de inicio de sesión de correo electrónico. | |
| configuración multifactor | Configuración multifactor | indefinido | La configuración de autenticación multifactor en el inquilino actual. | |
| contraseñaPolicyConfig | Configuración de política de contraseña | La configuración de la política de contraseñas para el inquilino. | |
| recaptchaConfig | RecaptchaConfig | indefinido | La configuración de autenticación de configuración de recaptcha del inquilino actual. | |
| smsRegiónConfig | Configuración de región de SMS | La configuración de regiones de SMS para actualizar un inquilino. Configura las regiones donde los usuarios pueden enviar SMS de verificación. Esto se basa en el código de llamada del número de teléfono de destino. | |
| ID de inquilino | cadena | El identificador del inquilino. | |
| pruebaNúmeros de teléfono | { [número de teléfono: cadena]: cadena; } | El mapa que contiene los pares de código/número de teléfono de prueba para el inquilino. |
Métodos
| Método | Modificadores | Descripción |
|---|---|---|
| a JSON() | Devuelve una representación serializable JSON de este objeto. |
Inquilino.anonymousSignInEnabled
Firma:
readonly anonymousSignInEnabled: boolean;
Inquilino.displayName
El nombre para mostrar del inquilino.
Firma:
readonly displayName?: string;
Inquilino.emailPrivacyConfig
La configuración de privacidad del correo electrónico para el inquilino.
Firma:
readonly emailPrivacyConfig?: EmailPrivacyConfig;
Inquilino.emailSignInConfig
La configuración del proveedor de inicio de sesión de correo electrónico.
Firma:
get emailSignInConfig(): EmailSignInProviderConfig | undefined;
Inquilino.multiFactorConfig
La configuración de autenticación multifactor en el inquilino actual.
Firma:
get multiFactorConfig(): MultiFactorConfig | undefined;
Inquilino.contraseñaPolicyConfig
La configuración de la política de contraseñas para el inquilino.
Firma:
readonly passwordPolicyConfig?: PasswordPolicyConfig;
Inquilino.recaptchaConfig
La configuración de autenticación de configuración de recaptcha del inquilino actual.
Firma:
get recaptchaConfig(): RecaptchaConfig | undefined;
Inquilino.smsRegionConfig
La configuración de regiones de SMS para actualizar un inquilino. Configura las regiones donde los usuarios pueden enviar SMS de verificación. Esto se basa en el código de llamada del número de teléfono de destino.
Firma:
readonly smsRegionConfig?: SmsRegionConfig;
Inquilino.tenantId
El identificador del inquilino.
Firma:
readonly tenantId: string;
Inquilino.testPhoneNumbers
El mapa que contiene los pares de código/número de teléfono de prueba para el inquilino.
Firma:
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Inquilino.toJSON()
Devuelve una representación serializable JSON de este objeto.
Firma:
toJSON(): object;
Devoluciones:
objeto
Una representación serializable en JSON de este objeto.