GET /roleGroups/{name}
Use this method to return information about a specific role group.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/roleGroups/{name}
where <name} is the name of the role group. To obtain role group name, use GET /roleGroups.
Query parameters
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 | Object | Each array element represents a role group | ||
| description | String | Description for the role group | ||
| id | String | System-assigned identifier for the role group | ||
| name | String | Name of the role group | ||
| reserved | Boolean | Indicates if the role group is reserved and cannot be modified. This can be one of the following values.
| ||
| roles | 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 | Array | List of all user IDs that are members of the role group | ||
| result | String | Result of the request. This can be one of the following values.
| ||
| 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 | ||
The following example is returned if the request is successful.
{
"response": {
"description": "Operator group",
"id": "896726ab-6b96-4d50-8678-e97a9059a784",
"name": "LXC-OPERATOR",
"reserved": false,
"roles": ["lxc-operator"],
"users": []
},
"result": "success",
"messages": [{
"explanation": "",
"id": "FQXHMSE0001I",
"recovery": {
"text": "Information only; no action is required.",
"URL": ""
},
"text": "The request completed successfully."
}]
}
Give documentation feedback