Versions Compared

Old Version 2

changes.mady.by.user Srilakshmi Gavirneni (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 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

  • Min: 0

  • Max: 1

Generators

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

Expected output: 

Output

Document

  • Min: 1

  • Max: 1

Any File Formatter Snap followed by File Writer.

List of existing entries of the selected type.

 

Prerequisites:

[None]

 

Support and limitations:Ultra pipelines: May work in Ultra Pipelines.
  • Spark mode: Not supported in Spark mode.

    •  

    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:
    InputThis Snap has no input views.
    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 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

     

    The

    Default Value: User
    Example: Group

    Dropdown list

    Specify the kind of object to list. Options available include:

    • User

    ,

    • Group

    , or Role.

    • Role

    Order by

    Default value:

    UserAttribute

    N/A
    Example: displayName or userPrincipalName

    Order by

    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:

     displayName or userPrincipalName

    Default value:  [None]

     

     

    Examples

    Image Removed

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

    Attachments
    patterns*.slp, *.zip

    Snap Pack History

    Expand

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