Interfejs reprezentujący użytkownika, który ma zostać zaimportowany do Uwierzytelniania Firebase za pomocą metody BaseAuth.importUsers().
Podpis:
export interface UserImportRecord
Właściwości
Właściwość | Typ | Opis |
---|---|---|
customClaims – | { [klucz: ciąg znaków]: any; | Obiekt deklaracji niestandardowych użytkownika (jeśli jest dostępny) jest zwykle używany do definiowania ról użytkownika i przesyłany do tokena tożsamości uwierzytelnionego użytkownika. |
wyłączony | wartość logiczna | Określa, czy użytkownik jest wyłączony: true – wyłączony; false dla włączonego. |
nazwawyświetlana | ciąg znaków | Wyświetlana nazwa użytkownika. |
ciąg znaków | Podstawowy adres e-mail użytkownika, jeśli jest ustawiony. | |
Zweryfikowany e-mail | wartość logiczna | Wskazuje, czy podstawowy adres e-mail użytkownika został zweryfikowany. |
metadane, | UserMetadataRequest | Dodatkowe metadane dotyczące użytkownika. |
multiFactor, | Ustawienia MultiFactorUpdateSettings | Właściwości użytkownika powiązane z wielofunkcyjnymi czynnikami. |
passwordHash | Bufor | Bufor bajtów przedstawiający zaszyfrowane hasło użytkownika. Podczas importowania użytkownika z haszem hasła należy określić algorytm UserImportOptions, aby zidentyfikować algorytm szyfrowania używany do wygenerowania tego skrótu. |
passwordSalt, | Bufor | Bufor bajtów reprezentujący ciąg zaburzający hasło użytkownika. |
numer telefonu | ciąg znaków | Podstawowy numer telefonu użytkownika, jeśli został ustawiony. |
URL zdjęcia | ciąg znaków | Adres URL zdjęcia użytkownika. |
providerData | UserProviderRequest[] | Tablica dostawców (np. Google, Facebook) powiązanych z użytkownikiem. |
tenantId, | ciąg znaków | Identyfikator najemcy, do którego ma zostać zaimportowany użytkownik. Jeśli nie podasz danych w kontekście admin.auth.Auth , użytkownik zostanie przesłany do domyślnego projektu nadrzędnego. Jeśli nie podano go w kontekście admin.auth.TenantAwareAuth , użytkownik jest przesyłany do najemcy odpowiadającego identyfikatorowi najemcy tej instancji TenantAwareAuth . |
UID | ciąg znaków | uid użytkownika. |
UserImportRecord.customClaims
Obiekt deklaracji niestandardowych użytkownika (jeśli jest dostępny) jest zwykle używany do definiowania ról użytkownika i przesyłany do tokena tożsamości uwierzytelnionego użytkownika.
Podpis:
customClaims?: {
[key: string]: any;
};
UserImportRecord.Disable
Określa, czy użytkownik jest wyłączony: true
– wyłączony; false
dla włączonego.
Podpis:
disabled?: boolean;
UserImportRecord.displayName
Wyświetlana nazwa użytkownika.
Podpis:
displayName?: string;
UserImportRecord.email
Podstawowy adres e-mail użytkownika, jeśli jest ustawiony.
Podpis:
email?: string;
UserImportRecord.emailVerified
Wskazuje, czy podstawowy adres e-mail użytkownika został zweryfikowany.
Podpis:
emailVerified?: boolean;
Rekord UserImportRecord.metadata
Dodatkowe metadane dotyczące użytkownika.
Podpis:
metadata?: UserMetadataRequest;
UserImportRecord.multiFactor
Właściwości użytkownika powiązane z wielofunkcyjnymi czynnikami.
Podpis:
multiFactor?: MultiFactorUpdateSettings;
UserImportRecord.passwordHash (UserImportRecord.passwordHash)
Bufor bajtów przedstawiający zaszyfrowane hasło użytkownika. Podczas importowania użytkownika z haszem hasła należy określić algorytm UserImportOptions, aby zidentyfikować algorytm szyfrowania używany do wygenerowania tego skrótu.
Podpis:
passwordHash?: Buffer;
UserImportRecord.passwordSalt
Bufor bajtów reprezentujący ciąg zaburzający hasło użytkownika.
Podpis:
passwordSalt?: Buffer;
Rekord UserImportRecord.phoneNumber
Podstawowy numer telefonu użytkownika, jeśli został ustawiony.
Podpis:
phoneNumber?: string;
UserImportRecord.photoURL
Adres URL zdjęcia użytkownika.
Podpis:
photoURL?: string;
Rekord UserImportRecord.providerData
Tablica dostawców (np. Google, Facebook) powiązanych z użytkownikiem.
Podpis:
providerData?: UserProviderRequest[];
Identyfikator obiektuUserImportRecord.tenantId
Identyfikator najemcy, do którego ma zostać zaimportowany użytkownik. Jeśli nie podasz danych w kontekście admin.auth.Auth
, użytkownik zostanie przesłany do domyślnego projektu nadrzędnego. Jeśli nie podano go w kontekście admin.auth.TenantAwareAuth
, użytkownik jest przesyłany do najemcy odpowiadającego identyfikatorowi najemcy tej instancji TenantAwareAuth
.
Podpis:
tenantId?: string;
UserImportRecord.uid
uid
użytkownika.
Podpis:
uid: string;