...
In this
...
article
Table of Contents | ||||
---|---|---|---|---|
|
...
Snap type:
Read
...
Description:
...
Overview
You can use this Snap to list all the members (users) available in the given group object.
...
Snap Type
The Get Group Members is a Read-type Snap.
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Task Pipelines.
Limitations and Known Issues
None.
Snap Views
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. |
...
[None]
...
Works in Ultra Task Pipelines.
...
This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Azure Active Directory OAuth2 Account for information on setting up this type of account.
...
Input | This Snap has at most one document input view. |
---|---|
Output | This Snap has exactly one document output view. |
Error | This Snap has at most one document error view and produces zero or more documents in the view. |
...
Settings
Label
...
Group object ID
...
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. |
Snap Settings
Info |
---|
|
Field | Field Type | Description |
---|---|---|
Label* Default Value: Get Group Members | String | Specify a unique name for the Snap. |
Group object ID*
| String/Expression | Object ID of the desired group. |
Display Properties Default Value: None | String/Expression | Specify the properties to be displayed in the output for the user or group. |
Snap Execution
|
...
Value: Validate & Execute |
---|
...
Execute only | Dropdown list |
|
---|
Multiexcerpt include macro | ||||
---|---|---|---|---|
|
Multiexcerpt include macro | ||||
---|---|---|---|---|
|
Example
Displaying Specific User Properties in the Output
This example Pipeline demonstrates how
...
to display specific user properties in the output preview of the Get Group 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.
...
Attachments | ||
---|---|---|
|
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|