UserImportRecord interface

表示通过 BaseAuth.importUsers() 方法导入 Firebase Auth 的用户的接口。

签名

export interface UserImportRecord 

属性

属性 类型 说明
customClaims { [键: 字符串]: 任意;} 用户的自定义声明对象(如果有),通常用于定义用户角色并传播到经过身份验证的用户的 ID 令牌。
已停用 布尔值 用户是否被停用:true 表示已停用;false 表示已启用。
displayName 字符串 用户的显示名称。
email 字符串 用户的主电子邮件地址(如果已设置)。
emailVerified 布尔值 用户的主电子邮件地址是否通过验证。
元数据 UserMetadataRequest 关于用户的其他元数据。
多重身份验证 MultiFactorUpdateSettings 用户的多重身份验证属性。
passwordHash Buffer 表示用户经过哈希处理的密码的字节缓冲区。当使用密码哈希导入用户时,必须指定 UserImportOptions 以确定用于生成此哈希的哈希算法。
passwordSalt Buffer 表示用户密码盐的字节缓冲区。
phoneNumber 字符串 用户的主要电话号码(如果已设置)。
photo网址 字符串 用户的照片网址。
providerData UserProviderRequest[] 与用户关联的一组提供商(例如 Google、Facebook)。
tenantId 字符串 要向其中导入用户的租户的标识符。如果未在 admin.auth.Auth 上下文中提供该参数,则系统会将用户上传到默认父项目。如果 admin.auth.TenantAwareAuth 上下文中未提供,系统会将用户上传到与该 TenantAwareAuth 实例的租户 ID 对应的租户。
uid 字符串 用户的 uid

UserImportRecord.customClaims

用户的自定义声明对象(如果有),通常用于定义用户角色并传播到经过身份验证的用户的 ID 令牌。

签名

customClaims?: {
        [key: string]: any;
    };

UserImportRecord.disabled

用户是否被停用:true 表示已停用;false 表示已启用。

签名

disabled?: boolean;

UserImportRecord.displayName

用户的显示名称。

签名

displayName?: string;

UserImportRecord.email

用户的主电子邮件地址(如果已设置)。

签名

email?: string;

UserImportRecord.emailVerified

用户的主电子邮件地址是否通过验证。

签名

emailVerified?: boolean;

UserImportRecord.metadata

关于用户的其他元数据。

签名

metadata?: UserMetadataRequest;

UserImportRecord.multiFactor

用户的多重身份验证属性。

签名

multiFactor?: MultiFactorUpdateSettings;

UserImportRecord.passwordHash

表示用户经过哈希处理的密码的字节缓冲区。当使用密码哈希导入用户时,必须指定 UserImportOptions 以确定用于生成此哈希的哈希算法。

签名

passwordHash?: Buffer;

UserImportRecord.passwordSalt

表示用户密码盐的字节缓冲区。

签名

passwordSalt?: Buffer;

UserImportRecord.phoneNumber

用户的主要电话号码(如果已设置)。

签名

phoneNumber?: string;

UserImportRecord.photo网址

用户的照片网址。

签名

photoURL?: string;

UserImportRecord.providerData

与用户关联的一组提供商(例如 Google、Facebook)。

签名

providerData?: UserProviderRequest[];

UserImportRecord.tenantId

要向其中导入用户的租户的标识符。如果未在 admin.auth.Auth 上下文中提供该参数,则系统会将用户上传到默认父项目。如果 admin.auth.TenantAwareAuth 上下文中未提供,系统会将用户上传到与该 TenantAwareAuth 实例的租户 ID 对应的租户。

签名

tenantId?: string;

UserImportRecord.uid

用户的 uid

签名

uid: string;