Method: projects.tenants.accounts.batchGet

Download account information for all accounts on the project in a paginated manner. To use this method requires a Google OAuth 2.0 credential with proper permissions.. Furthermore, additional permissions are needed to get password hash, password salt, and password version from accounts; otherwise these fields are redacted.

HTTP request

GET https://identitytoolkit.googleapis.com/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchGet

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
targetProjectId

string

If tenantId is specified, the ID of the Google Cloud project that the Identity Platform tenant belongs to. Otherwise, the ID of the Google Cloud project that the accounts belong to.

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

  • firebaseauth.users.get
tenantId

string

The ID of the Identity Platform tenant the accounts belongs to. If not specified, accounts on the Identity Platform project are returned.

Query parameters

Parameters
nextPageToken

string

The pagination token from the response of a previous request.

maxResults

integer

The maximum number of results to return. Must be at least 1 and no greater than 1000. By default, it is 20.

Request body

The request body must be empty.

Response body

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

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.