Method: projects.tenants.accounts.query

Busca cuentas de usuario dentro de un proyecto o un grupo de usuarios según las condiciones de la solicitud.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
targetProjectId

string

Es el ID del proyecto al que se aplica el resultado.

La autorización requiere el siguiente permiso IAM en el recurso especificado targetProjectId:

  • firebaseauth.users.get
tenantId

string

Es el ID del grupo de usuarios al que se aplica el resultado.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "returnUserInfo": boolean,
  "limit": string,
  "offset": string,
  "sortBy": enum (SortByField),
  "order": enum (Order),
  "expression": [
    {
      object (SqlExpression)
    }
  ]
}
Campos
returnUserInfo

boolean

Si es true, esta solicitud mostrará las cuentas que coincidan con la consulta. Si es false, solo se mostrará el registro de las cuentas que coincidan con la consulta. La configuración predeterminada es true.
limit

string (int64 format)

Es la cantidad máxima de cuentas que se mostrarán, con un límite superior de 500. El valor predeterminado es 500. Solo es válido cuando returnUserInfo se establece en true.
offset

string (int64 format)

Es la cantidad de cuentas que se omitirán desde el comienzo de los registros coincidentes. Solo es válido cuando returnUserInfo se establece en true.
sortBy

enum (SortByField)
order

enum (Order)
expression[]

object (SqlExpression)

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de QueryUserInfoResponse.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.