Remove IB Group Members

Remove members from an Information Barrier group.
post
https://yourpodURL.symphony.com/pod
/v1/admin/group/{gid}/membership/remove
Remove members from an Information Barrier group
Parameters
Path
gid*
string
URL-Safe encoded Group ID
Header
sessionToken*
string
Session authentication token.
Body
*
array
Body
Example
Schema
{}
Responses
200: OK
Success
400: Bad Request
Client error, see response body for further details.
401: Unauthorized
Unauthorized: Invalid session token.
403: Forbidden
Forbidden: Caller lacks necessary entitlement.
500: Internal Server Error
Server error, see response body for further details.
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.
Last modified 2mo ago