GET /privileges

Use this method to return information about all user privileges.

Note: This API requires Lenovo XClarity Administrator v2.4.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/privileges

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.
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 user privilege
  category Object Category to which the privilege belongs
    description String Category description
    id String Category ID
  description String Privilege description
  id String Privilege ID
  managementModulePermission Long (Management-module permissions only) LDAP permission bits (bitstrings) that are associated with the privilege.

For information about the LDAP permission bits for each management module, see the online documentation.

  name String Privilege name
result String Result 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.
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": [{
      "category": {
         "description": "Default",
         "id": "502"
      },
      "description": "Access All Resources",
      "id": "65",
      "name": "lxc-access-all-resources"
   },
   ...,
   {
      "category": {
         "description": "Task Management",
         "id": "521"
      },
      "description": "Run jobs",
      "id": "455",
      "name": "lxc-tasks-run-jobs"
   }],
   "result": "success",
   "messages": [{
      "explanation": "",
      "id": "FQXHMSE0001I",
      "recovery": {
         "text": "Information only. No action is required.",
         "URL": ""
      },
      "text": "The request completed successfully."
   }]
}