GET /privilegeCategories/{ID}
Use this method to return information about a specific privilege category.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/privilegeCategories/{ID}
where {id} is the ID of the category to be retrieved. To obtain the category IDs, use GET /privilegeCategories.
Query parameters
None
Request body
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. |
| 401 | Unauthorized | The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body. |
| 403 | Forbidden | The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request. |
| 404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
| 409 | Conflict | There is a conflict with the current state of the resource. 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 | Object | 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": "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": [{
"explanation": "",
"id": "FQXHMSE0001I",
"recovery": {
"text": "Information only. No action is required.",
"URL": ""
},
"text": "The request completed successfully."
}]
}
Give documentation feedback