GET /privilegeCategories
Use this method to return information about all privilege categories.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/privilegeCategories
Query parameters
None
Request body
None
Response codes
Code | Description | Comments |
---|---|---|
200 | OK | The request completed successfully. |
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 of objects | Information about each privilege category | |||
description | String | Category description | |||
id | String | Category ID | |||
privileges | Array of objects | Information about the privileges that are assigned to the category | |||
description | String | Privilege description | |||
id | String | Privilege ID | |||
name | String | Privilege name | |||
result | String | Result of the request . This can be one of the following values.
| |||
messages | Array of objects | 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 of objects | 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": "Default",
"id": 502,
"privileges": [{
"description": "Administrator All",
"id": "224",
"name": "lxc-admin-all"
},
...,
{
"description": "Hardware Admin All",
"id": "164",
"name": "lxc-hw-admin-all"
}]
},
...,
{
"description": "Security",
"id": 504,
"privileges": [{
"description": "Regenerate server certificate",
"id": "128",
"name": "lxc-sec-regenerate-server-certificate"
},
...,
{
"description": "Upload server certificate",
"id": "127",
"name": "lxc-sec-upload-server-certificate"
}]
}],
"result": "success",
"messages": [{
"id": "FQXHMSE0001I",
"text": "The request completed successfully.",
"recovery": {
"text": "Information only. No action is required.",
"URL": ""
},
"explanation": ""
}]
}
Give documentation feedback