Versions Compared

Old Version 3

changes.mady.by.user Aparna Tayi (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Lakshmi Manda

Saved on

Key

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

...

Snap type:

...

Read

 

...

Description:

...

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) having the given role

...

.

...

Snap Type

Get Role Members is a Read-type Snap.

Prerequisites

None.

Support for Ultra Pipelines  

Works in Ultra Pipelines. However, we recommend that you not use this Snap in an Ultra Pipeline.

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

role.Expected output: 

group.

Output

Document

  • Min: 1

  • Max: 1

Any File Formatter Snap followed by File Writer.

List of users

having

present in the

given role

group.

 

Prerequisites:

[None]

 

Support and limitations:

 

Account: 

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.

 

Views:
InputThis Snap has at most one document input view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.

 

Settings

Label

 

Required. The

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 Name

Field Type

Description

Label*

Default Value: Get Role Members
Example: 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

 

Required.

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

String/Expression

Specify the Object ID of the desired role.

Examples

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

Select one of the following three modes in which the Snap executes:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Additional Information

Multiexcerpt include macro
nameUser-Agent-Header
templateData[]
pageAuthenticate Users
addpanelfalse

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 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.

...

Download this Pipeline.

Attachments
patterns*.slp, *.zip

Snap Pack History

Expand

Insert excerpt
Microsoft Entra ID Snap Pack
Microsoft Entra ID Snap Pack
nameAAD_SPH
nopaneltrue