Antarmuka yang mewakili pengguna untuk diimpor ke Firebase Auth melalui metode BaseAuth.importUsers() .
Tanda tangan:
export interface UserImportRecord
Properti
| Properti | Jenis | Keterangan |
|---|---|---|
| Klaim khusus | { [kunci: string]: apa saja; } | Objek klaim khusus pengguna, jika tersedia, biasanya digunakan untuk menentukan peran pengguna dan disebarkan ke token ID pengguna yang diautentikasi. |
| dengan disabilitas | boolean | Apakah pengguna dinonaktifkan atau tidak: true untuk dinonaktifkan; false untuk diaktifkan. |
| nama tampilan | rangkaian | Nama tampilan pengguna. |
| surel | rangkaian | Email utama pengguna, jika disetel. |
| email terverifikasi | boolean | Apakah email utama pengguna terverifikasi atau tidak. |
| metadata | Permintaan Metadata Pengguna | Metadata tambahan tentang pengguna. |
| multiFaktor | Pengaturan Pembaruan MultiFactor | Properti terkait multi-faktor pengguna. |
| kata sandiHash | Penyangga | Buffer byte yang mewakili kata sandi hash pengguna. Ketika pengguna akan diimpor dengan hash kata sandi, UserImportOptions harus ditentukan untuk mengidentifikasi algoritma hashing yang digunakan untuk menghasilkan hash ini. |
| kata sandiSalt | Penyangga | Buffer byte yang mewakili garam kata sandi pengguna. |
| nomor telepon | rangkaian | Nomor telepon utama pengguna, jika disetel. |
| URL foto | rangkaian | URL foto pengguna. |
| penyediaData | Permintaan Penyedia Pengguna [] | Serangkaian penyedia (misalnya, Google, Facebook) yang ditautkan ke pengguna. |
| penyewaId | rangkaian | Pengidentifikasi penyewa tempat pengguna akan diimpor. Jika tidak disediakan dalam konteks admin.auth.Auth , pengguna akan diunggah ke proyek induk default. Jika tidak disediakan dalam konteks admin.auth.TenantAwareAuth , pengguna akan diunggah ke penyewa yang sesuai dengan ID penyewa instans TenantAwareAuth tersebut. |
| uid | rangkaian | uid pengguna. |
UserImportRecord.customClaims
Objek klaim khusus pengguna, jika tersedia, biasanya digunakan untuk menentukan peran pengguna dan disebarkan ke token ID pengguna yang diautentikasi.
Tanda tangan:
customClaims?: {
[key: string]: any;
};
UserImportRecord.dinonaktifkan
Apakah pengguna dinonaktifkan atau tidak: true untuk dinonaktifkan; false untuk diaktifkan.
Tanda tangan:
disabled?: boolean;
UserImportRecord.displayName
Nama tampilan pengguna.
Tanda tangan:
displayName?: string;
UserImportRecord.email
Email utama pengguna, jika disetel.
Tanda tangan:
email?: string;
UserImportRecord.emailTerverifikasi
Apakah email utama pengguna terverifikasi atau tidak.
Tanda tangan:
emailVerified?: boolean;
UserImportRecord.metadata
Metadata tambahan tentang pengguna.
Tanda tangan:
metadata?: UserMetadataRequest;
UserImportRecord.multiFactor
Properti terkait multi-faktor pengguna.
Tanda tangan:
multiFactor?: MultiFactorUpdateSettings;
UserImportRecord.passwordHash
Buffer byte yang mewakili kata sandi hash pengguna. Ketika pengguna akan diimpor dengan hash kata sandi, UserImportOptions harus ditentukan untuk mengidentifikasi algoritma hashing yang digunakan untuk menghasilkan hash ini.
Tanda tangan:
passwordHash?: Buffer;
UserImportRecord.passwordSalt
Buffer byte yang mewakili garam kata sandi pengguna.
Tanda tangan:
passwordSalt?: Buffer;
UserImportRecord.phoneNumber
Nomor telepon utama pengguna, jika disetel.
Tanda tangan:
phoneNumber?: string;
UserImportRecord.photoURL
URL foto pengguna.
Tanda tangan:
photoURL?: string;
UserImportRecord.providerData
Serangkaian penyedia (misalnya, Google, Facebook) yang ditautkan ke pengguna.
Tanda tangan:
providerData?: UserProviderRequest[];
UserImportRecord.tenantId
Pengidentifikasi penyewa tempat pengguna akan diimpor. Jika tidak disediakan dalam konteks admin.auth.Auth , pengguna akan diunggah ke proyek induk default. Jika tidak disediakan dalam konteks admin.auth.TenantAwareAuth , pengguna akan diunggah ke penyewa yang sesuai dengan ID penyewa instans TenantAwareAuth tersebut.
Tanda tangan:
tenantId?: string;
UserImportRecord.uid
uid pengguna .
Tanda tangan:
uid: string;