Method: projects.tenants.accounts.query

根據要求中的條件，查詢專案或租用戶中的使用者帳戶。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
targetProjectId

string

結果的專案範圍 ID。

授權需要指定資源 targetProjectId 的下列 IAM 權限：

  • firebaseauth.users.get
tenantId

string

結果的範圍所屬租用戶 ID。

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "returnUserInfo": boolean,
  "limit": string,
  "offset": string,
  "sortBy": enum (SortByField),
  "order": enum (Order),
  "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)
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。