代表一個使用者。
簽名:
export declare class UserRecord
特性
財產 | 修飾符 | 類型 | 描述 |
---|---|---|---|
客製化索賠 | { [鍵:字串]:任意; } | 使用者的自訂聲明物件(如果可用)通常用於定義使用者角色並傳播到經過驗證的使用者的 ID 令牌。這是透過BaseAuth.setCustomUserClaims()設定的 | |
殘障人士 | 布林值 | 使用者是否停用: true 為停用; false 表示已啟用。 | |
顯示名稱 | 細繩 | 使用者的顯示名稱。 | |
電子郵件 | 細繩 | 用戶的主要電子郵件(如果已設定)。 | |
電子郵件已驗證 | 布林值 | 用戶的主要電子郵件是否經過驗證。 | |
元數據 | 用戶元數據 | 有關用戶的其他元資料。 | |
多因素 | 多因素設定 | 當前使用者的多因素相關屬性(如果可用)。 | |
密碼雜湊值 | 細繩 | 只有在使用 Firebase Auth 雜湊演算法 (SCRYPT) 時,使用者的雜湊密碼(base64 編碼)。如果上傳此使用者時使用了不同的雜湊演算法(從另一個驗證系統遷移時很常見),則這將是一個空字串。如果沒有設定密碼,則為空。僅當從BaseAuth.listUsers()取得使用者時才可用。 | |
密碼鹽 | 細繩 | 只有在使用 Firebase 驗證雜湊演算法 (SCRYPT) 時,使用者的密碼鹽(base64 編碼)。如果使用不同的雜湊演算法上傳此使用者(通常是從另一個驗證系統遷移時),則這將是一個空字串。如果沒有設定密碼,則為空。僅當從BaseAuth.listUsers()取得使用者時才可用。 | |
電話號碼 | 細繩 | 用戶的主要電話號碼(如果已設定)。 | |
照片網址 | 細繩 | 使用者的照片 URL。 | |
提供者數據 | 使用者資訊[] | 連結到用戶的一系列提供者(例如 Google、Facebook)。 | |
租戶ID | 字串|無效的 | 使用者所屬租戶的 ID(如果有)。 | |
令牌有效時間後 | 細繩 | 使用者令牌的有效日期,格式為 UTC 字串。每次從BaseAuth.revokeRefreshTokens() API 或在重大帳戶變更(密碼重設、密碼或電子郵件更新等)時從 Firebase Auth 後端撤銷使用者的刷新令牌時,都會更新此令牌。 | |
uid | 細繩 | 用戶的uid 。 |
方法
方法 | 修飾符 | 描述 |
---|---|---|
toJSON() | 傳回此物件的 JSON 可序列化表示形式。 |
UserRecord.customClaims
使用者的自訂聲明物件(如果可用)通常用於定義使用者角色並傳播到經過驗證的使用者的 ID 令牌。這是透過BaseAuth.setCustomUserClaims()設定的
簽名:
readonly customClaims?: {
[key: string]: any;
};
使用者記錄.disabled
使用者是否停用: true
為停用; false
表示已啟用。
簽名:
readonly disabled: boolean;
使用者記錄.顯示名稱
使用者的顯示名稱。
簽名:
readonly displayName?: string;
使用者記錄.email
用戶的主要電子郵件(如果已設定)。
簽名:
readonly email?: string;
UserRecord.emailVerified
用戶的主要電子郵件是否經過驗證。
簽名:
readonly emailVerified: boolean;
用戶記錄.元數據
有關用戶的其他元資料。
簽名:
readonly metadata: UserMetadata;
用戶記錄.multiFactor
當前使用者的多因素相關屬性(如果可用)。
簽名:
readonly multiFactor?: MultiFactorSettings;
UserRecord.passwordHash
只有在使用 Firebase Auth 雜湊演算法 (SCRYPT) 時,使用者的雜湊密碼(base64 編碼)。如果上傳此使用者時使用了不同的雜湊演算法(從另一個驗證系統遷移時很常見),則這將是一個空字串。如果沒有設定密碼,則為空。僅當從BaseAuth.listUsers()取得使用者時才可用。
簽名:
readonly passwordHash?: string;
使用者記錄.密碼Salt
只有在使用 Firebase 驗證雜湊演算法 (SCRYPT) 時,使用者的密碼鹽(base64 編碼)。如果使用不同的雜湊演算法上傳此使用者(通常是從另一個驗證系統遷移時),則這將是一個空字串。如果沒有設定密碼,則為空。僅當從BaseAuth.listUsers()取得使用者時才可用。
簽名:
readonly passwordSalt?: string;
用戶記錄.電話號碼
用戶的主要電話號碼(如果已設定)。
簽名:
readonly phoneNumber?: string;
使用者記錄.photoURL
使用者的照片 URL。
簽名:
readonly photoURL?: string;
使用者記錄.providerData
連結到用戶的一系列提供者(例如 Google、Facebook)。
簽名:
readonly providerData: UserInfo[];
UserRecord.tenantId
使用者所屬租戶的 ID(如果有)。
簽名:
readonly tenantId?: string | null;
UserRecord.tokensValidAfterTime
使用者令牌的有效日期,格式為 UTC 字串。每次從BaseAuth.revokeRefreshTokens() API 或在重大帳戶變更(密碼重設、密碼或電子郵件更新等)時從 Firebase Auth 後端撤銷使用者的刷新令牌時,都會更新此令牌。
簽名:
readonly tokensValidAfterTime?: string;
使用者記錄.uid
用戶的uid
。
簽名:
readonly uid: string;
UserRecord.toJSON()
傳回此物件的 JSON 可序列化表示形式。
簽名:
toJSON(): object;
返回:
目的
該物件的 JSON 可序列化表示。