Use this API to get the information of a role.

Resource Information

Method

URL

Required authentication

Get

/V1/CMDB/Roles

Yes

Parameters

Name

Description

Token*required
(header)

Place the token received from the API Log in to get an authentication token.

roleName
(query)

The name of the role. If null, return the information of all roles.

Response

Parameter

Type

Description

Example

roleData

List

A list of role information. It contains the following parameters:

▪roleName (string): the name of a role.

▪description (string): the description of a role.

▪privileges (list): the privileges of a role.

{
  "statusCode": 790200,
  "statusDescription": "success",
  "RoleData": [
    {
      'roleName': "networkChangeApprover",
      'newRoleName': None,
      'description': ''Network Change Approver',
      'privileges': None
    }
  ]
}

statusCode

integer

The returned status code of executing the API.

statusDescription

string

The explanation of the status code.