UserRecord class

Mewakili pengguna.

Tanda tangan:

export declare class UserRecord 

Properti

Properti Pengubah 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. Ini diatur melalui BaseAuth.setCustomUserClaims()
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 Metadata Pengguna Metadata tambahan tentang pengguna.
multiFaktor Pengaturan MultiFaktor Properti terkait multifaktor untuk pengguna saat ini, jika tersedia.
kata sandiHash rangkaian Kata sandi pengguna yang di-hash (dikodekan base64), hanya jika algoritma hashing Firebase Auth (SCRYPT) digunakan. Jika algoritme hashing berbeda digunakan saat mengunggah pengguna ini, seperti yang biasa terjadi saat bermigrasi dari sistem Auth lain, ini akan berupa string kosong. Jika tidak ada kata sandi yang disetel, ini nol. Ini hanya tersedia ketika pengguna diperoleh dari BaseAuth.listUsers() .
kata sandiSalt rangkaian Salt kata sandi pengguna (dikodekan base64), hanya jika algoritma hashing Firebase Auth (SCRYPT) digunakan. Jika algoritme hashing yang berbeda telah digunakan untuk mengunggah pengguna ini, yang biasanya terjadi saat bermigrasi dari sistem Auth lain, ini akan berupa string kosong. Jika tidak ada kata sandi yang disetel, ini nol. Ini hanya tersedia ketika pengguna diperoleh dari BaseAuth.listUsers() .
nomor telepon rangkaian Nomor telepon utama pengguna, jika disetel.
URL foto rangkaian URL foto pengguna.
penyediaData Info Pengguna [] Serangkaian penyedia (misalnya, Google, Facebook) yang ditautkan ke pengguna.
penyewaId tali | batal ID penyewa tempat pengguna berada, jika tersedia.
tokenValidAfterTime rangkaian Tanggal token pengguna valid setelahnya, diformat sebagai string UTC. Ini diperbarui setiap kali token penyegaran pengguna dicabut baik dari API BaseAuth.revokeRefreshTokens() atau dari backend Firebase Auth jika ada perubahan besar pada akun (reset kata sandi, pembaruan kata sandi atau email, dll).
uid rangkaian uid pengguna.

Metode

metode Pengubah Keterangan
keJSON() Mengembalikan representasi objek ini yang dapat diserialkan JSON.

Catatan Pengguna.Klaim khusus

Objek klaim khusus pengguna, jika tersedia, biasanya digunakan untuk menentukan peran pengguna dan disebarkan ke token ID pengguna yang diautentikasi. Ini diatur melalui BaseAuth.setCustomUserClaims()

Tanda tangan:

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

UserRecord.dinonaktifkan

Apakah pengguna dinonaktifkan atau tidak: true untuk dinonaktifkan; false untuk diaktifkan.

Tanda tangan:

readonly disabled: boolean;

Catatan Pengguna.namatampilan

Nama tampilan pengguna.

Tanda tangan:

readonly displayName?: string;

Catatan Pengguna.email

Email utama pengguna, jika disetel.

Tanda tangan:

readonly email?: string;

UserRecord.emailTerverifikasi

Apakah email utama pengguna terverifikasi atau tidak.

Tanda tangan:

readonly emailVerified: boolean;

Catatan Pengguna.metadata

Metadata tambahan tentang pengguna.

Tanda tangan:

readonly metadata: UserMetadata;

Catatan Pengguna.multiFactor

Properti terkait multifaktor untuk pengguna saat ini, jika tersedia.

Tanda tangan:

readonly multiFactor?: MultiFactorSettings;

Catatan Pengguna.passwordHash

Kata sandi pengguna yang di-hash (dikodekan base64), hanya jika algoritma hashing Firebase Auth (SCRYPT) digunakan. Jika algoritme hashing berbeda digunakan saat mengunggah pengguna ini, seperti yang biasa terjadi saat bermigrasi dari sistem Auth lain, ini akan berupa string kosong. Jika tidak ada kata sandi yang disetel, ini nol. Ini hanya tersedia ketika pengguna diperoleh dari BaseAuth.listUsers() .

Tanda tangan:

readonly passwordHash?: string;

Catatan Pengguna.passwordSalt

Salt kata sandi pengguna (dikodekan base64), hanya jika algoritma hashing Firebase Auth (SCRYPT) digunakan. Jika algoritme hashing yang berbeda telah digunakan untuk mengunggah pengguna ini, yang biasanya terjadi saat bermigrasi dari sistem Auth lain, ini akan berupa string kosong. Jika tidak ada kata sandi yang disetel, ini nol. Ini hanya tersedia ketika pengguna diperoleh dari BaseAuth.listUsers() .

Tanda tangan:

readonly passwordSalt?: string;

Catatan Pengguna.Nomor telepon

Nomor telepon utama pengguna, jika disetel.

Tanda tangan:

readonly phoneNumber?: string;

Catatan Pengguna.photoURL

URL foto pengguna.

Tanda tangan:

readonly photoURL?: string;

Catatan Pengguna.providerData

Serangkaian penyedia (misalnya, Google, Facebook) yang ditautkan ke pengguna.

Tanda tangan:

readonly providerData: UserInfo[];

Catatan Pengguna.tenantId

ID penyewa tempat pengguna berada, jika tersedia.

Tanda tangan:

readonly tenantId?: string | null;

Catatan Pengguna.tokensValidAfterTime

Tanggal token pengguna valid setelahnya, diformat sebagai string UTC. Ini diperbarui setiap kali token penyegaran pengguna dicabut baik dari API BaseAuth.revokeRefreshTokens() atau dari backend Firebase Auth jika ada perubahan besar pada akun (reset kata sandi, pembaruan kata sandi atau email, dll).

Tanda tangan:

readonly tokensValidAfterTime?: string;

Catatan Pengguna.uid

uid pengguna .

Tanda tangan:

readonly uid: string;

Catatan Pengguna.toJSON()

Mengembalikan representasi objek ini yang dapat diserialkan JSON.

Tanda tangan:

toJSON(): object;

Pengembalian:

obyek

Representasi objek ini yang dapat diserialkan JSON.