Remove IB Group Members

Remove members from an Information Barrier group.

Remove members from an Information Barrier group

post

Path parameters

gidstringRequired

URL-Safe encoded Group ID

Header parameters

sessionTokenstringRequired

Session authentication token.

Bodyinteger · int64[]

application/json

integer · int64[]OptionalExample: [1461508270000,7215545057281]

Responses

200

Success

application/json

The results of list based bulk action. The list contains the result messages in the same order as submitted. The message will be an empty string if the action was successful for item in that index.

overallResultstring · enumOptionalExample: SUCCESSPossible values:

resultsstring[]OptionalExample: [""]

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

post

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

HTTPcURLJavaScriptPython

POST /pod/v1/admin/group/{gid}/membership/remove HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 29

[
  1461508270000,
  7215545057281
]

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