UserRecord
從身分識別平台傳遞到驗證阻止函數。
簽名:
export interface AuthUserRecord
特性
財產 | 類型 | 描述 |
---|---|---|
客製化索賠 | 記錄<字串,任意> | 使用者的自訂聲明物件(如果可用)通常用於定義使用者角色並傳播到經過驗證的使用者的 ID 令牌。 |
殘障人士 | 布林值 | 使用者是否停用: true 為停用; false 表示已啟用。 |
顯示名稱 | 細繩 | 使用者的顯示名稱。 |
電子郵件 | 細繩 | 用戶的主要電子郵件(如果已設定)。 |
電子郵件已驗證 | 布林值 | 用戶的主要電子郵件是否經過驗證。 |
元數據 | 驗證用戶元數據 | 有關用戶的其他元資料。 |
多因素 | AuthMultiFactor設置 | 當前使用者的多因素相關屬性(如果可用)。 |
密碼雜湊值 | 細繩 | 用戶的哈希密碼(base64 編碼)。 |
密碼鹽 | 細繩 | 用戶的密碼鹽(base64 編碼)。 |
電話號碼 | 細繩 | 用戶的主要電話號碼(如果已設定)。 |
照片網址 | 細繩 | 使用者的照片 URL。 |
提供者數據 | 驗證用戶資訊[] | 連結到用戶的一系列提供者(例如 Google、Facebook)。 |
租戶ID | 字串|無效的 | 使用者所屬租戶的 ID(如果有)。 |
令牌有效時間後 | 細繩 | 使用者令牌的有效日期,格式為 UTC 字串。 |
uid | 細繩 | 用戶的uid 。 |
身份.AuthUserRecord.customClaims
使用者的自訂聲明物件(如果可用)通常用於定義使用者角色並傳播到經過驗證的使用者的 ID 令牌。
簽名:
customClaims?: Record<string, any>;
身分.AuthUserRecord.disabled
使用者是否停用: true
為停用; false
表示已啟用。
簽名:
disabled: boolean;
身分.AuthUserRecord.displayName
使用者的顯示名稱。
簽名:
displayName?: string;
身分.AuthUserRecord.email
用戶的主要電子郵件(如果已設定)。
簽名:
email?: string;
身份.AuthUserRecord.emailVerified
用戶的主要電子郵件是否經過驗證。
簽名:
emailVerified: boolean;
身份.AuthUserRecord.元數據
有關用戶的其他元資料。
簽名:
metadata: AuthUserMetadata;
身分.AuthUserRecord.multiFactor
當前使用者的多因素相關屬性(如果可用)。
簽名:
multiFactor?: AuthMultiFactorSettings;
身分.AuthUserRecord.passwordHash
用戶的哈希密碼(base64 編碼)。
簽名:
passwordHash?: string;
身分.AuthUserRecord.passwordSalt
用戶的密碼鹽(base64 編碼)。
簽名:
passwordSalt?: string;
身分.AuthUserRecord.電話號碼
用戶的主要電話號碼(如果已設定)。
簽名:
phoneNumber?: string;
身份.AuthUserRecord.photoURL
使用者的照片 URL。
簽名:
photoURL?: string;
身份.AuthUserRecord.providerData
連結到用戶的一系列提供者(例如 Google、Facebook)。
簽名:
providerData: AuthUserInfo[];
身分.AuthUserRecord.tenantId
使用者所屬租戶的 ID(如果有)。
簽名:
tenantId?: string | null;
Identity.AuthUserRecord.tokensValidAfterTime
使用者令牌的有效日期,格式為 UTC 字串。
簽名:
tokensValidAfterTime?: string;
身分.AuthUserRecord.uid
用戶的uid
。
簽名:
uid: string;