UpdateRequest interface

表示要针对指定用户更新的属性的接口。

签名：

export interface UpdateRequest

属性

属性 类型 说明
已停用 布尔值 用户是否被停用：true 表示已停用；false 表示已启用。
displayName 字符串 |null 用户的显示名称。
email 字符串 用户的主电子邮件地址。
emailVerified 布尔值 用户的主电子邮件地址是否通过验证。
多重身份验证 MultiFactorUpdateSettings 用户更新后的多重身份验证属性。
密码 字符串 用户未经哈希处理的密码。
phoneNumber 字符串 |null 用户的主电话号码。
photo网址 字符串 |null 用户的照片网址。
providersTo 取消关联 字符串[] 解除此用户与指定提供商的关联。
providerToLink UserProvider 将此用户关联到指定的提供方。将提供方关联至现有用户账号不会导致该账号的刷新令牌失效。换言之，现有账号仍可继续访问资源，即使未使用新关联的提供方登录。如果您想要强制用户使用以下新的提供方进行身份验证，您需要 (a) 撤消用户的刷新令牌（请参阅 https://firebase.google.com/docs/auth/admin/manage-sessions#revoke_refresh_tokens），并 (b) 确保此账号中不存在其他身份验证方法。

UpdateRequest.disabled

用户是否被停用：true 表示已停用；false 表示已启用。

签名：

disabled?: boolean;

UpdateRequest.displayName

用户的显示名称。

签名：

displayName?: string | null;

UpdateRequest.email

用户的主电子邮件地址。

签名：

email?: string;

UpdateRequest.emailVerified

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

签名：

emailVerified?: boolean;

UpdateRequest.multiFactor

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

签名：

multiFactor?: MultiFactorUpdateSettings;

UpdateRequest.password

用户未经哈希处理的密码。

签名：

password?: string;

UpdateRequest.phoneNumber

用户的主电话号码。

签名：

phoneNumber?: string | null;

UpdateRequest.photo网址

用户的照片网址。

签名：

photoURL?: string | null;

解除此用户与指定提供商的关联。

签名：

providersToUnlink?: string[];

将此用户关联到指定提供方。

将提供方关联至现有用户账号不会导致该账号的刷新令牌失效。换言之，现有账号仍可继续访问资源，即使未使用新关联的提供方登录。如果您想要强制用户使用以下新的提供方进行身份验证，您需要 (a) 撤消用户的刷新令牌（请参阅 https://firebase.google.com/docs/auth/admin/manage-sessions#revoke_refresh_tokens），并 (b) 确保此账号中不存在其他身份验证方法。

签名：

providerToLink?: UserProvider;