Interfejs reprezentujący użytkownika do importu do Firebase Auth za pomocą metody BaseAuth.importUsers() .
Podpis:
export interface UserImportRecord
Nieruchomości
Nieruchomość | Typ | Opis |
---|---|---|
niestandardowe roszczenia | { [klucz: ciąg znaków]: dowolny; } | Niestandardowy obiekt oświadczeń użytkownika, jeśli jest dostępny, zwykle używany do definiowania ról użytkowników i propagowany do tokenu identyfikatora uwierzytelnionego użytkownika. |
wyłączony | wartość logiczna | Niezależnie od tego, czy użytkownik jest wyłączony: true dla wyłączonego; false dla włączonego. |
wyświetlana nazwa | strunowy | Wyświetlana nazwa użytkownika. |
strunowy | Główny adres e-mail użytkownika, jeśli jest ustawiony. | |
e-mail zweryfikowany | wartość logiczna | Określa, czy główny adres e-mail użytkownika został zweryfikowany. |
metadane | Żądanie metadanych użytkownika | Dodatkowe metadane o użytkowniku. |
wieloczynnikowy | Ustawienia MultiFactorUpdate | Wieloczynnikowe właściwości użytkownika. |
Hasło Hasła | Bufor | Bufor bajtów reprezentujący zaszyfrowane hasło użytkownika. Jeśli użytkownik ma zostać zaimportowany ze skrótem hasła, należy określić opcję UserImportOptions w celu zidentyfikowania algorytmu mieszania użytego do wygenerowania tego skrótu. |
hasłoSól | Bufor | Bufor bajtów reprezentujący hasło użytkownika. |
numer telefonu | strunowy | Główny numer telefonu użytkownika, jeśli jest ustawiony. |
adres URL zdjęcia | strunowy | Adres URL zdjęcia użytkownika. |
Dane dostawcy | Żądanie dostawcy użytkownika [] | Szereg dostawców (na przykład Google, Facebook) powiązanych z użytkownikiem. |
identyfikator najemcy | strunowy | Identyfikator dzierżawy, do którego użytkownik ma zostać zaimportowany. Jeśli nie zostanie podany w kontekście admin.auth.Auth , użytkownik zostanie przesłany do domyślnego projektu nadrzędnego. Jeśli nie zostanie podany w kontekście admin.auth.TenantAwareAuth , użytkownik zostanie przesłany do dzierżawy odpowiadającej identyfikatorowi dzierżawy tej instancji TenantAwareAuth . |
uid | strunowy | uid użytkownika. |
UserImportRecord.customClaims
Niestandardowy obiekt oświadczeń użytkownika, jeśli jest dostępny, zwykle używany do definiowania ról użytkowników i propagowany do tokenu identyfikatora uwierzytelnionego użytkownika.
Podpis:
customClaims?: {
[key: string]: any;
};
UserImportRecord.wyłączone
Niezależnie od tego, czy użytkownik jest wyłączony: true
dla wyłączonego; false
dla włączonego.
Podpis:
disabled?: boolean;
UserImportRecord.displayName
Wyświetlana nazwa użytkownika.
Podpis:
displayName?: string;
UserImportRecord.e-mail
Główny adres e-mail użytkownika, jeśli jest ustawiony.
Podpis:
email?: string;
UserImportRecord.emailZweryfikowano
Określa, czy główny adres e-mail użytkownika został zweryfikowany.
Podpis:
emailVerified?: boolean;
UserImportRecord.metadane
Dodatkowe metadane o użytkowniku.
Podpis:
metadata?: UserMetadataRequest;
UserImportRecord.multiFactor
Wieloczynnikowe właściwości użytkownika.
Podpis:
multiFactor?: MultiFactorUpdateSettings;
UserImportRecord.passwordHash
Bufor bajtów reprezentujący zaszyfrowane hasło użytkownika. Jeśli użytkownik ma zostać zaimportowany ze skrótem hasła, należy określić opcję UserImportOptions w celu zidentyfikowania algorytmu mieszania użytego do wygenerowania tego skrótu.
Podpis:
passwordHash?: Buffer;
UserImportRecord.hasłoSól
Bufor bajtów reprezentujący hasło użytkownika.
Podpis:
passwordSalt?: Buffer;
UserImportRecord.phoneNumber
Główny numer telefonu użytkownika, jeśli jest ustawiony.
Podpis:
phoneNumber?: string;
UserImportRecord.photoURL
Adres URL zdjęcia użytkownika.
Podpis:
photoURL?: string;
Dane użytkownikaImportRecord.providerData
Szereg dostawców (na przykład Google, Facebook) powiązanych z użytkownikiem.
Podpis:
providerData?: UserProviderRequest[];
UserImportRecord.tenantId
Identyfikator dzierżawy, do którego użytkownik ma zostać zaimportowany. Jeśli nie zostanie podany w kontekście admin.auth.Auth
, użytkownik zostanie przesłany do domyślnego projektu nadrzędnego. Jeśli nie zostanie podany w kontekście admin.auth.TenantAwareAuth
, użytkownik zostanie przesłany do dzierżawy odpowiadającej identyfikatorowi dzierżawy tej instancji TenantAwareAuth
.
Podpis:
tenantId?: string;
UserImportRecord.uid
uid
użytkownika .
Podpis:
uid: string;