identity.AuthUserRecord interface

UserRecord傳遞到來自身分識別平台的 Auth 封鎖函式。

簽名：

export interface AuthUserRecord

屬性

屬性 類型 說明
customClaims Record<string, any> (錄音) 使用者的自訂憑證附加資訊物件 (如有)，通常用於定義使用者角色，並套用至已驗證使用者的 ID 權杖。
已停用 布林值 使用者是否停用：true 代表已停用；false 已啟用。
「displayName」 字串 使用者的顯示名稱。
email 字串 使用者的主要電子郵件地址 (如有設定)。
電子郵件已驗證 布林值 使用者的主要電子郵件地址是否已通過驗證。
中繼資料 驗證使用者中繼資料 使用者的其他中繼資料。
乘法 AuthMultiFactor 設定 目前使用者的多重要素相關屬性 (如有)。
passwordHash 字串 使用者的雜湊密碼 (Base64 編碼)。
passwordSalt 字串 使用者密碼的鹽 (採用 Base64 編碼)。
電話號碼 字串 使用者的主要電話號碼 (如有設定)。
photoURL 字串 使用者的相片網址。
providerData 驗證使用者資訊 [] 連結至使用者的提供者陣列 (例如 Google、Facebook)。
用戶群 ID 字串 |空值 使用者所屬用戶群的 ID (如有)。
tokensValidAfterTime 字串 使用者權杖的有效期限，格式為 UTC 字串。
uid 字串 使用者的 uid。

Identity.AuthUserRecord.customClaims

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

簽名：

customClaims?: Record<string, any>;

Identity.AuthUserRecord.disabled

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

簽名：

disabled: boolean;

Identity.AuthUserRecord.displayName

使用者的顯示名稱。

簽名：

displayName?: string;

Identity.AuthUserRecord.email

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

簽名：

email?: string;

Identity.AuthUserRecord.email 已驗證

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

簽名：

emailVerified: boolean;

Identity.AuthUserRecord.metadata

使用者的其他中繼資料。

簽名：

metadata: AuthUserMetadata;

Identity.AuthUserRecord.multiFactor

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

簽名：

multiFactor?: AuthMultiFactorSettings;

Identity.AuthUserRecord.passwordHash

使用者的雜湊密碼 (Base64 編碼)。

簽名：

passwordHash?: string;

Identity.AuthUserRecord.passwordSalt

使用者密碼的鹽 (採用 Base64 編碼)。

簽名：

passwordSalt?: string;

Identity.AuthUserRecord.phoneNumber

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

簽名：

phoneNumber?: string;

Identity.AuthUserRecord.photoURL

使用者的相片網址。

簽名：

photoURL?: string;

Identity.AuthUserRecord.providerData

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

簽名：

providerData: AuthUserInfo[];

Identity.AuthUserRecord.用戶群 Id

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

簽名：

tenantId?: string | null;

Identity.AuthUserRecord.tokensValidAfterTime

使用者權杖的有效期限，格式為 UTC 字串。

簽名：

tokensValidAfterTime?: string;

Identity.AuthUserRecord.uid

使用者的 uid。

簽名：

uid: string;