...
Snap type:
Read
...
Description:
...
In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
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 |
|---|---|---|---|---|
Input | Document |
| Generators | Entry type and key (if desired) to sort the entries. |
...
Output | Document |
| Any File Formatter Snap followed by File Writer. | List of existing entries of the selected type. |
...
[None]
...
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.
...
| 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
...
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:
Learn more about Error handling in Pipelines. | |||
Snap Settings
| Info |
|---|
|
Field Name | Field Type | Description |
|---|---|---|
Label*
Default Value: 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 | Dropdown list | Specify the kind of object to list. Options available include:
|
|---|
...
|
...
|
Order by Default value: |
|---|
...
Order by
...
Examples
...
N/A | 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 |
Example: displayName or userPrincipalName
Default value: [None]
Default Value: N/A | String/Expression | Specify the properties to be displayed in the output for the user or group. |
|---|---|---|
Snap Execution Default Value: Validate & Execute | Dropdown list | Select one of the following three modes in which the Snap executes:
|
Additional Information
| Multiexcerpt include macro | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Multiexcerpt include macro | ||||
|---|---|---|---|---|
|
| Multiexcerpt include macro | ||||
|---|---|---|---|---|
|
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.
...
| Attachments | ||
|---|---|---|
|
Snap Pack History
| Expand | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|