Get all accessible tenants

This function returns a list of accessible tenants (including tenant ID and names). The returned tenant list varies by the user privileges you use to log in. To retrieve a full list of all available tenants, you must log in with admin permissions.

Resource Information

Method

URL

Required authentication

GET

/V1/CMDB/Tenants

Yes

Parameters

Name

Description

Token*required
(header)

The token can be obtained by sending a POST request to the log in session endpoint and provide valid credentials.

Example:

{
  "token": "301ebdd8-0045-429d-8807-c51b8db7f5f0"
}

Response

Parameter

Type

Description

Example

tenants

array

A list of all accessible tenants.

{
  "tenants": [
    {
      "tenantId": "3e75247a-309c-4231-96a5-823b6cb1e78d",
      "tenantName": "bos_office"
    },
    {
      "tenantId": "5a75247a-309c-4231-96a5-823b6cb1e78d",
      "tenantName": "ny_office"
    }
  ]
}

tenantId

string

The tenant ID.

tenantName

string

The tenant name.

statusCode

integer

Code issued by NetBrain server indicating the execution result.

statusDescription

string

The explanation of the status code.