Update a Compliance Group

Assigns or updates the assignment of a user to a compliance group. Released in 1.55.3

Assign a group to the user

put

Path parameters

groupIdstringRequired

URL-Safe encoded Group ID

userIdinteger · int64Required

Session authentication token.

Header parameters

sessionTokenstringRequired

Session authentication token.

Body

application/json

User Group membership update object

activebooleanOptional

Group membership status

Responses

200

Group assigned successfully.

application/json

User Group assignment response object

idstringOptional

Assignment ID

groupIdstringOptional

Group ID

userIdinteger · int64Optional

User ID

userRolesstring[]Optional

activebooleanOptional

Group membership status

lastAddedDateinteger · int64Optional

Date of group membership last added

lastRemovedDateinteger · int64Optional

Date of group membership last removed

201

User Group assignment response object.

application/json

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: Either the group or the user cannot be found.

application/json

500

Server error, see response body for further details.

application/json

put

/v2/admin/usergroups/{groupId}/assignments/{userId}

HTTPcURLJavaScriptPython

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

{
  "active": true
}

{
  "id": "text",
  "groupId": "text",
  "group": {
    "id": "text",
    "name": "text",
    "area": "text",
    "type": "text",
    "active": true
  },
  "userId": 1,
  "user": {
    "id": 7215545058329,
    "username": "dpayet",
    "firstName": "Dimitri",
    "lastName": "Payet",
    "emailAddress": "[email protected]"
  },
  "userRoles": [
    "text"
  ],
  "active": true,
  "lastAddedDate": 1,
  "lastRemovedDate": 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.