Skip to content

Update group

Request

Update a group for your users. Note: Fields that are objects cannot be partially updated, since the new value you set will just replace the current one.

Required permissions: apps:edit, [appId]:edit, groups:edit.

Security
ClientAccessToken
Path
group_idstringrequired

The ID of the group that should be updated

Bodyapplication/jsonrequired
namestring

Name of the group to update

descriptionstring
custom_dataobject

Group custom data object

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/groups/{group_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "custom_data": {}
  }'

Responses

Bodyapplication/json
resultobjectrequired
Response
{
  "result": {
    "group_id": "string",
    "name": "string",
    "description": "string",
    "created_at": 0,
    "updated_at": 0,
    "custom_data": {}
  }
}