ManageGroupMembership
Adds or removes a list of users to a given group as members.
Procedure Specific Information
The driver executes the ManageGroupMembership stored procedure, which adds or removes users to update group membership.
For example:
EXEC [ManageGroupMembership] [GroupId] = '122789', [UserHashIDs] = '100000.be8s, 123456.ryyw, 423123.b3x5', [Mode] = 'remove'; EXEC [ManageGroupMembership] [GroupId] = '122789', [UserHashIDs] = '100000.be8s, 123456.ryyw, 423123.b3x5', [Mode] = 'add';
Input
| Name | Type | Required | Description |
| GroupId | Int64 | True | This is the ID of the group being modified. |
| UserHashIDs | String | True | A list of user HashIDs that will be added to a group. |
| Mode | String | True | Specify whether you want to add or remove members from the group
The allowed values are add, remove. |
Result Set Columns
| Name | Type | Description |
| Success | String | Shows if the download finished successfully. |
| UnprocessedUserId | String | Users that couldn't be added to the group. This represent an invalid user or user who is already been added to the group. |
| ProcessedUserId | String | User that is added to the group successfully. |