Modify a group
Use PATCH /v2/accounts/{account-uuid}/groups/{group-uuid} to update a user group.
Endpoint
/v2/accounts/{account-uuid}/groups/{group-uuid}
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| account-uuid | string | - | path | required |
| group-uuid | string | - | path | required |
| body | Rest | - | body | optional |
Request body objects
The RestModifyGroupForm object
| Element | Type | Description | Required |
|---|---|---|---|
| name | string | - | optional |
| description | string | - | optional |
| federatedAttributeValues | string[] | - | optional |
Request body JSON model
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{
"name": "string",
"description": "string",
"federatedAttributeValues": [
"string"
]
}Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | - | Account group modified correctly |
| 400 | ExceptionMessage | Invalid account or group uuid parameter |
| 404 | ExceptionMessage | Account group to be changed can not be found |