Remove IB Group Members

Remove members from an Information Barrier group.

Remove members from an Information Barrier group

post

/v1/admin/group/{gid}/membership/remove

Path parameters

gidstringrequired

URL-Safe encoded Group ID

Header parameters

sessionTokenstringrequired

Session authentication token.

Body

itemsinteger · int64

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'yourpodURL.symphony.com/pod/v1/admin/group/{gid}/membership/remove' \
  --header 'sessionToken: text' \
  --header 'Content-Type: application/json' \
  --data '[1461508270000,7215545057281]'

200

400

401

403

500

200

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

Success

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.