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;