Representa la configuración de un usuario.
La compatibilidad con la función multiusuario requiere Identity Platform (GCIP) de Google Cloud. Para obtener más información sobre GCIP, incluidos los precios y las funciones, consulta la documentación de GCIP.
Antes de que se pueda usar la función multiusuario en un proyecto de Google Cloud Identity Platform, se deben permitir usuarios en ese proyecto a través de la IU de la consola de Cloud.
Una configuración de usuario proporciona información como el nombre visible, el identificador del usuario y la configuración de autenticación con el correo electrónico. Para la administración de configuraciones del proveedor de OIDC/SAML, se deben usar las instancias de TenantAwareAuth en lugar de Tenant para recuperar la lista de IdP configurados en un usuario. Cuando configures estos proveedores, ten en cuenta que los usuarios heredarán los dominios incluidos en la lista blanca y los URI de redireccionamiento autenticados de su proyecto superior.
También se heredarán todos los demás parámetros de configuración de un usuario. Se deberán administrar desde la IU de la consola de Cloud.
Firma:
export declare class Tenant
Propiedades
| Propiedad | Teclas modificadoras | Tipo | Descripción |
|---|---|---|---|
| anonymousSignInEnabled | booleano | ||
| displayName | string | El nombre comercial de la instancia. | |
| emailPrivacyConfig | EmailPrivacyConfig | La configuración de privacidad del correo electrónico para el usuario | |
| emailSignInConfig | EmailSignInProviderConfig | indefinido | La configuración del proveedor de acceso por correo electrónico. | |
| multiFactorConfig | MultiFactorConfig | indefinido | La configuración de autenticación de varios factores del usuario actual. | |
| passwordPolicyConfig | PasswordPolicyConfig | La configuración de la política de contraseñas para el usuario | |
| recaptchaConfig | RecaptchaConfig | indefinido | La configuración de autenticación de configuración de reCAPTCHA del usuario actual. | |
| smsRegionConfig. | SmsRegionConfig. | La configuración de regiones de SMS para actualizar un usuario. Configura las regiones en las que los usuarios pueden enviar SMS de verificación. Se basa en el código de llamada del número de teléfono de destino. | |
| IDdeusuario | string | Es el identificador del usuario. | |
| númerosdeteléfonodeprueba | { [phoneNumber: string]: cadena; }. | El mapa que contiene los pares de números de teléfono / códigos de prueba del usuario. |
Métodos
| Método | Teclas modificadoras | Descripción |
|---|---|---|
| toJSON() | Muestra una representación JSON serializable de este objeto. |
Tenant.anonymousSignInEnabled
Firma:
readonly anonymousSignInEnabled: boolean;
Tenant.displayName
El nombre comercial de la instancia.
Firma:
readonly displayName?: string;
Tenant.emailPrivacyConfig
La configuración de privacidad del correo electrónico para el usuario
Firma:
readonly emailPrivacyConfig?: EmailPrivacyConfig;
Tenant.emailSignInConfig
La configuración del proveedor de acceso por correo electrónico.
Firma:
get emailSignInConfig(): EmailSignInProviderConfig | undefined;
Tenant.multiFactorConfig
La configuración de autenticación de varios factores del usuario actual.
Firma:
get multiFactorConfig(): MultiFactorConfig | undefined;
Tenant.passwordPolicyConfig
La configuración de la política de contraseñas para el usuario
Firma:
readonly passwordPolicyConfig?: PasswordPolicyConfig;
Tenant.recaptchaConfig
La configuración de autenticación de configuración de reCAPTCHA del usuario actual.
Firma:
get recaptchaConfig(): RecaptchaConfig | undefined;
Tenant.smsRegionConfig
La configuración de regiones de SMS para actualizar un usuario. Configura las regiones en las que los usuarios pueden enviar SMS de verificación. Se basa en el código de llamada del número de teléfono de destino.
Firma:
readonly smsRegionConfig?: SmsRegionConfig;
ID de usuario.
Es el identificador del usuario.
Firma:
readonly tenantId: string;
Tenant.testPhoneNumbers
El mapa que contiene los pares de números de teléfono / códigos de prueba del usuario.
Firma:
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Tenant.toJSON()
Muestra una representación JSON serializable de este objeto.
Firma:
toJSON(): object;
Muestra:
objeto
Una representación JSON serializable de este objeto.