List Entries

On this Page

Snap type:

Read

Description:

This Snap lists 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.

Expected upstream Snaps: Generators.
Expected downstream Snaps: Any file Formatter followed by File Writer.
Expected input: Entry type and key (if desired) to sort the entries.
Expected output: List of existing entries of the selected type.

Prerequisites:

[None]

Support and limitations:

Works in Ultra Task Pipelines.

Account:

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Active Directory Basic Auth Account for information on setting up this type of account.

Views:

Input	This Snap has no input views.
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

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

The kind of object to list. Options available include User, Group, or Role.
Default value: User

Order by

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.

Example: displayName or userPrincipalName

Default value: [None]

Display Properties

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

Default value: None

Example: accountEnabled, displayName

Page lookup error: page "Anaplan Read" not found.

If you're experiencing issues please see our Troubleshooting Guide.

Page lookup error: page "Anaplan Read" not found.

If you're experiencing issues please see our Troubleshooting Guide.

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

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

Download this Pipeline

Error rendering macro 'excerpt-include' : No link could be created for 'Azure Active Directory Snap Pack'.