UserImportRecord interface

Schnittstelle, die einen Benutzer darstellt, der über die Methode BaseAuth.importUsers() in Firebase Auth importiert werden soll.

Unterschrift:

export interface UserImportRecord

Eigenschaften

Eigentum 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.
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 UserMetadataRequest Zusätzliche Metadaten über den Benutzer.
Multifaktor MultiFactorUpdateSettings Die multifaktorbezogenen Eigenschaften des Benutzers.
PasswortHash Puffer Der Bytepuffer, der das gehashte Passwort des Benutzers darstellt. Wenn ein Benutzer mit einem Passwort-Hash importiert werden soll, müssen UserImportOptions angegeben werden, um den Hash-Algorithmus zu identifizieren, der zum Generieren dieses Hashs verwendet wird.
PasswortSalt Puffer Der Bytepuffer, der den Passwort-Salt des Benutzers darstellt.
Telefonnummer Zeichenfolge Die primäre Telefonnummer des Benutzers, falls festgelegt.
FotoURL Zeichenfolge Die Foto-URL des Benutzers.
ProviderData UserProviderRequest [] Eine Reihe von Anbietern (z. B. Google, Facebook), die mit dem Benutzer verknüpft sind.
Mieter-ID Zeichenfolge Die Kennung des Mandanten, in den der Benutzer importiert werden soll. Wenn es nicht in einem admin.auth.Auth Kontext bereitgestellt wird, wird der Benutzer in das standardmäßige übergeordnete Projekt hochgeladen. Wenn der Benutzer nicht in einem admin.auth.TenantAwareAuth Kontext bereitgestellt wird, wird er auf den Mandanten hochgeladen, der der Mandanten-ID dieser TenantAwareAuth Instanz entspricht.
uid Zeichenfolge Die uid des Benutzers.

UserImportRecord.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.

Unterschrift:

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

UserImportRecord.disabled

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

Unterschrift:

disabled?: boolean;

UserImportRecord.displayName

Der Anzeigename des Benutzers.

Unterschrift:

displayName?: string;

UserImportRecord.email

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

Unterschrift:

email?: string;

UserImportRecord.emailVerified

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

Unterschrift:

emailVerified?: boolean;

UserImportRecord.metadata

Zusätzliche Metadaten über den Benutzer.

Unterschrift:

metadata?: UserMetadataRequest;

UserImportRecord.multiFactor

Die multifaktorbezogenen Eigenschaften des Benutzers.

Unterschrift:

multiFactor?: MultiFactorUpdateSettings;

UserImportRecord.passwordHash

Der Bytepuffer, der das gehashte Passwort des Benutzers darstellt. Wenn ein Benutzer mit einem Passwort-Hash importiert werden soll, müssen UserImportOptions angegeben werden, um den Hash-Algorithmus zu identifizieren, der zum Generieren dieses Hashs verwendet wird.

Unterschrift:

passwordHash?: Buffer;

UserImportRecord.passwordSalt

Der Bytepuffer, der den Passwort-Salt des Benutzers darstellt.

Unterschrift:

passwordSalt?: Buffer;

UserImportRecord.phoneNumber

Die primäre Telefonnummer des Benutzers, falls festgelegt.

Unterschrift:

phoneNumber?: string;

UserImportRecord.photoURL

Die Foto-URL des Benutzers.

Unterschrift:

photoURL?: string;

UserImportRecord.providerData

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

Unterschrift:

providerData?: UserProviderRequest[];

UserImportRecord.tenantId

Die Kennung des Mandanten, in den der Benutzer importiert werden soll. Wenn es nicht in einem admin.auth.Auth Kontext bereitgestellt wird, wird der Benutzer in das standardmäßige übergeordnete Projekt hochgeladen. Wenn der Benutzer nicht in einem admin.auth.TenantAwareAuth Kontext bereitgestellt wird, wird er auf den Mandanten hochgeladen, der der Mandanten-ID dieser TenantAwareAuth Instanz entspricht.

Unterschrift:

tenantId?: string;

UserImportRecord.uid

Die uid des Benutzers .

Unterschrift:

uid: string;