In this article
You can use this Snap to add or removes a given user to/from a given group.
Manage Group Membership is a Write-type Snap.
None.
Works in Ultra Task Pipelines.
None.
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| User Object ID, Operation to be performed (Add or Remove), and Role Object ID. |
Output | Document |
|
| HTTP status code 204 if the operation is successful. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. |
|
Field Name | Field Type | Description |
---|---|---|
Label*
Default Value: Manage Group Membership | String | Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline. |
User object ID* Default Value: N/A | String/Expression | Specify the User object ID of the user to be added or removed. |
Operation* Default Value: Add to Group | Dropdown list | Specify the action to be performed. Available options are:
|
Group object ID* Default Value: N/A | String/Expression | Specify the Group object ID of the desired group. |
Default Value: Execute only | Dropdown list |