Update a User Membership

Add or update a user's membership within a compliance group. Released in 1.55.3

Add member to a Group if it does not exist, otherwise update it.

put

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

Path parameters

groupIdstringrequired

URL-Safe encoded Group ID

userIdinteger · int64required

Header parameters

sessionTokenstringrequired

Session authentication token.

Body

activeboolean

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'yourpodURL.symphony.com/pod/v2/admin/usergroups/{groupId}/memberships/{userId}' \
  --header 'sessionToken: text' \
  --header 'Content-Type: application/json'

200

400

401

403

404

500

200

{
  "id": "text",
  "groupId": "text",
  "userId": 1,
  "group": {
    "id": "text",
    "name": "text",
    "area": "text",
    "type": "text",
    "active": true
  },
  "user": {
    "id": 1,
    "userName": "text",
    "firstName": "text",
    "lastName": "text",
    "emailAddress": "text"
  },
  "active": true,
  "lastAddedDate": 1,
  "lastRemovedDate": 1
}

Success

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