代表一个用户。
签名:
export declare class UserRecord
特性
财产 | 修饰符 | 类型 | 描述 |
---|---|---|---|
定制索赔 | { [键:字符串]:任意; } | 用户的自定义声明对象(如果可用)通常用于定义用户角色并传播到经过身份验证的用户的 ID 令牌。这是通过BaseAuth.setCustomUserClaims()设置的 | |
残疾人 | 布尔值 | 用户是否禁用: true 为禁用; false 表示已启用。 | |
显示名称 | 细绳 | 用户的显示名称。 | |
电子邮件 | 细绳 | 用户的主要电子邮件(如果已设置)。 | |
电子邮件已验证 | 布尔值 | 用户的主要电子邮件是否经过验证。 | |
元数据 | 用户元数据 | 有关用户的其他元数据。 | |
多因素 | 多因素设置 | 当前用户的多因素相关属性(如果可用)。 | |
密码哈希值 | 细绳 | 仅当使用 Firebase Auth 哈希算法 (SCRYPT) 时,用户的哈希密码(base64 编码)。如果上传此用户时使用了不同的哈希算法(从另一个身份验证系统迁移时很常见),则这将是一个空字符串。如果没有设置密码,则为空。仅当从BaseAuth.listUsers()获取用户时才可用。 | |
密码盐 | 细绳 | 仅当使用 Firebase 身份验证哈希算法 (SCRYPT) 时,用户的密码盐(base64 编码)。如果使用不同的哈希算法上传此用户(通常是从另一个身份验证系统迁移时),则这将是一个空字符串。如果没有设置密码,则为空。仅当从BaseAuth.listUsers()获取用户时才可用。 | |
电话号码 | 细绳 | 用户的主要电话号码(如果已设置)。 | |
照片网址 | 细绳 | 用户的照片 URL。 | |
提供者数据 | 用户信息[] | 链接到用户的一系列提供商(例如 Google、Facebook)。 | |
租户ID | 字符串|无效的 | 用户所属租户的 ID(如果有)。 | |
令牌有效时间后 | 细绳 | 用户令牌的有效日期,格式为 UTC 字符串。每次从BaseAuth.revokeRefreshTokens() API 或在重大帐户更改(密码重置、密码或电子邮件更新等)时从 Firebase Auth 后端撤销用户的刷新令牌时,都会更新此令牌。 | |
uid | 细绳 | 用户的uid 。 |
方法
方法 | 修饰符 | 描述 |
---|---|---|
toJSON() | 返回此对象的 JSON 可序列化表示形式。 |
UserRecord.customClaims
用户的自定义声明对象(如果可用)通常用于定义用户角色并传播到经过身份验证的用户的 ID 令牌。这是通过BaseAuth.setCustomUserClaims()设置的
签名:
readonly customClaims?: {
[key: string]: any;
};
用户记录.disabled
用户是否禁用: true
为禁用; false
表示已启用。
签名:
readonly disabled: boolean;
用户记录.显示名称
用户的显示名称。
签名:
readonly displayName?: string;
用户记录.email
用户的主要电子邮件(如果已设置)。
签名:
readonly email?: string;
UserRecord.emailVerified
用户的主要电子邮件是否经过验证。
签名:
readonly emailVerified: boolean;
用户记录.元数据
有关用户的其他元数据。
签名:
readonly metadata: UserMetadata;
用户记录.multiFactor
当前用户的多因素相关属性(如果可用)。
签名:
readonly multiFactor?: MultiFactorSettings;
UserRecord.passwordHash
仅当使用 Firebase Auth 哈希算法 (SCRYPT) 时,用户的哈希密码(base64 编码)。如果上传此用户时使用了不同的哈希算法(从另一个身份验证系统迁移时很常见),则这将是一个空字符串。如果没有设置密码,则为空。仅当从BaseAuth.listUsers()获取用户时才可用。
签名:
readonly passwordHash?: string;
用户记录.密码Salt
仅当使用 Firebase 身份验证哈希算法 (SCRYPT) 时,用户的密码盐(base64 编码)。如果使用不同的哈希算法上传此用户(通常是从另一个身份验证系统迁移时),则这将是一个空字符串。如果没有设置密码,则为空。仅当从BaseAuth.listUsers()获取用户时才可用。
签名:
readonly passwordSalt?: string;
用户记录.电话号码
用户的主要电话号码(如果已设置)。
签名:
readonly phoneNumber?: string;
用户记录.photoURL
用户的照片 URL。
签名:
readonly photoURL?: string;
用户记录.providerData
链接到用户的一系列提供商(例如 Google、Facebook)。
签名:
readonly providerData: UserInfo[];
UserRecord.tenantId
用户所属租户的 ID(如果有)。
签名:
readonly tenantId?: string | null;
UserRecord.tokensValidAfterTime
用户令牌的有效日期,格式为 UTC 字符串。每次从BaseAuth.revokeRefreshTokens() API 或在重大帐户更改(密码重置、密码或电子邮件更新等)时从 Firebase Auth 后端撤销用户的刷新令牌时,都会更新此令牌。
签名:
readonly tokensValidAfterTime?: string;
用户记录.uid
用户的uid
。
签名:
readonly uid: string;
UserRecord.toJSON()
返回此对象的 JSON 可序列化表示形式。
签名:
toJSON(): object;
返回:
目的
该对象的 JSON 可序列化表示。