Update a Compliance User Group

Updates a compliance user group information. Released in 1.55.3

Update user group informations

put

Path parameters

groupIdstringRequired

Header parameters

sessionTokenstringRequired

Session authentication token.

Body

application/json

Body for group update

namestringOptional

Group name

areastringOptional

Group area

descriptionstringOptional

Group description

activebooleanOptional

Group status

Responses

200

Success

application/json

Group object response

idstringOptional

Group ID

namestringOptional

Group name

areastringOptional

An optional string attribute used for categorizing groups

descriptionstringOptional

Group description

typestringOptional

Group type

activebooleanOptional

Group status

createdDateinteger · int64Optional

Date of group creation

modifiedDateinteger · int64Optional

Date of group last update

memberCountinteger · int64Optional

Number of group members

assigneeCountinteger · int64Optional

Number of group assignees

400

Client error, see response body for further details.

application/json

401

Unauthorized: Session tokens invalid.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

404

Not found. See response body for further details.

application/json

422

Unprocessable Entity: Error on updating user group.

application/json

500

Server error, see response body for further details.

application/json

put

/v2/admin/usergroups/{groupId}

HTTPcURLJavaScriptPython

PUT /pod/v2/admin/usergroups/{groupId} HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "name": "text",
  "area": "text",
  "description": "text",
  "active": true
}

{
  "id": "text",
  "name": "text",
  "area": "text",
  "description": "text",
  "type": "text",
  "active": true,
  "createdDate": 1,
  "modifiedDate": 1,
  "memberCount": 1,
  "assigneeCount": 1
}

🚧 Roles and Privileges

Calling this endpoint requires the Scope Management role with the MANAGE_ROLE_SCOPES entitleable action. See Bot Permissions for a list of roles and associated privileges.