Skip to main content

GET /roles

Use GET to retrieve information about all custom and predefined roles.

Authentication

Authentication with username and password is required.

Request URL

GET https://{management_server_IP}/roles

Query parameters

None

Response codes

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body

AttributesTypeDescription
responseArrayEach array element represents a user role
 descriptionStringRole description
 idIntegerRole ID
 nameStringName of the role. To obtain a list of all predefined and custom role names, use the GET /roles method.

For information about the predefined and reserved roles, see Creating a custom role.

 privilegesArray of stringsList of URIs that identify the IDs of privileges that are associated with the role (for example, /privileges/3). To obtain a list of all privileges, use the GET /privileges method.
 reservedBooleanIndicates if the role is reserved and cannot be used to create new role groups or assigned to new users. This can be one of the following values.
  • true. The user role is reserved for use by the XClarity Administrator.
  • false. The user role is not reserved.
resultStringResult of the request . This can be one of the following values.
  • success. The request completed successfully.
  • failure. The request failed. A descriptive error message was returned.
messagesArrayInformation about one or more messages
 explanationStringAdditional information to clarify the reason for the message
 idStringMessage identifier of a returned message
 recoveryArrayRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
 textStringMessage text associated with the message identifier
The following example is returned if the request is successful.
{
"response": [{
"description": "Operator",
"id": "702",
"name": "lxc-operator",
"privileges": ["/privileges/266","/privileges/203","/privileges/204","/privileges/205",
"/privileges/208","/privileges/210","/privileges/213","/privileges/217",
"/privileges/220","/privileges/222","/privileges/223","/privileges/160",
"/privileges/224","/privileges/225","/privileges/226","/privileges/227",
"/privileges/229","/privileges/234","/privileges/235","/privileges/363",
"/privileges/236","/privileges/364","/privileges/365","/privileges/110",
"/privileges/366","/privileges/111","/privileges/367","/privileges/368",
"/privileges/113","/privileges/369","/privileges/371","/privileges/117",
"/privileges/118"],
"reserved": false
},
...,
{
"description": "lxc-sysrdr",
"id": "714",
"name": "lxc-sysrdr",
"privileges": ["/privileges/109"],
"reserved": true
}],
"result": "success",
"messages": [{
"id": "FQXHMSE0001I",
"text": "The request completed successfully.",
"recovery": {
"text": "Information only. No action is required.",
"URL": ""
},
"explanation": ""
}]
}