表示用户。
签名:
export declare class UserRecord
属性
属性 | 修饰符 | 类型 | 说明 |
---|---|---|---|
customClaims | { [键: 字符串]: 任意;} | 用户的自定义声明对象(如果有),通常用于定义用户角色并传播到经过身份验证的用户的 ID 令牌。这通过 BaseAuth.setCustomUserClaims() 进行设置 | |
已停用 | 布尔值 | 用户是否被停用:true 表示已停用;false 表示已启用。 |
|
displayName | 字符串 | 用户的显示名称。 | |
字符串 | 用户的主电子邮件地址(如果已设置)。 | ||
emailVerified | 布尔值 | 用户的主电子邮件地址是否通过验证。 | |
元数据 | UserMetadata | 关于用户的其他元数据。 | |
多重身份验证 | MultiFactorSettings | 当前用户的多重身份验证属性(如果有)。 | |
passwordHash | 字符串 | 用户经过哈希处理的密码(采用 base64 编码),仅当使用 Firebase Auth 哈希算法 (SCRYPT) 时才需要。如果在上传此用户时使用了不同的哈希算法(从其他身份验证系统迁移时通常如此),则该字符串将为空字符串。如果未设置密码,则此字段为 null。此方法仅在从 BaseAuth.listUsers() 获取用户时可用。 | |
passwordSalt | 字符串 | 用户的密码盐(采用 base64 编码),仅当使用 Firebase Auth 哈希算法 (SCRYPT) 时才需要。如果上传此用户时使用了不同的哈希算法(通常在从其他 Auth 系统迁移时),此字段将为空字符串。如果未设置密码,则此字段为 null。此方法仅在从 BaseAuth.listUsers() 获取用户时可用。 | |
phoneNumber | 字符串 | 用户的主要电话号码(如果已设置)。 | |
photo网址 | 字符串 | 用户的照片网址。 | |
providerData | UserInfo[] | 与用户关联的一组提供商(例如 Google、Facebook)。 | |
tenantId | 字符串 |null | 用户所属租户的 ID(如果有)。 | |
tokensValidAfterTime | 字符串 | 用户令牌的有效日期,格式为 UTC 字符串。每当发生重大账号更改(密码重置、密码或电子邮件更新等)从 BaseAuth.revokeRefreshTokens() API 或 Firebase Auth 后端撤消用户的刷新令牌时,系统都会更新令牌。 | |
uid | 字符串 | 用户的 uid 。 |
方法
方法 | 修饰符 | 说明 |
---|---|---|
toJSON() | 返回此对象的可序列化 JSON 表示法。 |
UserRecord.customClaims
用户的自定义声明对象(如果有),通常用于定义用户角色并传播到经过身份验证的用户的 ID 令牌。这通过 BaseAuth.setCustomUserClaims() 进行设置
签名:
readonly customClaims?: {
[key: string]: any;
};
UserRecord.disabled
用户是否被停用:true
表示已停用;false
表示已启用。
签名:
readonly disabled: boolean;
UserRecord.displayName
用户的显示名称。
签名:
readonly displayName?: string;
UserRecord.email
用户的主电子邮件地址(如果已设置)。
签名:
readonly email?: string;
UserRecord.emailVerified
用户的主电子邮件地址是否通过验证。
签名:
readonly emailVerified: boolean;
UserRecord.metadata
关于用户的其他元数据。
签名:
readonly metadata: UserMetadata;
UserRecord.multiFactor
当前用户的多重身份验证属性(如果有)。
签名:
readonly multiFactor?: MultiFactorSettings;
UserRecord.passwordHash
用户经过哈希处理的密码(采用 base64 编码),仅当使用 Firebase Auth 哈希算法 (SCRYPT) 时才需要。如果在上传此用户时使用了不同的哈希算法(从其他身份验证系统迁移时通常如此),则该字符串将为空字符串。如果未设置密码,则此字段为 null。此方法仅在从 BaseAuth.listUsers() 获取用户时可用。
签名:
readonly passwordHash?: string;
UserRecord.passwordSalt
用户的密码盐(采用 base64 编码),仅当使用 Firebase Auth 哈希算法 (SCRYPT) 时才需要。如果上传此用户时使用了不同的哈希算法(通常在从其他 Auth 系统迁移时),此字段将为空字符串。如果未设置密码,则此字段为 null。此方法仅在从 BaseAuth.listUsers() 获取用户时可用。
签名:
readonly passwordSalt?: string;
UserRecord.phoneNumber
用户的主要电话号码(如果已设置)。
签名:
readonly phoneNumber?: string;
UserRecord.photo网址
用户的照片网址。
签名:
readonly photoURL?: string;
UserRecord.providerData
与用户关联的一组提供商(例如 Google、Facebook)。
签名:
readonly providerData: UserInfo[];
UserRecord.tenantId
用户所属租户的 ID(如果有)。
签名:
readonly tenantId?: string | null;
UserRecord.tokensValidAfterTime
用户令牌的有效日期,格式为 UTC 字符串。每当发生重大账号更改(密码重置、密码或电子邮件更新等)从 BaseAuth.revokeRefreshTokens() API 或 Firebase Auth 后端撤消用户的刷新令牌时,系统都会更新令牌。
签名:
readonly tokensValidAfterTime?: string;
UserRecord.uid
用户的 uid
。
签名:
readonly uid: string;
UserRecord.toJSON()
返回此对象的可序列化 JSON 表示法。
签名:
toJSON(): object;
返回:
对象
此对象的可序列化 JSON 表示法。