Method: projects.tenants.accounts.query

リクエストの条件に基づいて、プロジェクトまたはテナント内のユーザー アカウントを検索します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 をご覧ください。