UserRecord class

Mewakili pengguna.

Tanda Tangan:

export declare class UserRecord

Properti

Properti Pengubah Jenis Deskripsi
Klaimkustom { [key: string]: apa pun; } Objek klaim kustom pengguna jika tersedia, biasanya digunakan untuk menentukan peran pengguna dan diterapkan ke token ID pengguna yang diautentikasi. Hal ini ditetapkan melalui BaseAuth.setCustomUserclaims()
dinonaktifkan boolean Apakah pengguna dinonaktifkan atau tidak: true untuk dinonaktifkan; false untuk diaktifkan.
namatampilan string Nama pengguna yang ditampilkan.
email string Email utama pengguna, jika ditetapkan.
emailTerverifikasi boolean Apakah email utama pengguna telah diverifikasi atau belum.
metadata UserMetadata Metadata tambahan tentang pengguna.
multiFaktor Setelan MultiFaktor Properti terkait multi-faktor untuk pengguna saat ini, jika tersedia.
passwordHash string Sandi pengguna yang di-hash (dienkode base64), hanya jika algoritma hashing Firebase Auth (SCRYPT) digunakan. Jika algoritma hashing berbeda telah digunakan saat mengupload pengguna ini, seperti biasanya saat bermigrasi dari sistem Auth lain, string ini akan kosong. Jika tidak ada sandi yang ditetapkan, nilainya adalah null. Hal ini hanya tersedia jika pengguna diperoleh dari BaseAuth.listUsers().
passwordSalt string Salt sandi pengguna (berenkode base64), hanya jika algoritme hashing Firebase Auth (SCRYPT) digunakan. Jika algoritma hashing yang berbeda telah digunakan untuk mengupload pengguna ini, biasanya saat bermigrasi dari sistem Auth lain, ini akan berupa string kosong. Jika tidak ada sandi yang ditetapkan, nilainya adalah null. Hal ini hanya tersedia jika pengguna diperoleh dari BaseAuth.listUsers().
Nomor Telepon string Nomor telepon utama pengguna, jika ditetapkan.
photoURL string URL foto pengguna.
providerData InfoPengguna[] Array penyedia (misalnya, Google, Facebook) yang ditautkan ke pengguna.
tenantId rangkaian | null (kosong) ID tenant pengguna, jika tersedia.
tokensValidAfterTime string Tanggal token pengguna valid setelah, diformat sebagai string UTC. Ini diperbarui setiap kali token refresh pengguna dicabut dari API BaseAuth.revokeRefreshTokens() atau dari backend Firebase Auth saat terjadi perubahan besar pada akun (reset sandi, update email atau sandi, dll.).
uid string uid pengguna.

Metode

Metode Pengubah Deskripsi
toJSON() Menampilkan representasi JSON-serial yang dapat diserialisasi untuk objek ini.

UserRecord.custom Claimss

Objek klaim kustom pengguna jika tersedia, biasanya digunakan untuk menentukan peran pengguna dan diterapkan ke token ID pengguna yang diautentikasi. Hal ini ditetapkan 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;

UserRecord.displayName

Nama pengguna yang ditampilkan.

Tanda Tangan:

readonly displayName?: string;

UserRecord.email

Email utama pengguna, jika ditetapkan.

Tanda Tangan:

readonly email?: string;

UserRecord.emailDiverifikasi

Apakah email utama pengguna telah diverifikasi atau belum.

Tanda Tangan:

readonly emailVerified: boolean;

UserRecord.metadata

Metadata tambahan tentang pengguna.

Tanda Tangan:

readonly metadata: UserMetadata;

UserRecord.multiFactor

Properti terkait multi-faktor untuk pengguna saat ini, jika tersedia.

Tanda Tangan:

readonly multiFactor?: MultiFactorSettings;

UserRecord.passwordHash

Sandi pengguna yang di-hash (dienkode base64), hanya jika algoritma hashing Firebase Auth (SCRYPT) digunakan. Jika algoritma hashing berbeda telah digunakan saat mengupload pengguna ini, seperti biasanya saat bermigrasi dari sistem Auth lain, string ini akan kosong. Jika tidak ada sandi yang ditetapkan, nilainya adalah null. Hal ini hanya tersedia jika pengguna diperoleh dari BaseAuth.listUsers().

Tanda Tangan:

readonly passwordHash?: string;

UserRecord.passwordSalt

Salt sandi pengguna (berenkode base64), hanya jika algoritme hashing Firebase Auth (SCRYPT) digunakan. Jika algoritma hashing yang berbeda telah digunakan untuk mengupload pengguna ini, biasanya saat bermigrasi dari sistem Auth lain, ini akan berupa string kosong. Jika tidak ada sandi yang ditetapkan, nilainya adalah null. Hal ini hanya tersedia jika pengguna diperoleh dari BaseAuth.listUsers().

Tanda Tangan:

readonly passwordSalt?: string;

UserRecord.phoneNumber

Nomor telepon utama pengguna, jika ditetapkan.

Tanda Tangan:

readonly phoneNumber?: string;

UserRecord.photoURL

URL foto pengguna.

Tanda Tangan:

readonly photoURL?: string;

UserRecord.providerData

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

Tanda Tangan:

readonly providerData: UserInfo[];

UserRecord.tenantId

ID tenant pengguna, jika tersedia.

Tanda Tangan:

readonly tenantId?: string | null;

UserRecord.tokensValidAfterTime

Tanggal token pengguna valid setelah, diformat sebagai string UTC. Ini diperbarui setiap kali token refresh pengguna dicabut dari API BaseAuth.revokeRefreshTokens() atau dari backend Firebase Auth saat terjadi perubahan besar pada akun (reset sandi, update email atau sandi, dll.).

Tanda Tangan:

readonly tokensValidAfterTime?: string;

UserRecord.uid

uid pengguna.

Tanda Tangan:

readonly uid: string;

UserRecord.toJSON()

Menampilkan representasi JSON-serial yang dapat diserialisasi untuk objek ini.

Tanda Tangan:

toJSON(): object;

Hasil:

objek

Representasi JSON yang dapat diserialisasi untuk objek ini.