Method: projects.tenants.accounts.query

Mencari akun pengguna dalam project atau tenant berdasarkan kondisi dalam permintaan.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
targetProjectId

string

ID project yang menjadi cakupan hasil.

Otorisasi memerlukan izin IAM berikut pada resource targetProjectId yang ditentukan:

  • firebaseauth.users.get
tenantId

string

ID tenant yang menjadi cakupan hasil.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "returnUserInfo": boolean,
  "limit": string,
  "offset": string,
  "sortBy": enum (SortByField),
  "order": enum (Order),
  "expression": [
    {
      object (SqlExpression)
    }
  ]
}
Kolom
returnUserInfo

boolean

Jika true, permintaan ini akan menampilkan akun yang cocok dengan kueri. Jika false, hanya jumlah akun yang cocok dengan kueri yang akan ditampilkan. Setelan defaultnya adalah true.
limit

string (int64 format)

Jumlah maksimum akun yang akan ditampilkan dengan batas atas 500. Setelan defaultnya adalah 500. Hanya valid jika returnUserInfo ditetapkan ke true.
offset

string (int64 format)

Jumlah akun yang akan dilewati dari awal data yang cocok. Hanya valid jika returnUserInfo ditetapkan ke true.
sortBy

enum (SortByField)
order

enum (Order)
expression[]

object (SqlExpression)

Isi respons

Jika berhasil, isi respons akan berisi instance QueryUserInfoResponse.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.