Representa a un usuario.
Firma:
export declare class UserRecord
Propiedades
Propiedad | modificadores | 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. Esto se establece a través de BaseAuth.setCustomUserClaims() | |
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 | 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 | cuerda | La contraseña hash del usuario (codificada en base64), solo si se usa el algoritmo hash Firebase Auth (SCRYPT). Si se usó un algoritmo hash diferente al cargar este usuario, como es típico cuando se migra desde otro sistema de autenticación, esta será una cadena vacía. Si no se establece una contraseña, esta es nula. Esto solo está disponible cuando el usuario se obtiene de BaseAuth.listUsers() . | |
contraseñaSalt | cuerda | La contraseña del usuario salt (codificada en base64), solo si se usa el algoritmo hash Firebase Auth (SCRYPT). Si se usó un algoritmo hash diferente para cargar este usuario, típico cuando se migra desde otro sistema de autenticación, esta será una cadena vacía. Si no se establece una contraseña, esta es nula. Esto solo está disponible cuando el usuario se obtiene de BaseAuth.listUsers() . | |
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 | Información de usuario [] | Una matriz de proveedores (por ejemplo, Google, Facebook) vinculados al usuario. | |
inquilinoId | cadena | nulo | El ID del arrendatario al que pertenece el usuario, si está disponible. | |
tokensValidAfterTime | cuerda | La fecha a partir de la cual los tokens del usuario son válidos, con formato de cadena UTC. Esto se actualiza cada vez que se revoca el token de actualización del usuario desde la API BaseAuth.revokeRefreshTokens() o desde el backend de Firebase Auth en cambios importantes en la cuenta (restablecimientos de contraseña, actualizaciones de contraseña o correo electrónico, etc.). | |
fluido | cuerda | El uid del usuario. |
Métodos
Método | Modificadores | Descripción |
---|---|---|
aJSON() | Devuelve una representación JSON serializable de este objeto. |
UserRecord.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. Esto se establece a través de BaseAuth.setCustomUserClaims()
Firma:
readonly customClaims?: {
[key: string]: any;
};
UserRecord.deshabilitado
Si el usuario está deshabilitado o no: true
para deshabilitado; false
para habilitado.
Firma:
readonly disabled: boolean;
UserRecord.displayName
El nombre para mostrar del usuario.
Firma:
readonly displayName?: string;
UserRecord.email
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;
UserRecord.metadatos
Metadatos adicionales sobre el usuario.
Firma:
readonly metadata: UserMetadata;
UserRecord.multiFactor
Las propiedades relacionadas con múltiples factores para el usuario actual, si están disponibles.
Firma:
readonly multiFactor?: MultiFactorSettings;
UserRecord.passwordHash
La contraseña hash del usuario (codificada en base64), solo si se usa el algoritmo hash Firebase Auth (SCRYPT). Si se usó un algoritmo hash diferente al cargar este usuario, como es típico cuando se migra desde otro sistema de autenticación, esta será una cadena vacía. Si no se establece una contraseña, esta es nula. Esto solo está disponible cuando el usuario se obtiene de BaseAuth.listUsers() .
Firma:
readonly passwordHash?: string;
UserRecord.passwordSalt
La contraseña del usuario salt (codificada en base64), solo si se usa el algoritmo hash Firebase Auth (SCRYPT). Si se usó un algoritmo hash diferente para cargar este usuario, típico cuando se migra desde otro sistema de autenticación, esta será una cadena vacía. Si no se establece una contraseña, esta es nula. Esto solo está disponible cuando el usuario se obtiene de BaseAuth.listUsers() .
Firma:
readonly passwordSalt?: string;
UserRecord.phoneNumber
El número de teléfono principal del usuario, si está configurado.
Firma:
readonly phoneNumber?: string;
UserRecord.photoURL
URL de la foto del usuario.
Firma:
readonly photoURL?: string;
UserRecord.providerData
Una matriz de proveedores (por ejemplo, Google, Facebook) vinculados al usuario.
Firma:
readonly providerData: UserInfo[];
UserRecord.tenantId
El ID del arrendatario al que pertenece el usuario, si está disponible.
Firma:
readonly tenantId?: string | null;
UserRecord.tokensValidAfterTime
La fecha a partir de la cual los tokens del usuario son válidos, con formato de cadena UTC. Esto se actualiza cada vez que se revoca el token de actualización del usuario desde la API BaseAuth.revokeRefreshTokens() o desde el backend de Firebase Auth en cambios importantes en la cuenta (restablecimientos de contraseña, actualizaciones de contraseña o correo electrónico, etc.).
Firma:
readonly tokensValidAfterTime?: string;
RegistroUsuario.uid
El uid
del usuario .
Firma:
readonly uid: string;
Registro de usuario.toJSON()
Devuelve una representación JSON serializable de este objeto.
Firma:
toJSON(): object;
Devoluciones:
objeto
Una representación JSON serializable de este objeto.