Summary
Update a group.
Description
Update a group
Route
PATCH /authorization/groups/:groupId
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| groupId |
string |
yes |
The individual group to update. |
| updates |
object |
yes |
An object containing the requested updates |
Copied to Clipboard
{
"updates": {
"description": "description of group_1",
"inactive": true,
"memberOf": [
{
"aaaManaged": false,
"groupId": "5cb7b531d06cceb89fd21b1c"
},
{
"aaaManaged": true,
"groupId": "5cb7b531d06cceb89fd21b1c"
}
],
"assignedRoles": [
{
"roleId": "5cb7b531d06cceb89fd21b1c"
},
{
"roleId": "5cb7b531d06cceb89fd21b1c"
},
{
"roleId": "5cb7b531d06cceb89fd21b1c"
},
{
"roleId": "5cb7b531d06cceb89fd21b1c"
},
{
"roleId": "5cb7b531d06cceb89fd21b1c"
}
]
}
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
The output of the group update. |
Copied to Clipboard
{
"status": "OK",
"message": "A sample success message",
"data": {
"provenance": "Pronghorn",
"name": "group_1",
"description": "description of group_1",
"memberOf": [
{
"aaaManaged": true,
"groupId": "5cb7b531d06cceb89fd21b1c"
},
{
"aaaManaged": false,
"groupId": "5cb7b531d06cceb89fd21b1c"
}
],
"assignedRoles": [
{
"roleId": "5cb7b531d06cceb89fd21b1c"
},
{
"roleId": "5cb7b531d06cceb89fd21b1c"
}
],
"inactive": false,
"_meta": {
"created": "2018-08-02T15:56:12.912Z",
"updated": "2018-08-02T15:56:12.912Z"
}
}
}
