Skip to main content
Browse Documentation
HTTP - Management

Update a group

Created by c.neale, last modified by s.yearsley on 24 Sep 2020

Updating a group can be done by PUT'ing group details resource to the group resource location.

PUT/api/security/groups/{groupIdentifier}

Parameter

NameParameter typeTypeFormatDescriptionExampleRequired
groupIdentifierpathstringgroup identifierFor 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

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"
    }
}
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"
    }
}

Responses

HTTP status codeReasonModel
403ForbiddenError
404Group not foundError
422Validation errorError
500Internal server errorError