Method: projects.tenants.accounts.lookup

获取所有匹配账号的账号信息。对于最终用户请求,检索最终用户的账号。对于使用 Google OAuth 2.0 凭据的管理员请求,检索符合条件的一个或多个账号。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
targetProjectId

string

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

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

  • firebaseauth.users.get
tenantId

string

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

请求正文

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

JSON 表示法
{
  "idToken": string,
  "localId": [
    string
  ],
  "email": [
    string
  ],
  "delegatedProjectNumber": string,
  "phoneNumber": [
    string
  ],
  "federatedUserId": [
    {
      object (FederatedUserIdentifier)
    }
  ],
  "initialEmail": [
    string
  ]
}
字段
idToken

string

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

localId[]

string

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

email[]

string

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

delegatedProjectNumber
(deprecated)

string (int64 format)

phoneNumber[]

string

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

federatedUserId[]

object (FederatedUserIdentifier)

initialEmail[]

string

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

响应正文

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

授权范围

需要以下 OAuth 范围之一:

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

如需了解详情,请参阅 Authentication Overview