Package google.cloud.identitytoolkit.v1

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

int32

必需。所需的哈希长度（以字节为单位）。最小值为 4，最大值为 1024。

HashType

必需。不得为 HASH_TYPE_UNSPECIFIED。

int32

必需。并行度，也称为线程或通道。最小值为 1，最大值为 16。

int32

必需。要执行的迭代次数。最小值为 1，最大值为 16。

int32

必需。内存开销（以 kibibyte 为单位）。最大值为 32768。

Version

Argon2 算法的版本。如果未指定，则默认为 VERSION_13。

bytes

其他关联的数据（如果提供）会附加到哈希值以提供一层额外的安全防护。如果通过 JSON 指定，则为 base64 编码的字符串。

string

如果指定了 tenant_id，则为 Identity Platform 租户所属的 Google Cloud 项目的 ID。否则，请使用账号所属的 Google Cloud 项目的 ID。

必须对指定的资源 targetProjectId 具有以下 IAM 权限才能进行授权：

• firebaseauth.users.delete

string

必需。要删除的用户 ID 的列表。

bool

是否强制删除非停用状态的账号。如果为 false，则仅会删除已停用的账号，未停用的账号会添加到 errors。

string

如果账号属于 Identity Platform 租户，请提供租户的 ID。如果账号属于默认的 Identity Platform 项目，则无需填写此字段。

BatchDeleteErrorInfo

有关无法删除的账号的详细错误信息。

int32

原始 local_ids 字段中出错项的索引。

string

相应的用户 ID。

string

详细的错误消息。

string

要为其提取关联提供商的用户账号的电子邮件标识符。必须设置 identifier 和 provider_id 字段中至少一个。

电子邮件地址的长度应少于 256 个字符，且采用 name@domain.tld 格式。电子邮件地址还应符合 RFC 822 addr-spec 生产规范。

string

IDP 将用户重定向回的有效网址。网址不得包含片段或预留的 state 查询参数。

string

string

用户用于登录的 IdP 的提供方 ID。这应是已启用登录的提供方 ID，该 ID 应来自默认受支持的 IdP 列表，或采用 oidc.* 或 saml.* 格式。一些示例包括 google.com、facebook.com、oidc.testapp 和 saml.testapp。必须设置 identifier 和 provider_id 字段中至少一个。

string

string

其他以空格分隔的 OAuth 2.0 范围，用于指定与 IdP 的身份验证请求的范围。用于 OAuth 2.0 IdP。

对于 Google 提供程序，如果设置此字段，系统将使用授权代码流程。

string

一个不透明字符串，用于在身份验证请求和来自 IdP 的回调之间维护上下文信息。

string

string

string

用于 Google 提供程序。用户的 G Suite 托管网域，用于限制该网域中的用户登录。

string

可在 SignInWithIdp 中进行验证的会话 ID，以防止会话固定攻击。如果不存在，系统会生成一个随机字符串并将其作为会话 ID 返回。

string

用于 Google 提供程序。要使用的身份验证流程的类型。如果存在，此值应为 CODE_FLOW，以指定授权代码流程。否则，系统将使用默认的 ID 令牌流程。

map<string, string>

要添加到授权 URI 中的其他自定义查询参数。以下参数已预留，无法添加：client_id、response_type、scope、redirect_uri、state。

对于 Microsoft 提供程序，您可以在 tenant 自定义参数中指定要登录的 Azure AD 租户。

string

要为其创建授权 URI 或查找电子邮件标识符的 Identity Platform 租户的 ID。如果未设置，则操作将在项目的默认 Identity Platform 实例中执行。

string

string

请求的提供程序的授权 URI。仅当请求中设置了提供程序 ID 时才会显示。

string

bool

电子邮件标识符是否代表现有账号。仅当请求中设置了电子邮件标识符时才会显示。

string

请求中的提供方 ID（如果有）。

bool

用户之前是否使用过请求中的提供方 ID 进行登录。仅当请求中设置了已注册的电子邮件标识符时才会显示。

bool

是否因用户登录尝试失败次数过多而需要显示 CAPTCHA 验证。仅当请求中设置了已注册的电子邮件标识符时才会显示。

string

请求中的会话 ID，如果没有，则为 CreateAuthUri 生成的随机字符串。它用于防止会话固定攻击。

string

用户之前使用过的登录方法的列表。每个元素都是 password、emailLink 或 IdP 的提供方 ID 之一。仅当请求中设置了已注册的电子邮件标识符时才会显示。如果启用了电子邮件枚举保护，此方法会返回空列表。

string

必需。有效的 Identity Platform ID 令牌。

int64

会话 Cookie 过期前剩余的时间（以秒为单位）。以秒为单位指定时长，时长应介于 5 分钟到 14 天（包括这两个数值）之间。

string

账号所属项目的 ID。

string

账号所属 Identity Platform 租户的租户 ID。

string

使用请求中指定的 Identity Platform ID 令牌创建的会话 Cookie。它采用 JSON Web 令牌 (JWT) 的形式。始终存在。

string

要删除的用户账号的 ID。若要指定此字段，您需要拥有具有适当权限的 Google OAuth 2.0 凭据。缺少凭据的用户发出的请求应改为传递 ID 令牌。

int64

string

要删除的账号的 Identity Platform ID 令牌。对于缺少 Google OAuth 2.0 凭据的最终用户发来的请求，必须指定此参数。具有适当权限的 Google OAuth2 凭据的身份验证请求可以改为传递 local_id 来指定要删除的账号。

string

账号所属的租户的 ID（如果适用）。仅适用于包含 Google OAuth 2.0 凭据且指定了属于 Identity Platform 租户的账号的 local_id 的已验证请求。

string

账号所属项目的 ID。仅应在指定账号的 local_id 的已验证请求中指定。

必须对指定的资源 targetProjectId 具有以下 IAM 权限才能进行授权：

• firebaseauth.users.delete

string

int64

string

上一个请求响应中的分页令牌。

int32

返回的结果数上限。必须至少为 1，且不得超过 1000。默认值为 20。

string

如果指定了 tenant_id，则为 Identity Platform 租户所属的 Google Cloud 项目的 ID。否则，请使用账号所属的 Google Cloud 项目的 ID。

必须对指定的资源 targetProjectId 具有以下 IAM 权限才能进行授权：

• firebaseauth.users.get

string

账号所属的 Identity Platform 租户的 ID。如果未指定，则返回 Identity Platform 项目中的账号。

string

UserInfo

属于请求中 max_results 限制的项目/租户的所有账号。

string

如果还有更多账号要下载，则是一个可传回 DownloadAccount 以获取更多账号的令牌。否则，此字段为空。

string

应将多重身份验证 (MFA) 验证信息发送到的电子邮件地址。

bool

模板是否已停用。如果为 true，系统将使用默认模板。

string

电子邮件的发件人地址

string

电子邮件正文

string

电子邮件主题

string

按显示名称

EmailBodyFormat

电子邮件正文格式

string

回复地址

string

发件人地址的本地部分

string

值采用 III 语言代码格式（例如“zh-CN”“es”）。接受“-”和“_”分隔符。

bool

电子邮件的正文或主题是否经过自定义。

int32

项的索引，范围为 [0, request.size - 1]

string

详细错误消息

string

要提取的账号的 Identity Platform ID 令牌。对于来自最终用户的请求，必须指定此值。

string

要提取的一个或多个账号的 ID。仅应由具有适当权限的 Google OAuth 2.0 凭据的经过身份验证的请求指定。

string

要提取的 1 个或多个账号的电子邮件地址。电子邮件的长度应少于 256 个字符，且采用 name@domain.tld 格式。电子邮件地址还应符合 RFC 822 addr-spec 生产规范。应仅由开发者发出的经过身份验证的请求指定。

int64

string

要提取的一个或多个账号的电话号码。应仅由开发者通过经过身份验证的请求指定，且应采用 E.164 格式，例如 +15555555555。

FederatedUserIdentifier

string

账号所属的租户的 ID。应仅由开发者发出的经过身份验证的请求指定。

string

由 tenant_id 指定的账号或 Identity Platform 租户所属的 Google Cloud 项目的 ID。仅应由具有适当权限的 Google OAuth 2.0 凭据的经过身份验证的请求指定。

必须对指定的资源 targetProjectId 具有以下 IAM 权限才能进行授权：

• firebaseauth.users.get

string

要提取的一个或多个账号的原始电子邮件地址。电子邮件的长度应少于 256 个字符，且采用 name@domain.tld 格式。电子邮件地址还应符合 RFC 822 addr-spec 生产规范。应仅由开发者发出的经过身份验证的请求指定。

string

支持的身份提供方的 ID。这应是已启用登录的提供方 ID，该 ID 应来自默认受支持的 IdP 列表，或采用 oidc.* 或 saml.* 格式。一些示例包括 google.com、facebook.com、oidc.testapp 和 saml.testapp。

string

由 provider_id 指定的第三方身份提供程序中账号的用户 ID。

string

UserInfo

与请求中的参数匹配的特定用户账号的信息。

OobReqType

必需。要发送的非通道 (OOB) 代码的类型。根据此值，此请求中的其他字段将是必需的和/或具有不同的含义。系统可以发送 4 种不同的 OOB 验证码：* PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL

string

要向其发送 OOB 码的账号的电子邮件地址，通常是需要更新的账号的电子邮件地址。对于 PASSWORD_RESET、EMAIL_SIGNIN 和 VERIFY_EMAIL，此属性为必需属性。仅当 return_oob_link 设置为 true 时，VERIFY_AND_CHANGE_EMAIL 请求才需要此参数。在本例中，此值为用户的原始电子邮件地址。

string

string

对于 PASSWORD_RESET 请求，如果系统检测到可能存在滥用活动，则需要 reCaptcha 响应。在这些情况下，此参数是用于验证调用方的 reCaptcha 质询的响应。

string

调用方的 IP 地址。仅 PASSWORD_RESET 请求需要此参数。

string

要更新到的账号电子邮件地址。仅对于 VERIFY_AND_CHANGE_EMAIL 请求是必需的。

string

账号的 ID 令牌。除非将 return_oob_link 设置为 true，否则 VERIFY_AND_CHANGE_EMAIL 和 VERIFY_EMAIL 请求需要此参数。

string

用户点击电子邮件中发送的链接后要继续访问的网址。此网址可让 Web 微件处理 OOB 代码。

string

如果关联的 iOS 应用可以处理 OOB 代码，则为此应用的 iOS 软件包 ID。这样，系统便会在正确的应用已安装时打开该应用。

string

如果关联的 iOS 应用可以处理 OOB 代码，则此应用的 App Store ID。这样，如果应用尚未安装，App Store 便会打开正确的应用。

string

如果关联的 Android 应用可以处理 OOB 代码，则是将在使用此 OOB 代码时处理回调的 Android 应用的 Android 软件包名称。这样，如果应用已安装，系统就会打开正确的应用；如果应用尚未安装，系统就会在打开 Google Play 商店时跳转到正确的应用。

bool

如果关联的 Android 应用可以处理 OOB 代码，则在打开链接的设备上是否安装该 Android 应用（如果该应用尚未安装）。

string

如果关联的 Android 应用可以处理 OOB 代码，则为该应用的最低版本。如果设备上的版本低于此版本，系统会将用户定向至 Google Play 商店以升级应用。

bool

当设置为 true 时，OOBE 代码链接将以通用链接或 Android 应用链接的形式发送；如果用户已安装相应应用，该链接将在应用中打开。如果未设置或设置为 false，系统会先将 OOB 代码发送到 Web widget，然后在接续时重定向到应用（如果已安装应用）。

string

账号所属 Identity Platform 租户的租户 ID。

string

账号所属 Identity Platform 项目的项目 ID。如需指定此字段，您需要具有适当权限的 Google OAuth 2.0 凭据。

必须对指定的资源 targetProjectId 具有以下 IAM 权限才能进行授权：

• firebaseauth.users.sendEmail

string

为了确保所用的网址可以在 iOS 或 Android 设备上轻松打开，我们创建了一个 Firebase Dynamic Links。大多数 Identity Platform 项目只会启用一个动态链接网域，因此可以将此字段留空。对于启用了多个动态链接的项目，此字段包含指定的动态链接网域。

bool

是否应在响应中返回包含 OOB 代码的确认链接（不会发送电子邮件）。当开发者想要自行构建电子邮件模板并发送时使用。默认情况下，此值为 false；如需指定此字段并将其设为 true，则需要具有适当权限的 Google OAuth 2.0 凭据

ClientType

客户端类型：网站、Android 或 iOS。启用 reCAPTCHA Enterprise 保护时，此字段为必填。

RecaptchaVersion

captcha_response 中 reCAPTCHA 令牌的 reCAPTCHA 版本。

string

可选。为确保所用网址可以在 iOS 或 Android 设备上轻松打开，我们创建了托管链接“/__/auth/links”。此可选字段包含构建 Hosting 链接时要使用的网域。如果未设置，系统将使用“.firebaseapp.com”网域。

string

string

如果请求中的 return_oob_link 为 true，则表示要发送的 OOB 代码。

string

如果请求中的 return_oob_link 为 false，则为发送验证信息的电子邮件地址。

string

如果请求中的 return_oob_link 为 true，则表示要发送给用户的 OOB 链接。这会返回构建的链接，其中包含 Firebase Dynamic Links 相关参数。

int64

委托项目请求的项目编号。此字段应仅在 Firebase V1 迁移过程中使用。

int64

要检索的配置的项目编号。此字段已废弃，新集成不应使用此字段。

bool

是否应返回动态链接。

string

与真实 Android 软件包名称进行对比的 Android 软件包名称。如果提供此字段但未提供 sha1_cert_hash，并且此字段与真实的 Android 软件包名称不匹配，则操作将抛出错误。

string

要与真实的 iOS 软件包 ID 进行对比的 iOS 软件包 ID。如果提供了此字段，如果此字段与真实的 iOS 软件包 ID 不匹配，相应操作将抛出错误。

string

RP OAuth 客户端 ID。如果已设置，系统会执行检查，以确保 OAuth 客户端对检索到的项目有效，如果无效，则会使用客户端错误拒绝请求。

string

SHA-1 Android 应用证书哈希。如果已设置，系统会执行检查，以确保证书哈希值对检索到的项目和 android_package_name 有效。

string

Firebase 应用 ID（适用于使用 Firebase 的应用）。您可以在项目的 Firebase 控制台中找到此信息。如果已设置，系统会执行检查，以确保应用 ID 对检索到的项目有效。如果无效，请求将被拒绝并显示客户端错误。

string

检索到的配置的项目 ID。

string

Google Cloud API 密钥。只有来自开发者的经过身份验证的调用才会返回此字段。

bool

是否允许使用密码账号注册。只有来自开发者的经过身份验证的调用才会返回此字段。

IdpConfig

OAuth2 提供方配置。只有来自开发者的经过身份验证的调用才会返回此字段。

string

用于 widget 重定向的已获授权网域。

bool

是否启用了匿名用户。只有来自开发者的经过身份验证的调用才会返回此字段。

string

用于构建指向原生应用的重新定向链接的 Firebase Dynamic Links 网域。

bool

是否使用电子邮件发送。只有来自开发者的经过身份验证的调用才会返回此字段。

EmailTemplate

用于重置密码的电子邮件模板。只有来自开发者的经过身份验证的调用才会返回此字段。

EmailTemplate

用于验证电子邮件的电子邮件模板。只有来自开发者的经过身份验证的调用才会返回此字段。

EmailTemplate

用于更改电子邮件的电子邮件模板。只有来自开发者的经过身份验证的调用才会返回此字段。

EmailTemplate

旧版 Firebase V1 应用的重置密码电子邮件模板。只有在开发者进行身份验证的调用时，系统才会返回此字段。

EmailTemplate

用于还原添加的第二重身份验证方法的电子邮件模板。只有来自开发者的经过身份验证的调用才会返回此字段。

string

string

string

用于调用 reCAPTCHA 服务的 reCAPTCHA v2 网站密钥。始终存在。

string

用于生成 PIA 令牌的生产者项目编号

OpenIdConnectKey

会话 Cookie Signer 的公钥，格式为 JSON Web 密钥 (JWK)。

Provider

bool

如果允许用户使用提供方进行登录，则为 true。

int32

系统会针对此 IdP 向多少用户提示/重定向联合登录

string

OAuth2 客户端 ID。

string

OAuth2 客户端密钥。

string

用于受众群体检查的已列入白名单的客户端 ID。

string

依赖方标识符，即发出的 SAMLResponse 的受众群体。

string

Identity Platform ID 令牌。系统会对其进行验证，然后将其转换为新的 SAMLResponse。

string

Google 管理控制台中为每款应用指定的 SAML 应用实体 ID。如果开发者希望重定向到第三方应用而非 G Suite 应用，则可能需要此 ID。使用此参数时，我们将返回 RelayState。其中包括 SAMLRequest，可用于触发由 SP 发起的 SAML 流程以重定向到真实应用。

string

为信赖方创建的已签名 SAMLResponse。

string

使用返回的 SAMLResponse 的 ACS 端点。

string

生成的 RelayState。

string

用户的电子邮件地址。

string

用户的名字。

string

用户的姓氏。

bool

登录用户是否由此请求创建。

string

此多重身份验证选项的 ID。

string

此多重身份验证选项的显示名称，例如“公司手机”。

Timestamp

账号注册此第二重身份验证时的时间戳。

string

通常，此处会显示与此注册相关联的电话号码。在某些情况下（例如在使用第一要素登录后），系统只会显示经过混淆处理的关联电话号码。

TotpInfo

包含特定于 TOTP 多重身份验证的信息。

EmailInfo

包含特定于电子邮件多重身份验证的信息。

string

仅限输出。未经过混淆处理的 phone_info。

string

密钥类型。

string

签名算法。

string

密钥用途。

string

用于标识此键的唯一字符串。

string

RSA 公钥的模数，表示为值的大端序表示法的 base64url 编码。

string

RSA 公钥的指数，表示为值的大端序表示法的 base64url 编码。

string

身份提供方的 ID。

string

用户在身份提供程序中的显示名称。

string

用户在身份提供方的个人资料照片网址。

string

用户在身份提供商中的标识符。

string

用户在身份提供程序中的电子邮件地址。

string

直接从身份提供方返回的用户的原始标识符。

string

用户的 Twitter 屏幕名称或 GitHub 登录名称。

string

用户在身份提供程序中的电话号码。

bool

如果为 true，此请求将返回与查询匹配的账号。如果为 false，则仅返回与查询匹配的账号的数量。默认值为 true。

int64

要返回的账号数量上限（上限为 500）。默认值为 500。仅在 return_user_info 设置为 true 时有效。

int64

从匹配记录开头跳过的账号数量。仅在 return_user_info 设置为 true 时有效。

SortByField

Order

string

结果所属的项目的 ID。

必须对指定的资源 targetProjectId 具有以下 IAM 权限才能进行授权：

• firebaseauth.users.get

string

结果所属租户的 ID。

SqlExpression

string

账号的电子邮件地址应与此不区分大小写的字符串匹配。在 SqlExpression 中，应仅指定 email、phone_number 或 user_id 之一。如果指定了多个，则系统只会应用第一个（按顺序）。

string

账号的本地 ID 应与此字符串匹配。SqlExpression 中应仅指定 email、phone_number 或 user_id 之一。如果指定多个，则仅应用第一个（按顺序）。

string

账号的电话号码应与此字符串匹配。在 SqlExpression 中，应仅指定 email、phone_number 或 user_id 之一。如果指定了多个，则系统只会应用第一个（按顺序）。

int64

如果请求中的 return_user_info 为 true，则此值为此消息中返回的账号数量。否则，此值为与查询匹配的账号总数。

UserInfo

如果请求中的 return_user_info 为 true，则表示与查询匹配的账号。

string

由 GetOobCode 请求生成的带外 (OOB) 代码。仅指定此参数（或仅指定此参数和租户 ID）即可在响应中获取外部代码的类型，而无需更改账号的状态。只能通过此方法使用 PASSWORD_RESET 异步代码。

string

要为此账号设置的新密码。指定此字段将导致更改账号，并使用非正规验证码（如果指定了此类验证码且其类型为 PASSWORD_RESET）。

string

要修改的账号的当前密码。指定此值并发送电子邮件，即可在不使用外部代码的情况下更改账号的密码。

string

可选。要修改的账号的电子邮件地址。请指定此值和旧密码，以便在不使用外部代码的情况下更改账号的密码。

string

可选。账号所属 Identity Platform 租户的租户 ID。

string

string

与所用外部代码关联的电子邮件地址。

string

OobReqType

MfaEnrollment

string

用于接收验证码的电话号码（采用 E.164 格式）。

string

收到 iOS 应用令牌验证成功的通知。如果未使用“captcha_response”（未启用 reCAPTCHA Enterprise），则必须指定 ios_receipt 和 ios_secret、recaptcha_token 或 safety_net_token 中的至少一个，以验证验证码是否代表真实应用（而非模拟器）发送。此值应来自 [verifyIosClient][v1.accounts.verifyIosClient] 的响应。调用方还应在 x-ios-bundle-identifier 标头中提供 ios_secret 和软件包 ID（如果有），该软件包 ID 必须与 [verifyIosClient][v1.accounts.verifyIosClient] 请求中的软件包 ID 一致。

string

以推送通知的形式传送到 iOS 应用的 Secret。应与 ios_receipt 和 x-ios-bundle-identifier 标头一起传递。

string

用于应用验证的 reCAPTCHA 令牌。如果未使用“captcha_response”（未启用 reCAPTCHA Enterprise），则必须指定 ios_receipt 和 ios_secret、recaptcha_token 或 safety_net_token 中的至少一个，以验证验证码是否代表真实应用（而非模拟器）发送。应通过调用 [getRecaptchaParams][v1.getRecaptchaParams] 生成 reCAPTCHA，并且在用户完成 reCAPTCHA 质询后，系统会生成 reCAPTCHA 令牌。

string

用户登录的 Identity Platform 租户的租户 ID。

AutoRetrievalInfo

仅限 Android 设备。供 Google Play 服务用于识别要自动检索的应用。

string

仅限 Android 设备。用于声明应用身份，取代 reCAPTCHA 令牌。如果未使用“captcha_response”（未启用 reCAPTCHA Enterprise），则必须指定 ios_receipt 和 ios_secret、recaptcha_token 或 safety_net_token 中的至少一个，以验证验证码是否代表真实应用（而非模拟器）发送。您可以通过 SafetyNet Android Attestation API 生成 SafetyNet 令牌，并将 phone_number 字段的 Base64 编码用作 Nonce。

string

仅限 Android 设备。用于断言应用身份，取代 recaptcha 令牌（和 safety_net_token）。如果未使用“captcha_response”（未启用 reCAPTCHA Enterprise），则必须指定 ios_receipt 和 ios_secret、recaptcha_token 或 play_integrity_token 中的至少一个，以验证验证码是否代表真实应用（而非模拟器）发送。您可以通过 PlayIntegrity API 生成 Play Integrity 令牌，方法是将 SHA256 应用于 phone_number 字段作为 Nonce。

string

可选。reCAPTCHA 客户端集成提供的 reCAPTCHA Enterprise 令牌。启用 reCAPTCHA Enterprise 时必填。

ClientType

可选。客户端类型，即 web、android 或 ios。启用 reCAPTCHA Enterprise 时必填。

RecaptchaVersion

可选。captcha_response 中 reCAPTCHA 令牌的 reCAPTCHA 版本。启用 reCAPTCHA Enterprise 时必填。

string

Google Play 服务的 SMS Retriever API 的 Android 应用签名哈希。

string

加密的会话信息。您可以在 [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber] 中使用此值来对电话号码进行身份验证。

string

有效的 Identity Platform ID 令牌。在尝试更改与用户相关的信息时，此权限为必需权限。

string

用户的 ID。若要指定此字段，您需要拥有具有适当权限的 Google OAuth 2.0 凭据。对于来自最终用户的请求，应改为传递 ID 令牌。

string

要更新在账号属性中的用户的新显示名称。显示名称的长度不得超过 256 个字符。

string

要更新账号属性中的用户新电子邮件地址。电子邮件的长度应少于 256 个字符，且采用 name@domain.tld 格式。电子邮件地址还应符合 RFC 822 addr-spec 生产规范。如果启用了电子邮件枚举保护，用户必须先验证电子邮件地址，然后才能更改电子邮件地址，但管理员可以更改电子邮件地址。

string

要更新在账号属性中的用户新密码。密码长度必须至少为 6 个字符。

string

应与该账号相关联的身份提供方。

string

要应用于用户账号的非对称加密代码。支持以下非现场验证码类型：* VERIFY_EMAIL * RECOVER_EMAIL * REVERT_SECOND_FACTOR_ADDITION * VERIFY_AND_CHANGE_EMAIL

bool

用户的电子邮件是否已通过验证。若要指定此字段，您需要拥有具有适当权限的 Google OAuth 2.0 凭据。

bool

是否应限制账号只能使用联合登录。

string

string

来自 reCAPTCHA 验证的响应。当系统检测到可能存在滥用活动时，此操作是必需的。

int64

指定 Identity Platform ID 令牌被视为有效的最短时间戳（以秒为单位）。

bool

如果为 true，则将账号标记为已停用，这意味着用户将无法再登录。

string

int64

string

用户的新照片网址，用于更新账号属性中的账号个人资料照片。网址的长度不得超过 2048 个字符。

UserAttributeName

bool

是否返回 ID 和刷新令牌。应始终为 true。

string

要解除与用户账号的关联的身份提供方。

int64

账号上次登录的时间戳（以毫秒为单位）。

int64

账号创建时的时间戳（以毫秒为单位）。

string

要更新的账号属性中的电话号码。

string

要存储在 Identity Platform ID 令牌中的 JSON 格式自定义属性。若要指定此字段，您需要拥有具有适当权限的 Google OAuth 2.0 凭据。

string

账号所属的 Identity Platform 租户的租户 ID。来自最终用户的请求应传递 Identity Platform ID 令牌，而不是设置此字段。

string

账号所属项目的项目 ID。若要指定此字段，您需要具有适当权限的 Google OAuth 2.0 凭据。来自最终用户的请求应改为传递 Identity Platform ID 令牌。

必须对指定的资源 targetProjectId 具有以下 IAM 权限才能进行授权：

• firebaseauth.users.update

MfaInfo

要在用户账号中设置的多重身份验证相关信息。这将覆盖账号中之前的所有多重身份验证相关信息。若要指定此字段，您需要拥有具有适当权限的 Google OAuth 2.0 凭据。

ProviderUserInfo

要与用户账号相关联的提供商。若要指定此字段，您需要拥有具有适当权限的 Google OAuth 2.0 凭据。

MfaEnrollment

用户已注册的第二重身份验证。

string

string

经过身份验证的用户的 ID。

string

账号的电子邮件地址。

string

账号的显示名称。

string

账号的 Identity Platform ID 令牌。此参数用于旧版用户注册。

ProviderUserInfo

账号中关联的身份提供方。

string

已在用户的账号属性中设置的新电子邮件地址。

string

用户个人资料照片的照片网址。

string

账号的刷新令牌。此参数用于旧版用户注册。

int64

Identity Platform ID 令牌到期前的秒数。

string

已弃用。目前不会返回实际的密码哈希。

bool

账号的电子邮件是否已通过验证。

string

必需。开发者断言的自定义身份验证令牌。令牌应为 JSON Web 令牌 (JWT)，其中包含API 参考文档“自定义令牌声明”部分中列出的声明。

string

bool

应始终为 true。

int64

string

用户登录的 Identity Platform 租户的 ID。如果存在，该 ID 应与令牌中的 tenant_id 匹配。

string

string

经过身份验证的用户的 Identity Platform ID 令牌。

string

经过身份验证的用户的 Identity Platform 刷新令牌。

int64

ID 令牌到期前的秒数。

bool

经过身份验证的用户是否由此请求创建。

string

必需。电子邮件链接中的非对称代码。

string

必需。登录链接发送到的电子邮件地址。电子邮件的长度应少于 256 个字符，且采用 name@domain.tld 格式。电子邮件地址还应符合 RFC 822 addr-spec 生产规范。

string

Identity Platform 账号的有效 ID 令牌。如果通过，此请求将将电子邮件地址与此 ID 令牌所代表的用户相关联，并在日后为该账号启用通过电子邮件链接登录功能。

string

用户登录的 Identity Platform 租户的 ID。如果未设置，用户将登录默认的 Identity Platform 项目。

string

string

经过身份验证的用户的 Identity Platform ID 令牌。

string

用户登录时使用的电子邮件地址。始终存在于响应中。

string

经过身份验证的用户的刷新令牌。

int64

ID 令牌到期前的秒数。

string

经过身份验证的用户的 ID。始终存在于响应中。

bool

经过身份验证的用户是否由此请求创建。

string

不透明字符串，用于证明用户已成功通过第一重身份验证。

MfaEnrollment

已启用的多重身份验证提供程序的相关信息。如果用户需要使用多重身份验证完成登录，则显示此按钮。

string

必需。用户的 Game Center 玩家 ID。已被 Apple 弃用。

将 playerID 与 gamePlayerID 和 teamPlayerID 一起传递，以启动将用户的 Game Center 玩家 ID 迁移到 gamePlayerID 的流程。

string

必需。用于提取 Apple 公钥以验证给定签名是否由 Apple 签名的网址。

string

必需。Apple 生成的验证签名数据。

string

必需。用于生成给定签名的随机字符串。

int64

必需。Apple 创建签名的时间（以自公元纪年以来的毫秒数表示）。

string

Identity Platform 账号的有效 ID 令牌。如果存在，此请求会将 Game Center 玩家 ID 与此 ID 令牌所代表的账号相关联。

string

用户的 Game Center 显示名称。

string

用户登录的 Identity Platform 租户的 ID。

string

用户的 Game Center 团队玩家 ID。您使用开发者账号分发的所有游戏的玩家的唯一标识符。https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid

string

用户的 Game Center 游戏玩家 ID。游戏玩家的唯一标识符。https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid

string

经过身份验证的用户的 ID。始终存在于响应中。

string

用户的 Game Center 玩家 ID。

将 playerID 与 gamePlayerID 和 teamPlayerID 一起传递，以启动将用户的 Game Center 玩家 ID 迁移到 gamePlayerID 的流程。

string

经过身份验证的用户的 Identity Platform ID 令牌。

string

经过身份验证的用户的 Identity Platform 刷新令牌。

int64

ID 令牌到期前的秒数。

bool

登录用户是否由此请求创建。

string

经过身份验证的用户的显示名称。

string

用户的 Game Center 团队玩家 ID。您使用开发者账号分发的所有游戏的玩家的唯一标识符。https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid

string

用户的 Game Center 游戏玩家 ID。游戏玩家的唯一标识符。https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid

string

必需。IdP 将用户重定向回此网址。如果用户使用手动提供的 IdP 凭据登录，则可以将此值设置为 http://localhost。

string

如果用户是使用通过之前的 CreateAuthUri 授权请求获得的授权响应进行登录，则此参数是 IdP 的 HTTP POST 回调正文（如果有）。

否则，如果用户使用手动提供的 IdP 凭据进行登录，则应使用经过网址编码的表单，其中包含凭据（例如 OAuth 2.0 IdP 的 ID 令牌或访问令牌）以及签发凭据的 IdP 的提供方 ID。

例如，如果用户使用 Google ID 令牌登录 Google 提供方，则应将此值设置为 id_token=[GOOGLE_ID_TOKEN]&providerId=google.com，其中 [GOOGLE_ID_TOKEN] 应替换为 Google ID 令牌。

如果用户使用 Facebook 身份验证令牌登录 Facebook 提供程序，则应将此值设置为 id_token=[FACEBOOK_AUTHENTICATION_TOKEN]&providerId=facebook. com&nonce= [NONCE]，其中 [FACEBOOK_AUTHENTICATION_TOKEN] 应替换为 Facebook 身份验证令牌。验证令牌需要 Nonce。如果未提供 Nonce，请求将失败。

如果用户使用 Facebook 访问令牌登录 Facebook 提供程序，则应将此值设置为 access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=facebook. com，其中 [FACEBOOK_ACCESS_TOKEN] 应替换为 Facebook 访问令牌。

如果用户使用 Twitter OAuth 1.0 凭据登录 Twitter 提供程序，则应将此值设置为 access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret= [TWITTER_TOKEN_SECRET]&providerId=twitter.com，其中 [TWITTER_ACCESS_TOKEN] 和 [TWITTER_TOKEN_SECRET] 应分别替换为 Twitter OAuth 访问令牌和 Twitter OAuth 令牌密钥。

string

bool

是否从 IdP 返回 OAuth 刷新令牌（如果有）。

string

上一次调用 CreateAuthUri 返回的会话 ID。系统会根据该会话 ID 验证此字段，以防范会话固定攻击。如果用户使用之前的 CreateAuthUri 授权请求的授权响应进行登录，则必须提供此参数。

int64

string

有效的 Identity Platform ID 令牌。如果通过验证，用户在 IdP 中的账号将与此 ID 令牌所代表的账号相关联。

bool

应始终为 true。

bool

出现以下错误时是否从 IdP 返回 OAuth 凭据：FEDERATED_USER_ID_ALREADY_LINKED 和 EMAIL_EXISTS。

bool

string

用户登录的 Identity Platform 租户的 ID。如果未设置，用户将登录默认的 Identity Platform 项目。

string

上一个 SignInWithIdp 响应中的不透明字符串。如果已设置，则可用于重复上一个 SignInWithIdp 操作中的登录操作。如果用户在之前的联合登录尝试过程中需要确认其账号信息，或者执行账号关联，则可能会出现此问题。

string

用户在 IdP 中的账号 ID。始终存在于响应中。

string

用户要登录的 IdP 的提供方 ID。始终存在于响应中。

string

用户在身份提供程序 (IdP) 中的账号的电子邮件地址。

bool

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

string

用户在身份提供程序中的账号的名字。

string

用户在 IdP 中的账号的全名。

string

用户在 IdP 中的账号的姓氏。

string

用户在 IdP 中的账号的昵称。

string

IdP 中用户账号的语言偏好设置。

string

IdP 中用户账号的时区。

string

用户在身份提供程序中的个人资料照片的网址。

string

用户在 IdP 中的账号的出生日期。

string

string

用户 Identity Platform 账号的主要（顶级）电子邮件地址（如果与 IdP 中的电子邮件地址不同）。仅当启用了“每个电子邮件地址一个账号”设置时才会显示。

string

经过身份验证的 Identity Platform 用户的 ID。始终存在于响应中。

bool

是否存在使用相同电子邮件地址但与同一 IdP 中的其他账号相关联的现有 Identity Platform 用户账号。仅当启用了“每个电子邮件地址一个账号”设置且身份提供程序中的电子邮件地址已通过验证时才会出现。

string

用户在身份提供程序中的账号的显示名称。

string

经过身份验证的用户的 Identity Platform ID 令牌。

string

在 CreateAuthUri 中设置的不透明字符串，用于在身份验证请求和来自 IdP 的回调之间维护上下文信息。

string

用户可登录以解决 need_confirmation 错误的提供程序 ID 列表。仅当 need_confirmation 设置为 true 时才会存在。

bool

是否存在电子邮件地址与在 IdP 中登录的当前账号相同的现有 Identity Platform 用户账号，并且该账号的电子邮件地址未在 IdP 中经过验证。用户需要登录现有的 Identity Platform 账号，然后将 IdP 中的当前凭据与其相关联。仅当启用了“每个电子邮件地址一个账号”设置时才会显示。

string

IdP 提供的 OAuth 访问令牌（如有）。

string

IdP 中的 OAuth 2.0 刷新令牌（如果有且 return_refresh_token 设置为 true）。

int32

IdP 中的 OAuth 访问令牌到期前剩余的秒数。

string

OAuth 2.0 授权代码（如有）。仅适用于 Google 提供商。

bool

string

IdP 中的 OAuth 1.0 令牌密钥（如有）。仅适用于 Twitter 提供程序。

string

经过身份验证的用户的 Identity Platform 刷新令牌。

int64

Identity Platform ID 令牌到期前的秒数。

string

IdP 提供的 OpenID Connect ID 令牌（如有）。

string

用户在 Twitter IdP 中的账号的屏幕名称，或用户在 GitHub IdP 中的账号的登录名称。

string

字符串化的 JSON 响应，包含与用户在 IdP 中的账号对应的所有数据。

string

如果将 return_idp_credential 设置为 true 且遇到 FEDERATED_USER_ID_ALREADY_LINKED 或 EMAIL_EXISTS 错误，则返回的错误消息。此字段的值为 FEDERATED_USER_ID_ALREADY_LINKED 或 EMAIL_EXISTS。

bool

是否为经过身份验证的用户创建了新的 Identity Platform 账号。

string

string

一个不透明的字符串，可用作用户要登录的 IdP 中的凭据。此处获取的待处理令牌可在日后的 SignInWithIdp 请求中设置，以便再次使用 IdP 为同一用户登录。

string

请求中的 tenant_id 字段的值。

string

不透明字符串，用于证明用户已成功通过第一重身份验证。

MfaEnrollment

有关为账号启用了哪些多重身份验证提供方的相关信息。如果用户需要使用多重身份验证完成登录，则显示此按钮。

string

必需。用户用于登录的电子邮件地址。电子邮件的长度应少于 256 个字符，且采用 name@domain.tld 格式。电子邮件地址还应符合 RFC 822 addr-spec 生产规范。

string

必需。用户提供的用于登录账号的密码。

string

string

string

reCAPTCHA 客户端集成提供的 reCAPTCHA 令牌。reCAPTCHA Enterprise 会使用该令牌进行风险评估。启用 reCAPTCHA Enterprise 时必填。

string

int64

string

bool

应始终为 true。

string

用户登录的 Identity Platform 租户的 ID。如果未设置，用户将登录项目中的默认 Identity Platform 实例。

ClientType

客户端类型，即 web、android 或 ios。启用 reCAPTCHA Enterprise 时必填。

RecaptchaVersion

captcha_response 中 reCAPTCHA 令牌的 reCAPTCHA 版本。

string

string

经过身份验证的用户的 ID。始终存在于响应中。

string

经过身份验证的用户的电子邮件地址。始终存在于响应中。

string

存储在账号属性中的用户显示名称。

string

经过身份验证的用户的 Identity Platform ID 令牌。

bool

是否是现有账号的电子邮件。始终为 true。

string

存储在账号属性中的用户个人资料照片。

string

OAuth2 访问令牌。

int32

访问令牌的过期时间（以秒为单位）。

string

string

经过身份验证的用户的 Identity Platform 刷新令牌。

int64

Identity Platform ID 令牌到期前的秒数。

string

不透明字符串，用于证明用户已成功通过第一重身份验证。

MfaEnrollment

有关为账号启用了哪些多重身份验证提供方的相关信息。如果用户需要使用多重身份验证完成登录，则显示此按钮。

UserNotification

面向用户的警告通知。

string

[sendVerificationCode][v1.accounts.sendVerificationCode] 响应的加密会话信息。如果使用短信验证码进行身份验证，则必须指定此参数；如果使用临时证明，则可以不指定此参数。

string

用户用于登录的电话号码。如果使用临时证明，则必须提供此信息，并且此电话号码必须与生成临时证明的请求中经过身份验证的电话号码一致。如果传递了会话信息，则系统会忽略此字段。

string

用户输入的验证码，该验证码来自发送到用户手机的短信。

string

电话号码验证证明，通过之前的 [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber] 请求提供。如果传递此参数，调用方还必须在 phone_number 字段中传递之前请求中验证过的电话号码。

string

请勿使用。

string

Identity Platform 账号的有效 ID 令牌。如果通过，此请求会将电话号码与此 ID 令牌所代表的用户相关联（如果电话号码未被使用），或者会为用户重新进行身份验证（如果电话号码已与用户相关联）。

VerifyOp

string

用户登录的 Identity Platform 租户的 ID。如果未设置，用户将登录默认的 Identity Platform 项目。

string

经过身份验证的用户的 Identity Platform ID 令牌。

string

经过身份验证的用户的刷新令牌。

int64

ID 令牌到期前的秒数。

string

经过身份验证的用户的 ID。在身份验证成功的情况下显示。如果可以验证手机号码，但无法执行账号操作，系统会改为返回临时证明。

bool

经过身份验证的用户是否由此请求创建。

string

电话号码验证证明，如果电话身份验证成功但用户操作失败，则提供此证明。如果请求尝试使用 ID 令牌将电话号码与用户相关联或使用 ID 令牌重新进行身份验证，但电话号码已与其他用户相关联，就会发生这种情况。

string

请勿使用。

int64

请勿使用。

string

经过身份验证的用户的电话号码。始终存在于响应中。

int64

临时证明到期前的秒数。

string

要分配给新创建的用户的电子邮件地址。电子邮件的长度应少于 256 个字符，且采用 name@domain.tld 格式。电子邮件地址还应符合 RFC 822 addr-spec 生产规范。如果未提供，系统会创建匿名用户。

string

要分配给新创建的用户的密码。密码长度必须至少为 6 个字符。如果设置了此字段，则还必须设置 email 字段。

string

要创建的用户的显示名称。

string

string

reCAPTCHA 客户端集成提供的 reCAPTCHA 令牌。reCAPTCHA Enterprise 会使用该令牌进行评估。启用 reCAPTCHA Enterprise 时必填。

string

string

Identity Platform 用户的有效 ID 令牌。如果设置了此参数，此请求将将身份验证凭据与此 ID 令牌所代表的用户相关联。对于非管理员请求，必须同时设置 email 和 password 字段。对于管理员请求，不得设置 local_id。

bool

用户的电子邮件是否通过验证。若要指定此字段，您需要拥有具有适当权限的 Google OAuth 2.0 凭据。

string

要创建的用户的个人资料照片网址。

bool

用户在创建后是否会被停用。停用的账号无法访问，但具有适当权限的 Google OAuth2 凭据的请求除外。

string

要创建的用户的 ID。该 ID 在创建用户所在的项目中必须是唯一的。若要指定此字段，您需要拥有具有适当权限的 Google OAuth 2.0 凭据。

string

要创建的用户的电话号码。若要指定此字段，您需要拥有具有适当权限的 Google OAuth 2.0 凭据。

string

要创建用户的 Identity Platform 租户的 ID。如果未设置，系统将在默认的 Identity Platform 项目下创建用户。

string

用户应属于的项目的项目 ID。若要指定此字段，您需要拥有具有适当权限的 Google OAuth 2.0 凭据。如果未设置此值，系统会根据与 Bearer 访问令牌关联的范围推断目标项目。

MfaFactor

供用户创建的多重身份验证提供方。

ClientType

客户端类型：网站、Android 或 iOS。启用 reCAPTCHA Enterprise 保护时必填。

RecaptchaVersion

captcha_response 中 reCAPTCHA 令牌的 reCAPTCHA 版本。

string

此多重身份验证选项的显示名称，例如“公司手机”。

string

用于接收动态密码以进行多重身份验证的电话号码。

string

string

创建的用户的 Identity Platform ID 令牌。此字段仅针对非管理员请求进行设置。

string

创建的用户的显示名称。

string

创建的用户的电子邮件地址。

string

创建的用户的 Identity Platform 刷新令牌。此字段仅针对非管理员请求进行设置。

int64

ID 令牌到期前的秒数。

string

创建的用户的 ID。始终存在于响应中。

string

必需。用于对账号密码进行哈希处理的哈希函数。必须是以下各项之一：* HMAC_SHA256 * HMAC_SHA1 * HMAC_MD5 * SCRYPT * PBKDF_SHA1 * MD5 * HMAC_SHA512 * SHA1 * BCRYPT * PBKDF2_SHA256 * SHA256 * SHA512 * STANDARD_SCRYPT * ARGON2

bytes

用于对密码进行哈希处理的 signer 密钥。以下哈希函数需要此参数：* SCRYPT、* HMAC_MD5、* HMAC_SHA1、* HMAC_SHA256、* HMAC_SHA512

bytes

要插入在盐和纯文本密码之间的一个或多个字节。为了提高安全性，此字符应为单个不可打印字符。

int32

用于哈希计算的轮数。仅适用于以下哈希函数：* MD5 * SHA1 * SHA256 * SHA512 * PBKDF_SHA1 * PBKDF2_SHA256 * SCRYPT

int32

哈希计算的内存开销。仅当哈希函数为 SCRYPT 时才需要。

UserInfo

要上传的账号列表。每个用户都必须提供 local_id；所有其他信息都是可选的。

int64

bool

如果为 true，则该服务会在上传账号之前执行以下检查：* 重复的电子邮件地址 * 重复的联合身份 * 联合身份提供程序验证。如果要上传的账号列表中存在重复项，则会导致无法上传整个列表。如果电子邮件地址或联合身份 ID 与项目/租户中已有的用户重复，系统将不会上传该账号，但其他账号不会受到影响。如果为 false，系统会跳过这些检查。

string

账号所属 Identity Platform 项目的项目 ID。

必须对指定的资源 targetProjectId 具有以下 IAM 权限才能进行授权：

• firebaseauth.users.create

bool

是否使用请求中的匹配 local_id 覆盖 Identity Platform 中的现有账号。如果为 true，系统会覆盖现有账号。如果为 false，则会返回错误。

int32

STANDARD_SCRYPT 哈希函数要使用的 CPU 内存消耗参数。此参数以及 block_size 和 cpu_mem_cost 有助于调整哈希密码所需的资源，并且应随着处理器速度和内存技术的进步而进行调整。

int32

STANDARD_SCRYPT 哈希函数要使用的并行化开销参数。此参数以及 block_size 和 cpu_mem_cost 有助于调整哈希密码所需的资源，并且应随着处理器速度和内存技术的进步而进行调整。

int32

STANDARD_SCRYPT 哈希函数使用的块大小参数。此参数以及并行化和 cpu_mem_cost 有助于调整哈希化密码所需的资源，并且应随着处理器速度和内存技术的进步而进行调整。

int32

STANDARD_SCRYPT 哈希函数的所需密钥长度。不得低于 1。

PasswordHashOrder

string

账号所属的 Identity Platform 租户的 ID。

Argon2Parameters

Argon2 哈希算法的参数。

string

ErrorInfo

有关无法上传的账号的详细错误信息。

string

不可变。账号的唯一 ID。

string

账号的电子邮件地址。电子邮件的长度应少于 256 个字符，且采用 name@domain.tld 格式。电子邮件地址还应符合 RFC 822 addr-spec 规范。

string

账号的显示名称。Identity Platform 不会使用此账号属性。这些信息仅供参考。

string

仅限输出。账号的语言偏好设置。Identity Platform 不会使用此账号属性。这些信息仅供参考。

string

账号的个人资料照片的网址。Identity Platform 不会使用此账号属性。这些信息仅供参考。

string

仅限输出。账号的时区偏好设置。Identity Platform 不会使用此账号属性。这些信息仅供参考。

string

仅限输出。为账号设置的出生日期。Identity Platform 不会使用此账号属性。这些信息仅供参考。

bytes

账号的经过哈希处理的密码。只有具有适当权限的 Google OAuth2 凭据的请求才能访问。

bytes

账号的密码盐。只有具有适当权限的 Google OAuth2 凭据的请求才能访问。

int32

账号密码的版本。只有具有适当权限的 Google OAuth2 凭据的请求才能访问。

bool

账号的电子邮件地址是否已通过验证。

double

账号密码上次更新的时间戳（以自 1970-01-01T00:00:00Z 以来经历的毫秒数表示）。

ProviderUserInfo

各种身份提供商提供的用户相关信息。

int64

令牌应被视为有效的最早时间戳（自公元纪年起算，以秒为单位）。在此时间之前签发的所有 ID 令牌都将被视为无效。

bool

账号是否处于停用状态。停用的账号无法访问，除非请求包含具有适当权限的 Google OAuth2 凭据。

int64

上次登录此账号的时间（以自公元纪年以来的毫秒数表示）。

int64

账号的创建时间（以从公元纪年开始计算的毫秒数表示）。

string

仅限输出。此账号的 Twitter 屏幕名称或 GitHub 登录名称。

bool

仅限输出。此账号是否已使用 SignInWithCustomToken 进行身份验证。

string

仅限输入。用于更新账号密码的纯文本密码。此字段仅用作请求中的输入。Identity Platform 在管理密码时使用安全的加密哈希算法，并且绝不会以纯文本形式存储或传输用户的密码。

string

账号的电话号码。

string

要添加到为账号铸造的任何 ID 令牌中的自定义声明。长度不得超过 1,000 个字符，且采用有效的 JSON 格式。

bool

仅限输出。账号能否使用电子邮件链接进行身份验证。

string

此账号所属租户的 ID。仅当此账号属于租户时才设置。

MfaEnrollment

有关为此账号启用了哪些多重身份验证提供方的相关信息。

string

与此账号关联的第一个电子邮件地址。账号的初始电子邮件地址一旦设置便无法更改，并会在用户通过 GetOobCode 中的 RECOVER_EMAIL 流程丢失对此账号的访问权限时用于恢复访问权限。应与 RFC 822 addr-spec 相匹配。

Timestamp

上次为此账号铸造 ID 令牌的时间戳。

NotificationCode

警告通知枚举。可用于本地化。

string

警告通知字符串。可用作后备。

string

iOS 客户端在注册 APNs（Apple 推送通知服务）后获得的设备令牌。

bool

应用令牌是否位于 iOS 沙盒中。如果为 false，则表示应用令牌位于生产环境中。

string

收到应用令牌验证成功的通知。

int64

客户端应等待多长时间（以秒为单位）才能收到推送通知的建议时间。