Remove IB Group Members

Remove members from an Information Barrier group.

Remove members from an Information Barrier group

POSTyourpodURL.symphony.com/pod/v1/admin/group/{gid}/membership/remove

Path parameters

gid*string

URL-Safe encoded Group ID

Header parameters

Body

application/json

itemsinteger (int64)

Response

200400401403500

Success

Body

application/json

overallResultenum

SUCCESSFAIL

resultsarray of string

Request

JavaScriptCurl

const response = await fetch('yourpodURL.symphony.com/pod/v1/admin/group/{gid}/membership/remove', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      1461508270000,
      7215545057281
    ]),
});
const data = await response.json();

Response

{
  "overallResult": "SUCCESS",
  "results": [
    ""
  ]
}

As the example shows, the users to be removed from the Information Barrier group (specified as a list of user IDs) must be included in the data parameter.

❗️ Known Limitation

It is currently not possible to remove a deactivated user from an IB group via the API. Please use the Admin Portal if you wish to do this.

🚧 Roles and Privileges

Calling this endpoint requires the ACCESS_USER_PROVISIONING_API privilege. See Bot Permissions for a list of roles and associated privileges.