Method: projects.tenants.accounts.query

Recherche des comptes utilisateur dans un projet ou un locataire en fonction des conditions de la requête.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
targetProjectId

string

ID du projet auquel le résultat est appliqué.

L'autorisation IAM suivante est requise pour la ressource targetProjectId indiquée :

  • firebaseauth.users.get
tenantId

string

ID du locataire auquel le résultat est limité.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "returnUserInfo": boolean,
  "limit": string,
  "offset": string,
  "sortBy": enum (SortByField),
  "order": enum (Order),
  "expression": [
    {
      object (SqlExpression)
    }
  ]
}
Champs
returnUserInfo

boolean

Si la valeur est true, cette requête renvoie les comptes correspondant à la requête. Si la valeur est false, seul le nombre de comptes correspondant à la requête est renvoyé. La valeur par défaut est true.
limit

string (int64 format)

Nombre maximal de comptes à renvoyer, limité à 500. La valeur par défaut est 500. Valable uniquement lorsque la valeur de returnUserInfo est définie sur true.
offset

string (int64 format)

Nombre de comptes à ignorer au début des enregistrements correspondants. Valable uniquement lorsque la valeur de returnUserInfo est définie sur true.
sortBy

enum (SortByField)
order

enum (Order)
expression[]

object (SqlExpression)

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de QueryUserInfoResponse.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez Authentication Overview.