GET /roleGroups
Use this method to return information about all role groups.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/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 | Array of objects | Each array element represents a role group | ||
| description | String | Description for the role group | ||
| id | String | ID 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 of strings | List of user IDs that are a members of the role group | ||
| 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 | Object | 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.
{
"result": "success",
"response": [{
"description": "Operating System Administrator Group",
"id": "10ad2fce-4003-46ae-a097-24d786efdada",
"name": "LXC-OS-ADMIN",
"reserved": false,
"roles": ["lxc-os-admin"],
"users": []
},
{
"description": "Reserved SYSMGR group",
"id": "21651293-69db-43f0-8d16-e10bc0173419",
"name": "LXC-SYSMGR",
"reserved": true,
"roles": ["lxc-sysmgr"],
"users": ["SYSMGR_K5YIQSFY"]
},
{
"description": "Management Server Administrator Group",
"id": "9e18eb00-df77-4032-886e-d77ebf5ba996",
"name": "LXC-ADMIN",
"reserved": false,
"roles": ["lxc-admin"],
"users": []
},
{
"reserved": false,
"description": "Firmware Administrator Group",
"name": "LXC-FW-ADMIN",
"id": "48c5134b-51b1-4ebc-b3ac-3f8ebd71029e",
"roles": ["lxc-fw-admin"],
"users": []
},
{
"description": "Managed Server and Flex Chassis Administrator Group",
"id": "1b029de2-302b-4d15-9804-ba680c1a5c21",
"name": "LXC-HW-ADMIN",
"reserved": false,
"roles": ["lxc-hw-admin"],
"users": []
},
{
"description": "Server and Flex Chassis Discovery and Manage Group",
"id": "eb6bff01-8858-4738-976d-92f4da15fff8",
"name": "LXC-HW-MANAGER",
"reserved": false,
"roles": ["lxc-hw-manager"],
"users": []
},
{
"description": "Operator group",
"id": "be79098d-707e-4338-b9d3-fd658c154ec5",
"name": "LXC-OPERATOR",
"reserved": false,
"roles": ["lxc-operator"],
"users": []
},
{
"description": "Local User Recovery Group",
"id": "cc3ec604-e5dc-42c8-8649-1673c9240a3b",
"name": "LXC-RECOVERY",
"reserved": false,
"roles": ["lxc-recovery"],
"users": []
},
{
"description": "Security Administrator Group",
"id": "3667eb91-5101-4fce-9957-3482510f4b47",
"name": "LXC-SECURITY-ADMIN",
"reserved": false,
"roles": ["lxc-security-admin"],
"users": []
},
{
"description": "service administrator Group",
"id": "33516e73-992c-4c14-a531-4db9e52bbd62",
"name": "LXC-SERVICE-ADMIN",
"reserved": false,
"roles": ["lxc-service-admin"],
"users": []
},
{
"description": "Supervisor group",
"id": "ea967b76-f604-4759-a7f6-8a303ee3de58",
"name": "LXC-SUPERVISOR",
"reserved": false,
"roles": ["lxc-supervisor"],
"users": ["ADMIN"]
},
{
"description": "Reserved SYSRDR group",
"id": "42c85103-a6a6-4664-9840-66ae86b83e06",
"name": "LXC-SYSRDR",
"reserved": true,
"roles": ["lxc-sysrdr"],
"users": ["SYSRDR_NUDCMYXX"]
}],
"messages": [{
"id": "FQXHMSE0001I",
"text": "The request completed successfully.",
"recovery": {
"text": "Information only. No action is required.",
"URL": ""
},
"explanation": ""
}]
}
Give documentation feedback