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
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 400 | Bad Request | A 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. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response 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.
| ||
| result | String | Result of the request . This can be one of the following values.
| ||
| 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 | ||
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": ""
}]
}
Give documentation feedback