Versions Compared

Old Version 26

changes.mady.by.user Amritesh Singh

Saved on

compared with

New Version 27

changes.mady.by.user Amritesh Singh

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Overview

You can use this Snap to list all the members (users) available in the given group object.

Snap Type

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

  • Min: 0

  • Max: 1

Mapper

Object ID of an existing desired group.

Output

Document

  • Min: 1

  • Max: 1

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:

  • Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Info

  • Asterisk (*): Indicates a mandatory field.

  • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ( (blue star) ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ((blue star)): Indicates that you can add fields in the fieldset.

  • Remove icon ((blue star)): Indicates that you can remove fields from the fieldset.

Field

Field Type

Description

Label*

Default Value: Get Group Members
Example: Get Group Members

String

Specify a unique name for the Snap.

Group object ID*


Default Value: N/A
Example: 3db4317-1c35-3x11-zd66-a1a05cfadc33

String/Expression

Specify the Object ID of the desired group.


Display Properties

Default Value: None
Example: accountEnabled, displayName

String/Expression

Specify the properties to be displayed in the output for the user or group.

Snap Execution


Default Value: Validate & Execute
Example: Execute only

Dropdown list

Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read


Multiexcerpt include macro
nameObtaining User object ID/Role object ID/Group object ID
pageCreate Entry


Multiexcerpt include macro
nameMicrosoft Graph API Output
pageCreate Entry

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.

Image RemovedImage Added

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.

Download this Pipeline.

Attachments
patterns*.slp, *.zip

Insert excerpt
Azure Active Directory Snap Pack
Azure Active Directory Snap Pack
nopaneltrue