Representa un usuario.
Firma:
export declare class UserRecord
Propiedades
| Propiedad | Modificadores | Tipo | Descripción |
|---|---|---|---|
| Reclamaciones personalizadas | { [clave: cadena]: cualquiera; } | El objeto de reclamos personalizado del usuario, si está disponible, generalmente se usa para definir roles de usuario y se propaga al token de ID de un usuario autenticado. Esto se configura a través de BaseAuth.setCustomUserClaims() | |
| desactivado | booleano | Si el usuario está deshabilitado o no: true para deshabilitado; false para habilitado. | |
| nombre para mostrar | cadena | El nombre para mostrar del usuario. | |
| correo electrónico | cadena | 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 | Metadatos de usuario | Metadatos adicionales sobre el usuario. | |
| multifactor | Configuración multifactor | Las propiedades relacionadas con múltiples factores para el usuario actual, si están disponibles. | |
| contraseñaHash | cadena | La contraseña hash del usuario (codificada en base64), solo si se utiliza el algoritmo hash de Firebase Auth (SCRYPT). Si se utilizó un algoritmo hash diferente al cargar este usuario, como es típico al migrar desde otro sistema de autenticación, será una cadena vacía. Si no se establece ninguna contraseña, ésta es nula. Esto sólo está disponible cuando el usuario se obtiene de BaseAuth.listUsers() . | |
| contraseñaSalt | cadena | La contraseña salt del usuario (codificada en base64), solo si se utiliza el algoritmo hash de Firebase Auth (SCRYPT). Si se utilizó un algoritmo hash diferente para cargar este usuario, típico cuando se migra desde otro sistema de autenticación, será una cadena vacía. Si no se establece ninguna contraseña, ésta es nula. Esto sólo está disponible cuando el usuario se obtiene de BaseAuth.listUsers() . | |
| número de teléfono | cadena | El número de teléfono principal del usuario, si está configurado. | |
| fotoURL | cadena | La URL de la foto del usuario. | |
| proveedorDatos | Información de usuario [] | Una serie de proveedores (por ejemplo, Google, Facebook) vinculados al usuario. | |
| ID de inquilino | cadena | nulo | El ID del inquilino al que pertenece el usuario, si está disponible. | |
| tokensValidAfterTime | cadena | La fecha posterior a la cual los tokens del usuario son válidos, formateada como una cadena UTC. Esto se actualiza cada vez que se revoca el token de actualización del usuario, ya sea desde la API BaseAuth.revokeRefreshTokens() o desde el backend de Firebase Auth en cambios importantes en la cuenta (restablecimiento de contraseña, actualizaciones de contraseña o correo electrónico, etc.). | |
| fluido | cadena | El uid del usuario. |
Métodos
| Método | Modificadores | Descripción |
|---|---|---|
| a JSON() | Devuelve una representación serializable JSON de este objeto. |
Registro de usuario.reclamaciones personalizadas
El objeto de reclamos personalizado del usuario, si está disponible, generalmente se usa para definir roles de usuario y se propaga al token de ID de un usuario autenticado. Esto se configura a través de BaseAuth.setCustomUserClaims()
Firma:
readonly customClaims?: {
[key: string]: any;
};
Registro de usuario.disabled
Si el usuario está deshabilitado o no: true para deshabilitado; false para habilitado.
Firma:
readonly disabled: boolean;
RegistroDeUsuario.NombreMostrar
El nombre para mostrar del usuario.
Firma:
readonly displayName?: string;
Registro de usuario.correo electrónico
El correo electrónico principal del usuario, si está configurado.
Firma:
readonly email?: string;
UserRecord.emailVerificado
Si se verifica o no el correo electrónico principal del usuario.
Firma:
readonly emailVerified: boolean;
Registro de usuario.metadatos
Metadatos adicionales sobre el usuario.
Firma:
readonly metadata: UserMetadata;
Registro de usuario.multiFactor
Las propiedades relacionadas con múltiples factores para el usuario actual, si están disponibles.
Firma:
readonly multiFactor?: MultiFactorSettings;
Registro de usuario.contraseñaHash
La contraseña hash del usuario (codificada en base64), solo si se utiliza el algoritmo hash de Firebase Auth (SCRYPT). Si se utilizó un algoritmo hash diferente al cargar este usuario, como es típico al migrar desde otro sistema de autenticación, será una cadena vacía. Si no se establece ninguna contraseña, ésta es nula. Esto sólo está disponible cuando el usuario se obtiene de BaseAuth.listUsers() .
Firma:
readonly passwordHash?: string;
Registro de usuario.contraseñaSalt
La contraseña salt del usuario (codificada en base64), solo si se utiliza el algoritmo hash de Firebase Auth (SCRYPT). Si se utilizó un algoritmo hash diferente para cargar este usuario, típico cuando se migra desde otro sistema de autenticación, será una cadena vacía. Si no se establece ninguna contraseña, ésta es nula. Esto sólo está disponible cuando el usuario se obtiene de BaseAuth.listUsers() .
Firma:
readonly passwordSalt?: string;
Registro de usuario.número de teléfono
El número de teléfono principal del usuario, si está configurado.
Firma:
readonly phoneNumber?: string;
Registro de usuario.URL de la foto
La URL de la foto del usuario.
Firma:
readonly photoURL?: string;
UserRecord.providerData
Una serie de proveedores (por ejemplo, Google, Facebook) vinculados al usuario.
Firma:
readonly providerData: UserInfo[];
UserRecord.tenantId
El ID del inquilino al que pertenece el usuario, si está disponible.
Firma:
readonly tenantId?: string | null;
UserRecord.tokensValidAfterTime
La fecha posterior a la cual los tokens del usuario son válidos, formateada como una cadena UTC. Esto se actualiza cada vez que se revoca el token de actualización del usuario, ya sea desde la API BaseAuth.revokeRefreshTokens() o desde el backend de Firebase Auth en cambios importantes en la cuenta (restablecimiento de contraseña, actualizaciones de contraseña o correo electrónico, etc.).
Firma:
readonly tokensValidAfterTime?: string;
Registro de usuario.uid
El uid del usuario. .
Firma:
readonly uid: string;
Registro de usuario.toJSON()
Devuelve una representación serializable JSON de este objeto.
Firma:
toJSON(): object;
Devoluciones:
objeto
Una representación serializable en JSON de este objeto.