UserRecord class

Rappresenta un utente.

Firma:

export declare class UserRecord 

Proprietà

Proprietà Modificatori Tipo Descrizione
customClaims { [chiave: stringa]: qualsiasi; } L'oggetto attestazioni personalizzate dell'utente, se disponibile, in genere utilizzato per definire i ruoli utente e propagato al token ID di un utente autenticato. Questo viene impostato tramite BaseAuth.setCustomUserClaims()
Disabilitato booleano Se l'utente è disabilitato o meno: true per disabili; false per abilitato.
nome da visualizzare corda Il nome visualizzato dell'utente.
e-mail corda L'e-mail principale dell'utente, se impostata.
email verificata booleano Se l'e-mail principale dell'utente è verificata o meno.
metadati Metadatiutente Metadati aggiuntivi sull'utente.
multifattore Impostazioni MultiFactor Le proprietà correlate a più fattori per l'utente corrente, se disponibili.
passwordHash corda La password con hash dell'utente (codificata base64), solo se viene utilizzato l'algoritmo di hashing Firebase Auth (SCRYPT). Se durante il caricamento di questo utente è stato utilizzato un algoritmo di hashing diverso, come avviene tipicamente durante la migrazione da un altro sistema di autenticazione, questa sarà una stringa vuota. Se non è impostata alcuna password, questa è nulla. Questo è disponibile solo quando l'utente viene ottenuto da BaseAuth.listUsers() .
passwordSale corda La password dell'utente salt (codificata base64), solo se viene utilizzato l'algoritmo di hashing Firebase Auth (SCRYPT). Se per caricare questo utente è stato utilizzato un algoritmo di hashing diverso, tipico durante la migrazione da un altro sistema di autenticazione, questa sarà una stringa vuota. Se non è impostata alcuna password, questa è nulla. Questo è disponibile solo quando l'utente viene ottenuto da BaseAuth.listUsers() .
numero di telefono corda Il numero di telefono principale dell'utente, se impostato.
fotoURL corda L'URL della foto dell'utente.
providerData Informazioni utente [] Una serie di fornitori (ad esempio Google, Facebook) collegati all'utente.
inquilinoId stringa | nullo L'ID del tenant a cui appartiene l'utente, se disponibile.
tokenValidAfterTime corda La data a partire dalla quale i token dell'utente sono validi, formattata come stringa UTC. Questo viene aggiornato ogni volta che il token di aggiornamento dell'utente viene revocato dall'API BaseAuth.revokeRefreshTokens() o dal backend Firebase Auth in caso di modifiche dell'account di grandi dimensioni (reimpostazione della password, aggiornamenti della password o della posta elettronica, ecc.).
fluido corda L' uid dell'utente.

Metodi

Metodo Modificatori Descrizione
aJSON() Restituisce una rappresentazione serializzabile JSON di questo oggetto.

UserRecord.customClaims

L'oggetto attestazioni personalizzate dell'utente, se disponibile, in genere utilizzato per definire i ruoli utente e propagato al token ID di un utente autenticato. Questo viene impostato tramite BaseAuth.setCustomUserClaims()

Firma:

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

UserRecord.disabilitato

Se l'utente è disabilitato o meno: true per disabili; false per abilitato.

Firma:

readonly disabled: boolean;

UserRecord.displayName

Il nome visualizzato dell'utente.

Firma:

readonly displayName?: string;

UserRecord.e-mail

L'e-mail principale dell'utente, se impostata.

Firma:

readonly email?: string;

UserRecord.emailVerificato

Se l'e-mail principale dell'utente è verificata o meno.

Firma:

readonly emailVerified: boolean;

UserRecord.metadati

Metadati aggiuntivi sull'utente.

Firma:

readonly metadata: UserMetadata;

Recordutente.multiFactor

Le proprietà correlate a più fattori per l'utente corrente, se disponibili.

Firma:

readonly multiFactor?: MultiFactorSettings;

UserRecord.passwordHash

La password con hash dell'utente (codificata base64), solo se viene utilizzato l'algoritmo di hashing Firebase Auth (SCRYPT). Se durante il caricamento di questo utente è stato utilizzato un algoritmo di hashing diverso, come avviene tipicamente durante la migrazione da un altro sistema di autenticazione, questa sarà una stringa vuota. Se non è impostata alcuna password, questa è nulla. Questo è disponibile solo quando l'utente viene ottenuto da BaseAuth.listUsers() .

Firma:

readonly passwordHash?: string;

UserRecord.passwordSalt

La password dell'utente salt (codificata base64), solo se viene utilizzato l'algoritmo di hashing Firebase Auth (SCRYPT). Se per caricare questo utente è stato utilizzato un algoritmo di hashing diverso, tipico durante la migrazione da un altro sistema di autenticazione, questa sarà una stringa vuota. Se non è impostata alcuna password, questa è nulla. Questo è disponibile solo quando l'utente viene ottenuto da BaseAuth.listUsers() .

Firma:

readonly passwordSalt?: string;

Recordutente.numerotelefono

Il numero di telefono principale dell'utente, se impostato.

Firma:

readonly phoneNumber?: string;

Recordutente.URLfoto

L'URL della foto dell'utente.

Firma:

readonly photoURL?: string;

UserRecord.providerData

Una serie di fornitori (ad esempio Google, Facebook) collegati all'utente.

Firma:

readonly providerData: UserInfo[];

UserRecord.tenantId

L'ID del tenant a cui appartiene l'utente, se disponibile.

Firma:

readonly tenantId?: string | null;

UserRecord.tokensValidAfterTime

La data a partire dalla quale i token dell'utente sono validi, formattata come stringa UTC. Questo viene aggiornato ogni volta che il token di aggiornamento dell'utente viene revocato dall'API BaseAuth.revokeRefreshTokens() o dal backend Firebase Auth in caso di modifiche dell'account di grandi dimensioni (reimpostazione della password, aggiornamenti della password o della posta elettronica, ecc.).

Firma:

readonly tokensValidAfterTime?: string;

UserRecord.uid

L' uid dell'utente .

Firma:

readonly uid: string;

UserRecord.toJSON()

Restituisce una rappresentazione serializzabile JSON di questo oggetto.

Firma:

toJSON(): object;

Ritorna:

oggetto

Una rappresentazione serializzabile JSON di questo oggetto.