Method: projects.tenants.list

List tenants under the given agent project. Requires read permission on the Agent project.

HTTP request

GET https://identitytoolkit.googleapis.com/v2/{parent=projects/*}/tenants

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource name to list tenants for.

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

  • identitytoolkit.tenants.list

Query parameters

Parameters
pageToken

string

The pagination token from the response of a previous request.

pageSize

integer

The maximum number of results to return, capped at 1000. If not specified, the default value is 20.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for tenants.list.

JSON representation
{
  "tenants": [
    {
      object (Tenant)
    }
  ],
  "nextPageToken": string
}
Fields
tenants[]

object (Tenant)

A list of tenants under the given agent project.

nextPageToken

string

The token to get the next page of results.

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.