PUT /roles/<ID>

Use this PUT method to modify an existing custom role. You cannot modify a predefined or reserved role

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


Authentication with user name and password is required.

Request URL

PUT https://<management_server_IP>/roles/<ID>

where <ID> is the ID of the role to be retrieved. To obtain the role IDs, use GET /roles.

Query parameters


Request body

Attributes Required / Optional Type Description
description Optional String Role description
id Required String Role ID
existingRole Optional String ID of the existing role on which to base the target role. All privileges in this existing role are added to the target role. To obtain the role ID, use the GET /roles method.
name Required 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 Required 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 Optional 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.
  • true. The user role is reserved.

  • false. (default) The user role is not reserved.

Request example

   "description": "A role that allows a user to…",
   "id": "1102",
   "existingRole": "1002",
   "name": "lxc-admin",
   "privileges": ["/privileges/3", "/privileges/5"],
   "reserved": false

Response codes

Code Description
200 OK. The request completed successfully
400 Bad request. An argument is missing or not valid. A descriptive error message will be returned in the body.
500 Internal server error. A descriptive error message will be returned in the body.

Response body

Attributes Type Description
result String Result of the request . This can be one of the following values.
  • success. The request completed successfully.
  • failure. The request failed. A descriptive error message was returned.
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

Response example

   "result": "success",
   "messages": [{
      "id": "FQXHMSE0001I",
      "text": "The request completed successfully.",
      "recovery": {
         "text": "Information only. No action is required.",
         "URL": ""
      "explanation": ""