Method: instances.getMultitenantDirectory

Full name: projects.locations.instances.getMultitenantDirectory

Gets the super and subtenants and gets the current tenant name.

HTTP request

GET https://chronicle.googleapis.com/v1alpha/{name}

Path parameters

Parameters
name

string

Required. The name of the directory to retrieve. Format: projects/{project_id}/locations/{region}/instances/{instance}/multitenantDirectory

Request body

The request body must be empty.

Response body

Represents Chronicle tenant information for all tenants in the same deployment.

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

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

string

Output only. The resource name. Format: projects/{project_id}/locations/{region}/instances/{instance}/multitenantDirectory
tenants[]

object (Tenant)

A list of tenants in the same multitenant deployment. This includes the active deployment, or the Chronicle instance to which the API call was made. Lists longer than 100 should not exist and will be truncated.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.multitenantDirectories.get

For more information, see the IAM documentation.

Tenant

Contains display information about a Tenant and a URL to enable tenant switching.

JSON representation 
{
  "type": enum (Type),
  "display_name": string,
  "frontend_hostname": string,
  "chronicle_instance": string
}
Fields
type

enum (Type)

Output only. The type of the tenant.
display_name

string

Output only. User visible name for the tenant.
frontend_hostname

string

Output only. URL to redirect to when switching tenants.
chronicle_instance

string

Output only. Resource Name pointing to the Chronicle resource Format: projects/{project}/locations/{region}/instances/{instance}

Type

The tenant type.

Enums
TYPE_UNSPECIFIED Default value. This value is unused.
SUPERTENANT A supertenant
SUBTENANT A subtenant