Add IB Group Members

Add members to an Information Barrier group.

Add members to 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/add

HTTPcURLJavaScriptPython

POST /pod/v1/admin/group/{gid}/membership/add 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 added to the Information Barrier group (specified as a list of user IDs) must be included in the data parameter.

🚧 Roles and Privileges

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

Note: The underlying call to add the user ID is synchronous, adding a large number of ID to an Information Barrier group may result in a long wait for this call to return. The maximum number of user IDs that can be passed in one call is conditioned by the size of that parameter: Maximum 2Mb.