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.

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

Path parameters

groupId*string

URL-Safe encoded Group ID

userId*integer (int64)

Header parameters

Body

application/json

activeboolean

Response

200400401403404500

Success

Body

application/json

idstring

groupIdstring

userIdinteger (int64)

groupUserGroupData (object)

Group object response

userMembershipData (object)

User object response

activeboolean

lastAddedDateinteger (int64)

lastRemovedDateinteger (int64)

Request

JavaScriptCurlPython

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

Response

200400401403404500

{
  "id": "text",
  "groupId": "text",
  "group": {
    "id": "text",
    "name": "text",
    "area": "text",
    "type": "text",
    "active": false
  },
  "user": {
    "userName": "text",
    "firstName": "text",
    "lastName": "text",
    "emailAddress": "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.