GET /roles

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


Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/roles

Query parameters


Response codes

Code Description
200 OK. The request completed successfully.
400 Bad request. An argument is missing or not valid. a descriptive error message will be returned in the body.
500 Internal server error. A descriptive error message will be returned in the body.

Response body

Attributes Type Description
response Array Each array element represents a user role
  description String Role description
  id Integer Role ID
  name String Name 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.

  privileges Array of strings List 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.
  reserved Boolean Indicates 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.
result String Result 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.
messages Array Information about one or more messages
  explanation String Additional information to clarify the reason for the message
  id String Message identifier of a returned message
  recovery Array Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available
  text String Message text associated with the message identifier

Response example

   "response": [{
      "description": "Operator",
      "id": "702",
      "name": "lxc-operator",
      "privileges": ["/privileges/266","/privileges/203","/privileges/204","/privileges/205",
      "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": ""