Method: projects.tenants.accounts.query

Sucht anhand der Bedingungen in der Anfrage nach Nutzerkonten in einem Projekt oder Mandanten.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
targetProjectId

string

Die ID des Projekts, auf das sich das Ergebnis bezieht.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource targetProjectId erforderlich:

  • firebaseauth.users.get
tenantId

string

Die ID des Mandanten, auf den das Ergebnis beschränkt ist.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

boolean

Wenn true, werden mit dieser Anfrage die Konten zurückgegeben, die der Abfrage entsprechen. Bei false wird nur die Anzahl der Konten zurückgegeben, die mit der Abfrage übereinstimmen. Die Standardeinstellung ist true.
limit

string (int64 format)

Die maximale Anzahl der Konten, die zurückgegeben werden sollen. Die Obergrenze beträgt 500. Der Standardwert ist 500. Nur gültig, wenn returnUserInfo auf true festgelegt ist.
offset

string (int64 format)

Die Anzahl der Konten, die am Anfang der übereinstimmenden Einträge übersprungen werden sollen. Nur gültig, wenn returnUserInfo auf true festgelegt ist.
sortBy

enum (SortByField)
order

enum (Order)
expression[]

object (SqlExpression)

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von QueryUserInfoResponse.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.