In this article
You can use this Snap to list all the members (users) having the given role.
Get Role Members is a Read-type Snap.
None.
Works in Ultra Pipelines. However, we recommend that you not use this Snap in an Ultra Pipeline.
None.
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
| Mapper | Object ID of an existing desired group. |
Output | Document |
| Any File Formatter Snap followed by File Writer. | List of users present in the group. |
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: Get Role Members | 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. |
Role object ID Default Value: N/A | String/Expression | Specify the Object ID of the desired role. |
Display Properties Default Value: None | String/Expression | Specify the properties to be displayed in the output for the user or group. |
Default Value: Validate & Execute | Dropdown list |
This example Pipeline demonstrates how you can display specific user properties in the output preview of the Get Role Members Snap.
First, configure the Snap to set the display properties you want to view in output.
On validating the Snap, you can view the configured properties (attributes) in the output preview of the Snap.