Method: projects.accounts.query

根据请求中的条件在项目或租户中查找用户账号。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
targetProjectId

string

结果所属的项目的 ID。

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

  • firebaseauth.users.get

请求正文

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

JSON 表示法 
{
  "returnUserInfo": boolean,
  "limit": string,
  "offset": string,
  "sortBy": enum (SortByField),
  "order": enum (Order),
  "tenantId": string,
  "expression": [
    {
      object (SqlExpression)
    }
  ]
}
字段
returnUserInfo

boolean

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

string (int64 format)

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

string (int64 format)

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

enum (SortByField)
order

enum (Order)
tenantId

string

结果所属租户的 ID。
expression[]

object (SqlExpression)

响应正文

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

授权范围

需要以下 OAuth 范围之一：

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

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