Method: projects.locations.tenants.list

Retrieve a collection of tenants.

HTTP request

GET https://saasservicemgmt.googleapis.com/v1beta1/{parent=projects/*/locations/*}/tenants

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent of the tenant.

Query parameters

Parameters
pageSize

integer

The maximum number of tenants to send per page.
pageToken

string

The page token: If the nextPageToken from a previous response is provided, this request will send the subsequent page.
filter

string

Filter the list as specified in https://google.aip.dev/160.
orderBy

string

Order results as specified in https://google.aip.dev/132.

Request body

The request body must be empty.

Response body

The response structure for the tenants.list method.

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

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

object (Tenant)

The resulting tenants.
nextPageToken

string

If present, the next page token can be provided to a subsequent tenants.list call to list the next page. If empty, there are no more pages.
unreachable[]

string

Locations that could not be reached.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.