Method: projects.tenants.accounts.query

Looks up user accounts within a project or a tenant based on conditions in the request.

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

The URL uses gRPC Transcoding syntax.

Parameters

targetProjectId

string

The ID of the project to which the result is scoped.

Authorization requires the following IAM permission on the specified resource targetProjectId :

tenantId

string

The ID of the tenant to which the result is scoped.

The request body contains data with the following structure:

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

Fields
`returnUserInfo`	`boolean` If `true` , this request will return the accounts matching the query. If `false` , only the countof accounts matching the query will be returned. Defaults to `true` .
`limit`	`string ( int64 format)` The maximum number of accounts to return with an upper limit of 500. Defaults to 500 . Only valid when `returnUserInfo` is set to `true` .
`offset`	`string ( int64 format)` The number of accounts to skip from the beginning of matching records. Only valid when `returnUserInfo` is set to `true` .
`sortBy`	`enum ( SortByField )`
`order`	`enum ( Order )`
`expression[]`	`object ( SqlExpression )`

If successful, the response body contains an instance of QueryUserInfoResponse .

Requires one of the following OAuth scopes:

For more information, see the Authentication Overview .