Looks up user accounts within a project or a tenant based on conditions in the request.
HTTP request
POST https://identitytoolkit.googleapis.com/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:query
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
target |
The ID of the project to which the result is scoped. Authorization requires the following IAM permission on the specified resource
|
tenant |
The ID of the tenant to which the result is scoped. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "returnUserInfo": boolean, "limit": string, "offset": string, "sortBy": enum ( |
Fields | |
---|---|
return |
If |
limit |
The maximum number of accounts to return with an upper limit of 500. Defaults to 500. Only valid when |
offset |
The number of accounts to skip from the beginning of matching records. Only valid when |
sort |
The field to use for sorting user accounts. Defaults to |
order |
The order for sorting query result. Defaults to ascending order. Only valid when |
expression[] |
Query conditions used to filter results. If more than one is passed, only the first SqlExpression is evaluated. |
Response body
If successful, the response body contains an instance of QueryUserInfoResponse
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/identitytoolkit
https://www.googleapis.com/auth/firebase
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.