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

Path parameters

groupIdstringRequired

URL-Safe encoded Group ID

userIdinteger · int64Required

Header parameters

sessionTokenstringRequired

Session authentication token.

Body

application/json

Body for user group membership creation

activebooleanOptional

Responses

200

Success

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. See response body for further details.

application/json

500

Server error, see response body for further details.

application/json

put

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

HTTPcURLJavaScriptPython

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

{
  "active": true
}

{
  "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
}

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