PUT /roleGroups/{id}
Use this method to modify a specific role group.
Authentication
Authentication with username and password is required.
Request URL
PUT https://{management_server_IP}/roleGroups/{id}
where {id} is the ID of the role group. To obtain role group ID, use GET /roleGroups.
Query parameters
None
Request body
| Attributes | Required / Optional | Type | Description |
|---|---|---|---|
| description | Optional | String | Description of the role group |
| name | Optional | String | Name of the role group |
| roles | Required | Array of strings | List of the roles that are included in the role group. 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. |
| users | Optional | Array of strings | List of user IDs that are a members of the role group |
The following example modifies a specific role group.
{
"name": "test-group",
"description": "description",
"roles": ["lxc-hw-admin", "lxc-fw-admin"],
"users": ["USER1", "USER2", "USER3"]
}
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 | ||
|---|---|---|---|---|
| result | String | Results of the request. This can be one of the following values.
| ||
| messages | Array of objects | Information about one or more messages | ||
| id | String | Message identifier of a returned message | ||
| text | String | Message text associated with the message identifier | ||
| explanation | String | Additional information to clarify the reason for the 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 | ||
The following example is returned if the request is successful.
{
"result": "success",
"messages": [{
"explanation": "",
"id": "FQXHMSE0001I",
"recovery": {
"text": "Information only; no action is required.",
"URL": ""
},
"text": "The request completed successfully."
}]
}
Give documentation feedback