UserRecord class

Représente un utilisateur.

Signature:

export declare class UserRecord 

Propriétés

Méthodes

UserRecord.customClaims

Objet de revendications personnalisées de l'utilisateur, s'il est disponible, généralement utilisé pour définir les rôles d'utilisateur et propagé vers le jeton d'identification d'un utilisateur authentifié. Ceci est défini via BaseAuth.setCustomUserClaims()

Signature:

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

UserRecord.disabled

Que l'utilisateur soit désactivé ou non : true pour désactivé ; false pour activé.

Signature:

readonly disabled: boolean;

UserRecord.displayName

Le nom d’affichage de l’utilisateur.

Signature:

readonly displayName?: string;

UserRecord.email

L'e-mail principal de l'utilisateur, si défini.

Signature:

readonly email?: string;

UserRecord.emailVérifié

Si l'adresse e-mail principale de l'utilisateur est vérifiée ou non.

Signature:

readonly emailVerified: boolean;

UserRecord.metadonnées

Métadonnées supplémentaires sur l'utilisateur.

Signature:

readonly metadata: UserMetadata;

UserRecord.multiFactor

Les propriétés liées à plusieurs facteurs pour l’utilisateur actuel, si disponibles.

Signature:

readonly multiFactor?: MultiFactorSettings;

UserRecord.passwordHash

Le mot de passe haché de l'utilisateur (codé en base64), uniquement si l'algorithme de hachage Firebase Auth (SCRYPT) est utilisé. Si un algorithme de hachage différent a été utilisé lors du téléchargement de cet utilisateur, comme c'est généralement le cas lors d'une migration depuis un autre système d'authentification, ce sera une chaîne vide. Si aucun mot de passe n'est défini, celui-ci est nul. Ceci n'est disponible que lorsque l'utilisateur est obtenu à partir de BaseAuth.listUsers() .

Signature:

readonly passwordHash?: string;

UserRecord.passwordSalt

Le sel du mot de passe de l'utilisateur (codé en base64), uniquement si l'algorithme de hachage Firebase Auth (SCRYPT) est utilisé. Si un algorithme de hachage différent avait été utilisé pour télécharger cet utilisateur, ce qui est typique lors d'une migration depuis un autre système d'authentification, ce sera une chaîne vide. Si aucun mot de passe n'est défini, celui-ci est nul. Ceci n'est disponible que lorsque l'utilisateur est obtenu à partir de BaseAuth.listUsers() .

Signature:

readonly passwordSalt?: string;

UserRecord.phoneNumber

Le numéro de téléphone principal de l'utilisateur, s'il est défini.

Signature:

readonly phoneNumber?: string;

UserRecord.photoURL

L'URL de la photo de l'utilisateur.

Signature:

readonly photoURL?: string;

UserRecord.providerData

Un ensemble de fournisseurs (par exemple Google, Facebook) liés à l'utilisateur.

Signature:

readonly providerData: UserInfo[];

UserRecord.tenantId

L’ID du locataire auquel appartient l’utilisateur, si disponible.

Signature:

readonly tenantId?: string | null;

UserRecord.tokensValidAfterTime

Date après laquelle les jetons de l'utilisateur sont valides, formatée sous forme de chaîne UTC. Ceci est mis à jour chaque fois que le jeton d'actualisation de l'utilisateur est révoqué soit depuis l'API BaseAuth.revokeRefreshTokens() , soit depuis le backend Firebase Auth lors de modifications importantes du compte (réinitialisations de mot de passe, mises à jour de mot de passe ou d'e-mail, etc.).

Signature:

readonly tokensValidAfterTime?: string;

UserRecord.uid

L' uid de l'utilisateur .

Signature:

readonly uid: string;

UserRecord.toJSON()

Renvoie une représentation sérialisable JSON de cet objet.

Signature:

toJSON(): object;

Retour:

objet

Une représentation sérialisable JSON de cet objet.