Method: projects.tenants.accounts.query

Procura contas de usuário em um projeto ou locatário com base nas condições da solicitação.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
targetProjectId

string

O ID do projeto com o escopo do resultado.

A autorização requer a seguinte permissão do IAM no recurso especificado targetProjectId:

  • firebaseauth.users.get
tenantId

string

O ID do locatário para o qual o resultado é aplicado.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "returnUserInfo": boolean,
  "limit": string,
  "offset": string,
  "sortBy": enum (SortByField),
  "order": enum (Order),
  "expression": [
    {
      object (SqlExpression)
    }
  ]
}
Campos
returnUserInfo

boolean

Se for true, a solicitação vai retornar as contas que correspondem à consulta. Se false, apenas o número de contas que correspondem à consulta será retornado. O padrão é true.
limit

string (int64 format)

O número máximo de contas a serem retornadas com um limite máximo de 500. O padrão é 500. Válido apenas quando returnUserInfo for definido como true.
offset

string (int64 format)

O número de contas a pular desde o início dos registros correspondentes. Válido apenas quando returnUserInfo for definido como true.
sortBy

enum (SortByField)
order

enum (Order)
expression[]

object (SqlExpression)

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de QueryUserInfoResponse.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.