UserRecord class

代表使用者。

簽名：

export declare class UserRecord

屬性

屬性 修飾符 類型 說明
customClaims { [key: string]: any;} 使用者的自訂憑證附加資訊物件 (如有)，通常用於定義使用者角色，並套用至已驗證使用者的 ID 權杖。需透過 BaseAuth.setCustomUserClaims() 設定
已停用 布林值 使用者是否停用：true 代表已停用；false 已啟用。
「displayName」 字串 使用者的顯示名稱。
email 字串 使用者的主要電子郵件地址 (如有設定)。
電子郵件已驗證 布林值 使用者的主要電子郵件地址是否已通過驗證。
中繼資料 使用者中繼資料 使用者的其他中繼資料。
乘法 多重要素設定 目前使用者的多重要素相關屬性 (如有)。
passwordHash 字串 只有在使用 Firebase 驗證雜湊演算法 (SCRYPT) 時，使用者的雜湊密碼 (Base64 編碼)。如果上傳這位使用者時使用了不同的雜湊演算法，就像從其他驗證系統進行遷移時一樣，這將會是空白字串。如果沒有設定密碼，此值則為 null。這個做法僅適用於透過 BaseAuth.listUsers() 取得的使用者。
passwordSalt 字串 只有在使用 Firebase 驗證雜湊演算法 (SCRYPT) 的情況下，才是使用者密碼加碼 (Base64 編碼)。如果已使用不同的雜湊演算法上傳這位使用者，通常是從其他驗證系統進行遷移時，這會是空白字串。如果沒有設定密碼，此值則為 null。這個做法僅適用於透過 BaseAuth.listUsers() 取得的使用者。
電話號碼 字串 使用者的主要電話號碼 (如有設定)。
photoURL 字串 使用者的相片網址。
providerData 使用者資訊[] 連結至使用者的提供者陣列 (例如 Google、Facebook)。
用戶群 ID 字串 |空值 使用者所屬用戶群的 ID (如有)。
tokensValidAfterTime 字串 使用者權杖的有效期限，格式為 UTC 字串。每當使用者的更新權杖遭到 BaseAuth.revokeRefreshTokens() API 或 Firebase 驗證後端撤銷，系統就會在帳戶發生重大異動 (密碼重設、密碼或電子郵件通知等) 時更新。
uid 字串 使用者的 uid。

方法

方法 修飾符 說明
toJSON() 傳回此物件的 JSON 可序列化表示法。

使用者記錄.customClaims

使用者的自訂憑證附加資訊物件 (如有)，通常用於定義使用者角色，並套用至已驗證使用者的 ID 權杖。需透過 BaseAuth.setCustomUserClaims() 設定

簽名：

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

已停用使用者記錄

使用者是否停用：true 代表已停用；false 已啟用。

簽名：

readonly disabled: boolean;

使用者記錄.displayName

使用者的顯示名稱。

簽名：

readonly displayName?: string;

使用者記錄.電子郵件地址

使用者的主要電子郵件地址 (如有設定)。

簽名：

readonly email?: string;

已驗證使用者記錄.email

使用者的主要電子郵件地址是否已通過驗證。

簽名：

readonly emailVerified: boolean;

使用者記錄.metadata

使用者的其他中繼資料。

簽名：

readonly metadata: UserMetadata;

使用者記錄.multiFactor

目前使用者的多重要素相關屬性 (如有)。

簽名：

readonly multiFactor?: MultiFactorSettings;

使用者記錄.passwordHash

只有在使用 Firebase 驗證雜湊演算法 (SCRYPT) 時，使用者的雜湊密碼 (Base64 編碼)。如果上傳這位使用者時使用了不同的雜湊演算法，就像從其他驗證系統進行遷移時一樣，這將會是空白字串。如果沒有設定密碼，此值則為 null。這個做法僅適用於透過 BaseAuth.listUsers() 取得的使用者。

簽名：

readonly passwordHash?: string;

使用者記錄.passwordSalt

只有在使用 Firebase 驗證雜湊演算法 (SCRYPT) 的情況下，才是使用者密碼加碼 (Base64 編碼)。如果已使用不同的雜湊演算法上傳這位使用者，通常是從其他驗證系統進行遷移時，這會是空白字串。如果沒有設定密碼，此值則為 null。這個做法僅適用於透過 BaseAuth.listUsers() 取得的使用者。

簽名：

readonly passwordSalt?: string;

使用者記錄.phoneNumber

使用者的主要電話號碼 (如有設定)。

簽名：

readonly phoneNumber?: string;

使用者記錄.photoURL

使用者的相片網址。

簽名：

readonly photoURL?: string;

使用者記錄.providerData

連結至使用者的提供者陣列 (例如 Google、Facebook)。

簽名：

readonly providerData: UserInfo[];

使用者記錄.用戶群 ID

使用者所屬用戶群的 ID (如有)。

簽名：

readonly tenantId?: string | null;

使用者記錄.tokensValidAfterTime

使用者權杖的有效期限，格式為 UTC 字串。每當使用者的更新權杖遭到 BaseAuth.revokeRefreshTokens() API 或 Firebase 驗證後端撤銷，系統就會在帳戶發生重大異動 (密碼重設、密碼或電子郵件通知等) 時更新。

簽名：

readonly tokensValidAfterTime?: string;

使用者記錄.uid

使用者的 uid。

簽名：

readonly uid: string;

使用者記錄.toJSON()

傳回此物件的 JSON 可序列化表示法。

簽名：

toJSON(): object;

傳回：

物件

此物件的 JSON 可序列化表示法。