从身份平台传递给身份验证屏蔽函数的 UserRecord
。
签名:
export interface AuthUserRecord
属性
属性 | 类型 | 说明 |
---|---|---|
customClaims | 记录<string, any> | 用户的自定义声明对象(如果有),通常用于定义用户角色并传播到经过身份验证的用户的 ID 令牌。 |
已停用 | 布尔值 | 用户是否被停用:true 表示已停用;false 表示已启用。 |
displayName | 字符串 | 用户的显示名称。 |
字符串 | 用户的主电子邮件地址(如果已设置)。 | |
emailVerified | 布尔值 | 用户的主电子邮件地址是否通过验证。 |
元数据 | AuthUserMetadata | 关于用户的其他元数据。 |
多重身份验证 | AuthMultiFactorSettings | 当前用户的多重身份验证属性(如果有)。 |
passwordHash | 字符串 | 用户经过哈希处理的密码(采用 base64 编码)。 |
passwordSalt | 字符串 | 用户的密码盐(使用 base64 编码)。 |
phoneNumber | 字符串 | 用户的主要电话号码(如果已设置)。 |
photo网址 | 字符串 | 用户的照片网址。 |
providerData | AuthUserInfo[] | 与用户关联的一组提供商(例如 Google、Facebook)。 |
tenantId | 字符串 |null | 用户所属租户的 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.emailVerified
用户的主电子邮件地址是否通过验证。
签名:
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.photo网址
用户的照片网址。
签名:
photoURL?: string;
Identity.AuthUserRecord.providerData
与用户关联的一组提供商(例如 Google、Facebook)。
签名:
providerData: AuthUserInfo[];
Identity.AuthUserRecord.tenantId
用户所属租户的 ID(如果有)。
签名:
tenantId?: string | null;
Identity.AuthUserRecord.tokensValidAfterTime
用户令牌的有效日期,格式为 UTC 字符串。
签名:
tokensValidAfterTime?: string;
Identity.AuthUserRecord.uid
用户的 uid
。
签名:
uid: string;