In this article

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

Asterisk (*): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon (): Indicates that you can add fields in the fieldset.
Remove icon (): 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 Default Value: N/A Example: 3db4317-1c35-3x11-zd66-a1a05cfadc33	String/Expression	Specify the Object ID of the desired role.
Display Properties Default Value: None Example: accountEnabled, displayName	String/Expression	Specify the properties to be displayed in the output for the user or group.
Page lookup error: page "Anaplan Read" not found. If you're experiencing issues please see our Troubleshooting Guide. Default Value: Validate & Execute Example: Execute only	Dropdown list	Page lookup error: page "Anaplan Read" not found. If you're experiencing issues please see our Troubleshooting Guide.

Additional Information

User-Agent Header

The Azure Active Directory Snap Pack utilizes the REST HTTP Client to send HTTP requests to the Azure endpoint. This process incorporates a User-Agent header with the value of "SnapLogic" for every request. By including the User-Agent header, you can monitor and track the requests made to the Azure endpoint, allowing you to determine the total count of requests made.

To view the User-Agent number for a user or group:

Log in to the Azure portal.
Navigate to Azure services > Azure Active Directory.
Navigate to Users/Groups and select the desired User/Group.
Click Audit logs in the left navigation menu.
In the right pane, you can view the User-Agent number in the following format:
SnapLogic (<build_number>) - pid-113e3955-1969-4541-9c9c-e3e0c897cccd. For example, a PR build might have SnapLogic (PR21312) - pid-113e3955-1969-4541-9c9c-e3e0c897cccd as the User Agent
The pid value comes from Microsoft®.

Obtaining User object ID/Role object ID/Group object ID from Azure Portal

Log in to the Azure portal.
Navigate to Azure Active Directory>Users/Groups.
Select a specific User/Group.
In the Profile, you can view the Object Id.
Copy the Object ID and use it to configure the relevant Snap as required.

Many features in Microsoft Graph API work similarly to the Azure Active Directory Graph APIs. However, a few have been changed or improved. For instance, there is a variation of the entity names in the output preview. This table depicts the difference in the output:

Old output (Azure AD Graph API)

New Output (Microsoft Graph API)

The entity object Id property was displayed as “ObjectId".

Learn more about the properties in Azure AD Graph API:

Azure AD Graph API Entity and Complex Type Reference

The object Id property is displayed as “Id" in the output.

The output also contains the default parameters shown by the Microsoft Graph API. However, there are certain attributes such as city that can be set by the Create Entry Snap, but this parameter is not displayed in the output as it is not the default output parameter. If you want use such parameters in your output, you can use filters to filter the parameters.

Learn more about the properties in Microsoft Graph API:

User properties: User resource type - Microsoft Graph v1.0
Group properties: Group resource type - Microsoft Graph v1.0

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.

	File	Modified

No files shared here yet.

Snap Pack History

Click here to expand...

Release	Snap Pack Version	Date	Latest	Update
November 2024	main29029	13 Nov 2024	Stable	Updated and certified against the current Snaplogic Platform release.
August 2024	main27765	21 Aug 2024	Stable	Updated and certified against the current SnapLogic Platform release.
May 2024	main26341	08 May 2024	Stable	The Azure Active Directory Snap Pack and Account names have been renamed because Microsoft has rebranded Azure Active Directory to Microsoft Entra ID. Azure Active Directory Snap Pack → Microsoft Entra ID Snap Pack Azure Active Directory OAuth2 Account → Microsoft Entra ID OAuth2 Account
February 2024	main25112	14 Feb 2024	Stable	Updated and certified against the current SnapLogic Platform release.
November 2023	main23721	08 Nov 2023	Stable	Updated and certified against the current SnapLogic Platform release.
August 2023	434patches22620	23 Aug 2023	Latest	Fixed an issue with the Create Entry Snap that caused it to fail with a cast error when a boolean value was entered in a field where expressions were enabled.
August 2023	main22460	16 Aug 2023	Stable	Updated and certified against the current SnapLogic Platform release.
May 2023	433patches21349	13 Jun 2023	Latest	The Azure Active Directory Snap Pack now incorporates an identifying header allowing the Azure portal to identify the source of API requests for auditing purposes.
May 2023	main21015	10 May 2023	Stable	Upgraded with the latest SnapLogic Platform release.
February 2023	432patches20059	09 Mar 2023	Latest	The Azure Active Directory OAuth2 account supports selecting a Grant type, which enables you to authorize your account with an authorization code or client credentials.
February 2023	main19844	09 Feb 2023	Stable	Upgraded with the latest SnapLogic Platform release.
November 2022	main18944	10 Nov 2022	Stable	The Azure Active Directory List Users, Azure Active Directory Get Group Members, and Azure Active Directory Get Role Members Snaps now include the Display Properties field, which allows you to enter the properties that you want to view in the output.
August 2022	430patches17462	30 Aug 2022	Latest	The List Entries, Get Group Members and Get Role Members Snaps now have the Display Properties field that allows you to enter the user or group properties that you want to view in the output.
August 2022	main17386	11 Aug 2022	Stable	The Azure Active Directory Search Entries Snap includes the Display Properties field where you can specify the properties to display in the output for the user or group. For the Snap to correctly return the attributes in the output, you must specify the attribute name as described in User profile attributes in Azure Active Directory B2C. Learn more about Properties for a user and Properties for a group.
4.29 Patch	429patches16884	12 Jul 2022	Latest	Fixed the following issues in the Azure Active Directory OAuth2 account: Removed the Header authenticated checkbox. Modified the default values for OAuth2 Endpoint and Token values where the tenant-id was hardcoded. Now the tenant-id is displayed as <tenant-id> and not a static value. Fixed the following issues in the Azure Active Directory Search Entries Snap: The Snap retrieved only 1000 records and did not retrieve all the records from the directory. Now, the Snap retrieves all the records from the directory. The Snap failed with the `400 status code error` during validation and aborted during execution when values were added in the Properties* field. Now, Snap does not fail regardless of the value in the Properties field.
4.29 Patch	429patches16391	09 Jun 2022	Latest	Enhanced the Azure Active Directory Search Entries Snap with the Properties field to display the attributes you want to view in the output.
4.29	main15993	14 May 2022	Stable	SnapLogic has migrated from Azure AD Graph APIs to Microsoft Graph APIs for all the endpoints due to the deprecation of Azure Active Directory Graph APIs by Microsoft. If you have any existing Pipelines that use the accounts authenticated with the old URL (OAuth2), then you must update them using the new URLs (v2.0) and reauthorize the account.
4.28	main14627	12 Feb 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.27	main12833	13 Nov 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.26	main11181	14 Aug 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.25 Patch	425patches10868	03 Aug 2021	Latest	Enhanced the Create Entry and Update Entry Snaps to support Pipeline parameters and upstream values for the Attribute name field under Attributes and the Snap Pack to support Proxy Authentication.
4.25	main9554	08 May 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.24	main8556	13 Feb 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.23	main7430	14 Nov 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.22	main6403	12 Sep 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.21	snapsmrc542	09 May 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.20 Patch	azureactivedirectory8713	13 Feb 2020	Latest	Fixes Azure Active Directory Snaps where the Snaps fail after running approximately an hour when the access token times out, and the Snap fails to detect the updated token.
4.20	snapsmrc535	08 Feb 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.19 Patch	azureactivedirectory8341	19 Nov 2019	Latest	Fixes an issue with the Get Group Members Snap wherein the Snap is unable to return more than 100 users.
4.19	snaprsmrc528	14 Nov 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.18	snapsmrc523	10 Aug 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.17	ALL7402	11 Jun 2019	Latest	Pushed automatic rebuild of the latest version of each Snap Pack with SnapLogic UAT and Elastic servers.
4.17	snapsmrc515	11 Jun 2019	Latest	Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.
4.16	snapsmrc508	16 Feb 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.15	snapsmrc500	15 Dec 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.14	snapsmrc490	11 Aug 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.13	snapsmrc486	12 May 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.12	snapsmrc480	17 Feb 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.11	snapsmrc465	11 Nov 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.10	snapsmrc414	12 Aug 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.9	snapsmrc405	13 May 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.8	snapsmrc398	11 Feb 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.7	snapsmrc382	23 Nov 2016	Stable	Upgraded with the latest SnapLogic Platform release.
4.6	snapsmrc362	13 Aug 2016	Stable	Upgraded with the latest SnapLogic Platform release.
4.5.1	snapsmrc344	18 May 2016	Stable	Upgraded with the latest SnapLogic Platform release.