- Home
- Resources
- MgmtRoleConfigGroupsResource
GET /cm/service/roleConfigGroups
Returns the information for all role config groups in
the Cloudera Management Services.
Available since API v3.
Response Body
| media type |
data type |
description |
| application/json |
ApiRoleConfigGroupList
(JSON) |
The list of role config groups for the given service. |
GET /cm/service/roleConfigGroups/{roleConfigGroupName}
Returns the information for a given role config group
in the Cloudera Management Services.
Available since API v3.
Request Parameters
| name |
type |
description |
default |
| roleConfigGroupName |
path |
The name of the requested group. |
n/a |
Response Body
| media type |
data type |
description |
| application/json |
ApiRoleConfigGroup
(JSON) |
The requested role config group. |
PUT /cm/service/roleConfigGroups/{roleConfigGroupName}
Updates an existing role config group in the Cloudera Management Services.
Available since API v3.
Request Parameters
| name |
type |
description |
default |
| roleConfigGroupName |
path |
The name of the group to update. |
n/a |
| message |
query |
The optional message describing the changes. |
n/a |
Request Body
| media type |
data type |
description |
| application/json |
ApiRoleConfigGroup
(JSON) |
The updated role config group. |
Response Body
| media type |
data type |
description |
| application/json |
ApiRoleConfigGroup
(JSON) |
Role updated role config group. |
GET /cm/service/roleConfigGroups/{roleConfigGroupName}/config
Returns the current revision of the config
for the specified role config group in the Cloudera Management Services.
Available since API v3.
Request Parameters
| name |
type |
description |
default |
| roleConfigGroupName |
path |
The name of the role config group. |
n/a |
| view |
query |
The view of the data to materialize,
either "summary" or "full". |
summary |
Response Body
| media type |
data type |
description |
| application/json |
ApiConfigList
(JSON) |
The current configuration of the role config group. |
PUT /cm/service/roleConfigGroups/{roleConfigGroupName}/config
Updates the config for the given role config group
in the Cloudera Management Services.
Available since API v3.
Request Parameters
| name |
type |
description |
default |
| roleConfigGroupName |
path |
The name of the role config group. |
n/a |
| message |
query |
Optional message describing the changes. |
n/a |
Request Body
| media type |
data type |
description |
| application/json |
ApiConfigList
(JSON) |
The new config information for the group. |
Response Body
| media type |
data type |
description |
| application/json |
ApiConfigList
(JSON) |
The updated config of the role config group. |
GET /cm/service/roleConfigGroups/{roleConfigGroupName}/roles
Returns all roles in the given role config group
in the Cloudera Management Services.
Available since API v3.
Request Parameters
| name |
type |
description |
default |
| roleConfigGroupName |
path |
The name of the role config group. |
n/a |
Response Body
| media type |
data type |
description |
| application/json |
ApiRoleList
(JSON) |
The roles in the role config group. |