表示通过BaseAuth.importUsers()方法导入 Firebase Auth 的用户的接口。
签名:
export interface UserImportRecord
特性
财产 | 类型 | 描述 |
---|---|---|
定制索赔 | { [键:字符串]:任意; } | 用户的自定义声明对象(如果可用)通常用于定义用户角色并传播到经过身份验证的用户的 ID 令牌。 |
残疾人 | 布尔值 | 用户是否禁用: true 为禁用; false 表示已启用。 |
显示名称 | 细绳 | 用户的显示名称。 |
电子邮件 | 细绳 | 用户的主要电子邮件(如果已设置)。 |
电子邮件已验证 | 布尔值 | 用户的主要电子邮件是否经过验证。 |
元数据 | 用户元数据请求 | 有关用户的其他元数据。 |
多因素 | 多因素更新设置 | 用户的多因素相关属性。 |
密码哈希值 | 缓冲 | 表示用户哈希密码的字节缓冲区。当要使用密码哈希导入用户时,需要指定UserImportOptions来标识用于生成此哈希的哈希算法。 |
密码盐 | 缓冲 | 表示用户密码盐的字节缓冲区。 |
电话号码 | 细绳 | 用户的主要电话号码(如果已设置)。 |
照片网址 | 细绳 | 用户的照片 URL。 |
提供者数据 | 用户提供者请求[] | 链接到用户的一系列提供商(例如 Google、Facebook)。 |
租户ID | 细绳 | 要将用户导入到的租户的标识符。如果未在admin.auth.Auth 上下文中提供,则用户将上传到默认父项目。如果未在admin.auth.TenantAwareAuth 上下文中提供,则用户将上传到与该TenantAwareAuth 实例的租户 ID 对应的租户。 |
uid | 细绳 | 用户的uid 。 |
UserImportRecord.customClaims
用户的自定义声明对象(如果可用)通常用于定义用户角色并传播到经过身份验证的用户的 ID 令牌。
签名:
customClaims?: {
[key: string]: any;
};
UserImportRecord.disabled
用户是否禁用: true
为禁用; false
表示已启用。
签名:
disabled?: boolean;
用户导入记录.显示名称
用户的显示名称。
签名:
displayName?: string;
用户导入记录.email
用户的主要电子邮件(如果已设置)。
签名:
email?: string;
用户导入记录.emailVerified
用户的主要电子邮件是否经过验证。
签名:
emailVerified?: boolean;
用户导入记录.元数据
有关用户的其他元数据。
签名:
metadata?: UserMetadataRequest;
用户导入记录.multiFactor
用户的多因素相关属性。
签名:
multiFactor?: MultiFactorUpdateSettings;
用户导入记录.passwordHash
表示用户哈希密码的字节缓冲区。当要使用密码哈希导入用户时,需要指定UserImportOptions来标识用于生成此哈希的哈希算法。
签名:
passwordHash?: Buffer;
UserImportRecord.passwordSalt
表示用户密码盐的字节缓冲区。
签名:
passwordSalt?: Buffer;
用户导入记录.电话号码
用户的主要电话号码(如果已设置)。
签名:
phoneNumber?: string;
用户导入记录.photoURL
用户的照片 URL。
签名:
photoURL?: string;
用户导入记录.providerData
链接到用户的一系列提供商(例如 Google、Facebook)。
签名:
providerData?: UserProviderRequest[];
用户导入记录.tenantId
要将用户导入到的租户的标识符。如果未在admin.auth.Auth
上下文中提供,则用户将上传到默认父项目。如果未在admin.auth.TenantAwareAuth
上下文中提供,则用户将上传到与该TenantAwareAuth
实例的租户 ID 对应的租户。
签名:
tenantId?: string;
用户导入记录.uid
用户的uid
。
签名:
uid: string;