Get all accessible domains of a tenant

This function returns a list of accessible domains in a specific tenant. The returned accessible domains vary by the user privileges you use to log in. To retrieve a full list of domains in a specified tenant, you must log in with system admin or tenant admin permissions.

Resource Information

Method

URL

Required authentication

GET

/V1/CMDB/Domains

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.

tenantId
(query)

Unique identifier for the tenant from which you desire to retrieve the domain information. tenantId can be retrieved from get all accessible tenants.

Response

Parameter

Type

Description

Example

domains

array

A list of all accessible domains.

{
  "domains": [
    {
      "domainId": "4e75247a-309c-4231-96a5-823b6cb1e78d",
      "domainName": "domain1"
    },
    {
      "domainId": "5e75247a-309c-4231-96a5-823b6cb1e78d",
      "domainName": "domain2"
    }
  ]
}

domainId

string

The domain ID.

domainName

string

The domain name.

statusCode

integer

Code issued by NetBrain server indicating the execution result.

statusDescription

string

The explanation of the status code.