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

PUTyourpodURL.symphony.com/pod/v2/admin/usergroups/{groupId}/assignments/{userId}

Path parameters

groupId*string

URL-Safe encoded Group ID

userId*integer (int64)

Session authentication token.

Header parameters

Body

application/json

activeboolean

Group membership status

Response

200201400401403404500

Group assigned successfully.

Body

application/json

idstring

Assignment ID

groupIdstring

Group ID

groupGroupRoleScope (object)

User Group info to include in other models

userIdinteger (int64)

User ID

userUserCompp (object)

Basic user information to include in other models

userRolesarray of string

activeboolean

Group membership status

lastAddedDateinteger (int64)

Date of group membership last added

lastRemovedDateinteger (int64)

Date of group membership last removed

Request

JavaScriptCurlPython

const response = await fetch('yourpodURL.symphony.com/pod/v2/admin/usergroups/{groupId}/assignments/{userId}', {
    method: 'PUT',
    headers: {
      "sessionToken": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200201400401403404500

{
  "id": "text",
  "groupId": "text",
  "group": {
    "id": "text",
    "name": "text",
    "area": "text",
    "type": "text",
    "active": false
  },
  "user": {
    "id": 7215545058329,
    "username": "dpayet",
    "firstName": "Dimitri",
    "lastName": "Payet",
    "emailAddress": "[e-mail]"
  },
  "userRoles": [
    "text"
  ],
  "active": false
}

🚧 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.