HTTP - Management
Removed from your favourites
Update a group
Created by c.neale, last modified by zengenti on 17 Jun 2022
Updating a group can be done by PUT'ing group details resource to the group resource location.
PUT/api/security/groups/{groupIdentifier}
Parameter
| Name | Parameter type | Type | Format | Description | Example | Required |
|---|---|---|---|---|---|---|
| groupIdentifier | path | string | group identifier | For convenience, Group resources can be referenced by using either the group name or id | "Paper Street Soap Company" or "82f73a9b-2a13-4d63-bcc1-e8ee5047b01c" | true |
Examples
Update a group
JSON
PUT: /api/security/groups/cd7b3be9-c45a-4a35-b359-f978f9dbeb9a
{
"name": "Paper Street Soap Company",
"Description": "Employees of the Paper Street Soap Company",
"type": "contensis",
"custom" : {
"clientId": "PSSC"
}
}HTTP
PUT: /api/security/groups/Paper%20Street%20Soap%20Company
{
"name": "Paper Street Soap Company",
"Description": "Employees of the Paper Street Soap Company",
"type": "contensis",
"custom" : {
"clientId": "PSSC"
}
}Remarks
Permissions
Member of System Administrators.