UserRecord class

Stellt einen Benutzer dar.

Unterschrift:

export declare class UserRecord 

Eigenschaften

Eigentum Modifikatoren Typ Beschreibung
benutzerdefinierteAnsprüche { [key: string]: any; } Das benutzerdefinierte Anspruchsobjekt des Benutzers, falls verfügbar, wird normalerweise zum Definieren von Benutzerrollen verwendet und an das ID-Token eines authentifizierten Benutzers weitergegeben. Dies wird über BaseAuth.setCustomUserClaims() festgelegt.
deaktiviert Boolescher Wert Ob der Benutzer deaktiviert ist oder nicht: true für deaktiviert; false für aktiviert.
Anzeigename Zeichenfolge Der Anzeigename des Benutzers.
Email Zeichenfolge Die primäre E-Mail-Adresse des Benutzers, sofern festgelegt.
Email überprüft Boolescher Wert Ob die primäre E-Mail-Adresse des Benutzers überprüft wird oder nicht.
Metadaten Benutzermetadaten Zusätzliche Metadaten über den Benutzer.
Multifaktor MultiFactorSettings Die multifaktorbezogenen Eigenschaften für den aktuellen Benutzer, sofern verfügbar.
PasswortHash Zeichenfolge Das gehashte Passwort des Benutzers (Base64-kodiert), nur wenn der Firebase Auth-Hashing-Algorithmus (SCRYPT) verwendet wird. Wenn beim Hochladen dieses Benutzers ein anderer Hashing-Algorithmus verwendet wurde, wie es bei der Migration von einem anderen Auth-System üblich ist, ist dies eine leere Zeichenfolge. Wenn kein Passwort festgelegt ist, ist dies null. Dies ist nur verfügbar, wenn der Benutzer von BaseAuth.listUsers() abgerufen wird. .
PasswortSalt Zeichenfolge Der Passwort-Salt des Benutzers (Base64-kodiert), nur wenn der Firebase Auth-Hashing-Algorithmus (SCRYPT) verwendet wird. Wenn zum Hochladen dieses Benutzers ein anderer Hashing-Algorithmus verwendet wurde, wie es bei der Migration von einem anderen Auth-System üblich ist, ist dies eine leere Zeichenfolge. Wenn kein Passwort festgelegt ist, ist dies null. Dies ist nur verfügbar, wenn der Benutzer von BaseAuth.listUsers() abgerufen wird. .
Telefonnummer Zeichenfolge Die primäre Telefonnummer des Benutzers, falls festgelegt.
FotoURL Zeichenfolge Die Foto-URL des Benutzers.
ProviderData Benutzerinformation [] Eine Reihe von Anbietern (z. B. Google, Facebook), die mit dem Benutzer verknüpft sind.
Mieter-ID Zeichenfolge | Null Die ID des Mandanten, zu dem der Benutzer gehört, falls verfügbar.
tokensValidAfterTime Zeichenfolge Das Datum, ab dem die Token des Benutzers gültig sind, formatiert als UTC-Zeichenfolge. Dies wird jedes Mal aktualisiert, wenn das Aktualisierungstoken des Benutzers entweder über die BaseAuth.revokeRefreshTokens()- API oder über das Firebase Auth-Backend bei großen Kontoänderungen (Zurücksetzen des Passworts, Passwort- oder E-Mail-Aktualisierungen usw.) widerrufen wird.
uid Zeichenfolge Die uid des Benutzers.

Methoden

Methode Modifikatoren Beschreibung
toJSON() Gibt eine JSON-serialisierbare Darstellung dieses Objekts zurück.

UserRecord.customClaims

Das benutzerdefinierte Anspruchsobjekt des Benutzers, falls verfügbar, wird normalerweise zum Definieren von Benutzerrollen verwendet und an das ID-Token eines authentifizierten Benutzers weitergegeben. Dies wird über BaseAuth.setCustomUserClaims() festgelegt.

Unterschrift:

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

UserRecord.disabled

Ob der Benutzer deaktiviert ist oder nicht: true für deaktiviert; false für aktiviert.

Unterschrift:

readonly disabled: boolean;

UserRecord.displayName

Der Anzeigename des Benutzers.

Unterschrift:

readonly displayName?: string;

UserRecord.email

Die primäre E-Mail-Adresse des Benutzers, sofern festgelegt.

Unterschrift:

readonly email?: string;

UserRecord.emailVerified

Ob die primäre E-Mail-Adresse des Benutzers überprüft wird oder nicht.

Unterschrift:

readonly emailVerified: boolean;

UserRecord.metadata

Zusätzliche Metadaten über den Benutzer.

Unterschrift:

readonly metadata: UserMetadata;

UserRecord.multiFactor

Die multifaktorbezogenen Eigenschaften für den aktuellen Benutzer, sofern verfügbar.

Unterschrift:

readonly multiFactor?: MultiFactorSettings;

UserRecord.passwordHash

Das gehashte Passwort des Benutzers (Base64-kodiert), nur wenn der Firebase Auth-Hashing-Algorithmus (SCRYPT) verwendet wird. Wenn beim Hochladen dieses Benutzers ein anderer Hashing-Algorithmus verwendet wurde, wie es bei der Migration von einem anderen Auth-System üblich ist, ist dies eine leere Zeichenfolge. Wenn kein Passwort festgelegt ist, ist dies null. Dies ist nur verfügbar, wenn der Benutzer von BaseAuth.listUsers() abgerufen wird. .

Unterschrift:

readonly passwordHash?: string;

UserRecord.passwordSalt

Der Passwort-Salt des Benutzers (Base64-kodiert), nur wenn der Firebase Auth-Hashing-Algorithmus (SCRYPT) verwendet wird. Wenn zum Hochladen dieses Benutzers ein anderer Hashing-Algorithmus verwendet wurde, wie es bei der Migration von einem anderen Auth-System üblich ist, ist dies eine leere Zeichenfolge. Wenn kein Passwort festgelegt ist, ist dies null. Dies ist nur verfügbar, wenn der Benutzer von BaseAuth.listUsers() abgerufen wird. .

Unterschrift:

readonly passwordSalt?: string;

UserRecord.phoneNumber

Die primäre Telefonnummer des Benutzers, falls festgelegt.

Unterschrift:

readonly phoneNumber?: string;

UserRecord.photoURL

Die Foto-URL des Benutzers.

Unterschrift:

readonly photoURL?: string;

UserRecord.providerData

Eine Reihe von Anbietern (z. B. Google, Facebook), die mit dem Benutzer verknüpft sind.

Unterschrift:

readonly providerData: UserInfo[];

UserRecord.tenantId

Die ID des Mandanten, zu dem der Benutzer gehört, falls verfügbar.

Unterschrift:

readonly tenantId?: string | null;

UserRecord.tokensValidAfterTime

Das Datum, ab dem die Token des Benutzers gültig sind, formatiert als UTC-Zeichenfolge. Dies wird jedes Mal aktualisiert, wenn das Aktualisierungstoken des Benutzers entweder über die BaseAuth.revokeRefreshTokens()- API oder über das Firebase Auth-Backend bei großen Kontoänderungen (Zurücksetzen des Passworts, Passwort- oder E-Mail-Aktualisierungen usw.) widerrufen wird.

Unterschrift:

readonly tokensValidAfterTime?: string;

UserRecord.uid

Die uid des Benutzers .

Unterschrift:

readonly uid: string;

UserRecord.toJSON()

Gibt eine JSON-serialisierbare Darstellung dieses Objekts zurück.

Unterschrift:

toJSON(): object;

Kehrt zurück:

Objekt

Eine JSON-serialisierbare Darstellung dieses Objekts.