In this article

1 Overview
- 1.1 Snap Type
- 1.2 Prerequisites
- 1.3 Support for Ultra Pipelines
- 1.4 Limitations and Known Issues
2 Snap Views
3 Snap Settings
4 Additional Information
5 Example
- 5.1 Displaying Specific User Properties in the Output
6 Snap Pack History

Overview

You can use this Snap to list all the existing entries of the selected type (User/Group/Role) from the given Azure Active Directory instance. It will also sort the entries according to provided key.

Snap Type

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

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

Min: 0
Max: 1

Generators

Entry type and key (if desired) to sort the entries.

Output

Document

Min: 1
Max: 1

Any File Formatter Snap followed by File Writer.

List of existing entries of the selected type.

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 Group Members Example: Get Group 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.
Entity type Default Value: User Example: Group	Dropdown list	Specify the kind of object to list. Options available include: User Group Role
Order by Default value: N/A Example: displayName or userPrincipalName	String/Expression	Specify the attribute to be used to display the entries in ascending order. It is suggestible based on entry type. This is not applicable for Role type.
Display Properties Default Value: N/A 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

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 List Entries Snap.

First, configure the List Entries Snap to set the display properties you want to view in the output.

On validating the Snap, you can view the configured properties (attributes) in the output preview of the Snap.

Download this Pipeline

	File	Modified
Labels No labels Preview View	File Example_Azure_AD_List_Entries_Display_Properties.slp	Sept 01, 2022 by Kalpana Malladi

List Entries