UserRecord class

Representa a un usuario.

Firma:

export declare class UserRecord

Propiedades

Propiedad Teclas modificadoras Tipo Descripción
customClaims { [clave: cadena]: cualquiera; } El objeto de reclamaciones personalizadas del usuario, si está disponible, normalmente se usa para definir roles de usuario y se propaga a un token de ID de usuario autenticado. Esto se establece a través de BaseAuth.setCustomUserClaims().
inhabilitado booleano Si el usuario está inhabilitado o no: true para inhabilitado; false para habilitada.
displayName string El nombre visible del usuario.
email string La cuenta de correo electrónico principal del usuario, si se configuró.
emailVerified booleano Indica si se verificó el correo electrónico principal del usuario.
metadata UserMetadata Metadatos adicionales del usuario.
multifactor MultiFactorSettings Las propiedades relacionadas con varios factores para el usuario actual, si están disponibles.
contraseñaHash string La contraseña con hash del usuario (codificada en base64), solo si se usa el algoritmo de hash de Firebase Auth (SCRYPT). Si se usó un algoritmo de hash diferente cuando se subió este usuario, como es habitual cuando se migra desde otro sistema de Auth, la cadena estará vacía. Si no se establece una contraseña, el valor es nulo. Esto solo está disponible cuando el usuario se obtiene de BaseAuth.listUsers().
contraseñaSalto string La sal de la contraseña del usuario (codificada en base64), solo si se usa el algoritmo de hash de Firebase Auth (SCRYPT). Si se usó un algoritmo de hash diferente para subir este usuario, lo que es normal cuando se migra desde otro sistema de Auth, la cadena está vacía. Si no se establece una contraseña, el valor es nulo. Esto solo está disponible cuando el usuario se obtiene de BaseAuth.listUsers().
Númerodeteléfono string El número de teléfono principal del usuario, si se configuró.
URLdefoto string La URL de la foto del usuario.
Datos de proveedores Información del usuario Es un array de proveedores (por ejemplo, Google o Facebook) vinculados al usuario.
IDdeusuario cadena | nulo Es el ID del usuario al que pertenece el usuario, si está disponible.
tokensValidAfterTime string Es la fecha después de la que son válidos los tokens del usuario, con el formato de una cadena UTC. Esto se actualiza cada vez que se revoca el token de actualización del usuario, ya sea desde la API de BaseAuth.revokeRefreshTokens() o desde el backend de Firebase Auth en caso de cambios importantes en la cuenta (restablecimientos de contraseñas, actualizaciones de contraseñas o correos electrónicos, etc.).
UID string El uid del usuario.

Métodos

Método Teclas modificadoras Descripción
toJSON() Muestra una representación JSON serializable de este objeto.

UserRecord.customClaims

El objeto de reclamaciones personalizadas del usuario, si está disponible, normalmente se usa para definir roles de usuario y se propaga a un token de ID de usuario autenticado. Esto se establece a través de BaseAuth.setCustomUserClaims().

Firma:

readonly customClaims?: {
        [key: string]: any;
    };

UserRecord.inhabilitado

Si el usuario está inhabilitado o no: true para inhabilitado; false para habilitada.

Firma:

readonly disabled: boolean;

UserRecord.displayName

El nombre visible del usuario.

Firma:

readonly displayName?: string;

Registro.correoelectrónico

La cuenta de correo electrónico principal del usuario, si se configuró.

Firma:

readonly email?: string;

UserRecord.emailVerified

Indica si se verificó el correo electrónico principal del usuario.

Firma:

readonly emailVerified: boolean;

UserRecord.metadata

Metadatos adicionales del usuario.

Firma:

readonly metadata: UserMetadata;

UserRecord.multifactor

Las propiedades relacionadas con varios factores del usuario actual, si están disponibles.

Firma:

readonly multiFactor?: MultiFactorSettings;

Registrodeusuario.contraseñaHash

La contraseña con hash del usuario (codificada en base64), solo si se usa el algoritmo de hash de Firebase Auth (SCRYPT). Si se usó un algoritmo de hash diferente cuando se subió este usuario, como es habitual cuando se migra desde otro sistema de Auth, la cadena estará vacía. Si no se establece una contraseña, el valor es nulo. Esto solo está disponible cuando el usuario se obtiene de BaseAuth.listUsers().

Firma:

readonly passwordHash?: string;

UserRecord.passwordSalt

La sal de la contraseña del usuario (codificada en base64), solo si se usa el algoritmo de hash de Firebase Auth (SCRYPT). Si se usó un algoritmo de hash diferente para subir este usuario, lo que es habitual cuando se migra desde otro sistema de Auth, la cadena está vacía. Si no se establece una contraseña, el valor es nulo. Esto solo está disponible cuando el usuario se obtiene de BaseAuth.listUsers().

Firma:

readonly passwordSalt?: string;

NúmeroDeRegistrodelUsuario

El número de teléfono principal del usuario, si se configuró.

Firma:

readonly phoneNumber?: string;

URLDeRegistroDeUsuario

La URL de la foto del usuario.

Firma:

readonly photoURL?: string;

UserRecord.providerData

Es una matriz de proveedores (por ejemplo, Google o Facebook) vinculados al usuario.

Firma:

readonly providerData: UserInfo[];

Registrodeusuario.usuarioId

Es el ID del usuario al que pertenece el usuario, si está disponible.

Firma:

readonly tenantId?: string | null;

UserRecord.tokensValidAfterTime

Es la fecha después de la que son válidos los tokens del usuario, con el formato de una cadena UTC. Esto se actualiza cada vez que se revoca el token de actualización del usuario, ya sea desde la API de BaseAuth.revokeRefreshTokens() o desde el backend de Firebase Auth en caso de cambios importantes en la cuenta (restablecimientos de contraseñas, actualizaciones de contraseñas o correos electrónicos, etc.).

Firma:

readonly tokensValidAfterTime?: string;

UserRecord.uid

El uid del usuario.

Firma:

readonly uid: string;

UserRecord.toJSON()

Muestra una representación JSON serializable de este objeto.

Firma:

toJSON(): object;

Muestra:

objeto

Una representación JSON serializable de este objeto.