Method: projects.tenants.accounts

注册新的电子邮件和密码用户或匿名用户，或将匿名用户升级为电子邮件和密码用户。对于具有适当权限的 Google OAuth 2.0 凭据的管理员请求，会创建新的匿名用户、电子邮件和密码用户或电话号码用户。

请求中必须包含 API 密钥，以便识别 Google Cloud 项目。

HTTP 请求

POST https://identitytoolkit.googleapis.com/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts

网址采用 gRPC 转码语法。

路径参数

参数
targetProjectId

string

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

string

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

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "email": string,
  "password": string,
  "displayName": string,
  "captchaChallenge": string,
  "captchaResponse": string,
  "instanceId": string,
  "idToken": string,
  "emailVerified": boolean,
  "photoUrl": string,
  "disabled": boolean,
  "localId": string,
  "phoneNumber": string,
  "mfaInfo": [
    {
      object (MfaFactor)
    }
  ],
  "clientType": enum (ClientType),
  "recaptchaVersion": enum (RecaptchaVersion)
}
字段
email

string

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

string

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

string

要创建的用户的显示名称。
captchaChallenge
(deprecated)

string
captchaResponse

string

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

string
idToken

string

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

boolean

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

string

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

boolean

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

string

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

string

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

object (MfaFactor)

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

enum (ClientType)

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

enum (RecaptchaVersion)

captchaResponse 中 reCAPTCHA 令牌的 reCAPTCHA 版本。

响应正文

如果成功，则响应正文包含一个 SignUpResponse 实例。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。