Interfaz que representa a un usuario para importar a Firebase Auth a través del método BaseAuth.importUsers() .
Firma:
export interface UserImportRecord
Propiedades
| Propiedad | Escribe | Descripción |
|---|---|---|
| reclamos personalizados | { [clave: cadena]: cualquiera; } | El objeto de notificaciones personalizado del usuario, si está disponible, generalmente se usa para definir roles de usuario y se propaga a un token de ID de usuario autenticado. |
| desactivado | booleano | Si el usuario está deshabilitado o no: true para deshabilitado; false para habilitado. |
| nombre para mostrar | cuerda | El nombre para mostrar del usuario. |
| cuerda | El correo electrónico principal del usuario, si está configurado. | |
| Correo Electrónico Verificado | booleano | Si se verifica o no el correo electrónico principal del usuario. |
| metadatos | Solicitud de metadatos de usuario | Metadatos adicionales sobre el usuario. |
| multifactor | Ajustes de actualización multifactor | Las propiedades relacionadas con múltiples factores del usuario. |
| contraseñaHash | Buffer | El búfer de bytes que representa la contraseña hash del usuario. Cuando se va a importar un usuario con un hash de contraseña, es necesario especificar UserImportOptions para identificar el algoritmo hash utilizado para generar este hash. |
| contraseñaSalt | Buffer | El búfer de bytes que representa la sal de la contraseña del usuario. |
| número de teléfono | cuerda | El número de teléfono principal del usuario, si está configurado. |
| fotoURL | cuerda | URL de la foto del usuario. |
| proveedorDatos | Solicitud de proveedor de usuario [] | Una matriz de proveedores (por ejemplo, Google, Facebook) vinculados al usuario. |
| inquilinoId | cuerda | El identificador del arrendatario al que se va a importar el usuario. Cuando no se proporciona en un contexto admin.auth.Auth , el usuario se carga en el proyecto principal predeterminado. Cuando no se proporciona en un contexto admin.auth.TenantAwareAuth , el usuario se carga en el arrendatario correspondiente al ID de arrendatario de esa instancia de TenantAwareAuth . |
| fluido | cuerda | El uid del usuario. |
UserImportRecord.customClaims
El objeto de notificaciones personalizado del usuario, si está disponible, generalmente se usa para definir roles de usuario y se propaga a un token de ID de usuario autenticado.
Firma:
customClaims?: {
[key: string]: any;
};
UserImportRecord.deshabilitado
Si el usuario está deshabilitado o no: true para deshabilitado; false para habilitado.
Firma:
disabled?: boolean;
UserImportRecord.displayName
El nombre para mostrar del usuario.
Firma:
displayName?: string;
UserImportRecord.email
El correo electrónico principal del usuario, si está configurado.
Firma:
email?: string;
UserImportRecord.emailVerificado
Si se verifica o no el correo electrónico principal del usuario.
Firma:
emailVerified?: boolean;
UserImportRecord.metadatos
Metadatos adicionales sobre el usuario.
Firma:
metadata?: UserMetadataRequest;
UserImportRecord.multiFactor
Las propiedades relacionadas con múltiples factores del usuario.
Firma:
multiFactor?: MultiFactorUpdateSettings;
UserImportRecord.passwordHash
El búfer de bytes que representa la contraseña hash del usuario. Cuando se va a importar un usuario con un hash de contraseña, es necesario especificar UserImportOptions para identificar el algoritmo hash utilizado para generar este hash.
Firma:
passwordHash?: Buffer;
UserImportRecord.passwordSalt
El búfer de bytes que representa la sal de la contraseña del usuario.
Firma:
passwordSalt?: Buffer;
UserImportRecord.phoneNumber
El número de teléfono principal del usuario, si está configurado.
Firma:
phoneNumber?: string;
UserImportRecord.photoURL
URL de la foto del usuario.
Firma:
photoURL?: string;
UserImportRecord.providerData
Una matriz de proveedores (por ejemplo, Google, Facebook) vinculados al usuario.
Firma:
providerData?: UserProviderRequest[];
UserImportRecord.tenantId
El identificador del arrendatario al que se va a importar el usuario. Cuando no se proporciona en un contexto admin.auth.Auth , el usuario se carga en el proyecto principal predeterminado. Cuando no se proporciona en un contexto admin.auth.TenantAwareAuth , el usuario se carga en el arrendatario correspondiente al ID de arrendatario de esa instancia de TenantAwareAuth .
Firma:
tenantId?: string;
UserImportRecord.uid
El uid del usuario .
Firma:
uid: string;