Skip to main content

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

CodeDescriptionComments
200OKThe request completed successfully.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body

AttributesTypeDescription
responseArray of objectsInformation about each privilege category
 descriptionStringCategory description
 idStringCategory ID
 privilegesArray of objectsInformation about the privileges that are assigned to the category
  descriptionStringPrivilege description
  idStringPrivilege ID
  nameStringPrivilege name
resultStringResult of the request . This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messagesArray of objectsInformation about one or more messages
 explanationStringAdditional information to clarify the reason for the message
 idStringMessage identifier of a returned message
 recoveryArray of objectsRecovery 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": "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": ""
}]
}