Antarmuka yang mewakili pengguna untuk diimpor ke Firebase Auth melalui metode BaseAuth.importUsers().
Tanda Tangan:
export interface UserImportRecord
Properti
Properti | Jenis | Deskripsi |
---|---|---|
Klaim kustom | { [key: string]: apa pun; } | Objek klaim kustom pengguna jika tersedia, biasanya digunakan untuk menentukan peran pengguna dan diterapkan ke token ID pengguna yang diautentikasi. |
dinonaktifkan | boolean | Apakah pengguna dinonaktifkan atau tidak: true untuk dinonaktifkan; false untuk diaktifkan. |
namatampilan | string | Nama pengguna yang ditampilkan. |
string | Email utama pengguna, jika ditetapkan. | |
emailTerverifikasi | boolean | Apakah email utama pengguna telah diverifikasi atau belum. |
metadata | UserMetadataRequest | Metadata tambahan tentang pengguna. |
multiFaktor | MultiFactorUpdateSettings | Properti terkait multi-faktor pengguna. |
passwordHash | Tambahan | Buffering byte yang mewakili sandi yang di-hash pengguna. Saat pengguna diimpor dengan hash sandi, UserImportOptions harus ditentukan untuk mengidentifikasi algoritma hashing yang digunakan untuk membuat hash ini. |
passwordSalt | Tambahan | Buffering byte yang mewakili salt sandi pengguna. |
Nomor Telepon | string | Nomor telepon utama pengguna, jika ditetapkan. |
photoURL | string | URL foto pengguna. |
providerData | UserProviderRequest[] | Array penyedia (misalnya, Google, Facebook) yang ditautkan ke pengguna. |
tenantId | string | ID tenant tempat pengguna akan diimpor. Jika tidak disediakan dalam konteks admin.auth.Auth , pengguna akan diupload ke project induk default. Jika tidak diberikan dalam konteks admin.auth.TenantAwareAuth , pengguna akan diupload ke tenant yang sesuai dengan ID tenant instance TenantAwareAuth tersebut. |
uid | string | uid pengguna. |
UserImportRecord.customKlaim
Objek klaim kustom pengguna jika tersedia, biasanya digunakan untuk menentukan peran pengguna dan diterapkan 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 pengguna yang ditampilkan.
Tanda Tangan:
displayName?: string;
UserImportRecord.email
Email utama pengguna, jika ditetapkan.
Tanda Tangan:
email?: string;
UserImportRecord.emailDiverifikasi
Apakah email utama pengguna telah diverifikasi atau belum.
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
Buffering byte yang mewakili sandi yang di-hash pengguna. Saat pengguna diimpor dengan hash sandi, UserImportOptions harus ditentukan untuk mengidentifikasi algoritma hashing yang digunakan untuk membuat hash ini.
Tanda Tangan:
passwordHash?: Buffer;
UserImportRecord.passwordSalt
Buffering byte yang mewakili salt sandi pengguna.
Tanda Tangan:
passwordSalt?: Buffer;
UserImportRecord.phoneNumber
Nomor telepon utama pengguna, jika ditetapkan.
Tanda Tangan:
phoneNumber?: string;
UserImportRecord.photoURL
URL foto pengguna.
Tanda Tangan:
photoURL?: string;
UserImportRecord.providerData
Array penyedia (misalnya, Google, Facebook) yang ditautkan ke pengguna.
Tanda Tangan:
providerData?: UserProviderRequest[];
UserImportRecord.tenantId
ID tenant tempat pengguna akan diimpor. Jika tidak disediakan dalam konteks admin.auth.Auth
, pengguna akan diupload ke project induk default. Jika tidak diberikan dalam konteks admin.auth.TenantAwareAuth
, pengguna akan diupload ke tenant yang sesuai dengan ID tenant instance TenantAwareAuth
tersebut.
Tanda Tangan:
tenantId?: string;
UserImportRecord.uid
uid
pengguna.
Tanda Tangan:
uid: string;