Method: tenants.list

Full name: projects.locations.instances.tenants.list

Allow partners to list their tenants.

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{parent}/tenants

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of tenants.

Query parameters

Parameters
pageSize

integer

Optional. Maximum number of tenants to return. Maximum page size - 100. Default page size - 10.
pageToken

string

Optional. A page token, received from a previous tenants.list call. Provide this to retrieve the subsequent page.

Request body

The request body must be empty.

Response body

tenants.list response message.

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

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

object (Tenant)

List of tenants.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.tenants.list

For more information, see the IAM documentation.