Skip to end of banner
Go to start of banner

LDAP Search

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 39 Next »

In this article

Overview

You can use the LDAP Search Snap to perform an LDAP search based on the Distinguished Name (DN) with a specific filter.

Snap Type

The LDAP Search is a Read-type Snap.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Task Pipelines.

Limitations and Known Issues

None.

Behavior Change

As of 432patches19873 Snap Pack version, any LDAP entry attribute that contains binary data will be displayed as a byte array (Base64 encoded) instead of a string in the output.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

  • Min: 0

  • Max: 1

File Reader followed by CSV Parser. 

The distinguished name of the unit to search, the scope of the search, and the filter to be applied.

Output

Document

  • Min: 0

  • Max: 1

N/A

The entry (if it exists) will be displayed with all its attributes.

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 when 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 if 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 ((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 field set.

  • Remove icon ( (blue star)): Indicates that you can remove fields from the field set.

  • Upload icon ((blue star) ): Indicates that you can upload files.

Field Name

Field Type

Description

Label*

Default Value: LDAP Search
ExampleSearch

String

Specify a unique name for the Snap.

Distinguished name*

Default Value: None
Examplecn=syed,ou=People,dc=Snaplogic,dc=com

String

Specify the distinguished name of the entry you want to modify.

Pass through

Default Value: Deselected

Checkbox

Select this checkbox to enable the Snap to pass the input data to the downstream Snap and display in the output document.

In certain scenarios, the Snap might be unable to process the entire input due to limitations imposed by the endpoint's API. In such cases, we recommend that you select the Pass through checkbox to ensure that the unprocessed input is not lost. You can process the remaining input data using more of the same Snap in the pipeline. Alternatively, you can also write the original data into a separate file using a combination of the Mapper Snap and the File Writer Snap. 

Include string representation for binary attributes

Checkbox

Select this checkbox to add a string representation of all binary attributes. When selected, the string representation of attribute values are appended to the output document, with a _str postfix.

Search scope*

Default ValueOBJECT
Example: SUBTREE

Dropdown list

Select one of the scopes for the search:

  • OBJECT (within the unit)

  • ONELEVEL (within the unit and its immediate children)

  • SUBTREE (within the unit and all its descendants)

Filter*

Default Value: N/A
Example(cn=s*)

String/Expression

Specify the filter to refine and return the search results.  

  • The filter must be enclosed in parentheses.

  • Refer to the table below for the filter options supported by this Snap.
    Learn more about LDAP filters.

Attributes


Default Value: None
Example: givenName

String

Specify the attributes that the Snap must return in the output. If you do not add any attributes, the output displays all the attributes by default.

Different filters supported by the LDAP Search Snap

Filter

Syntax for the filter

Equality:

(attribute=abc)

for example (&(objectclass=user)(displayName=Foeckeler)

Negation:NOT Filter

(!(attribute=abc))

for example (!objectClass=group)

Presence:

(attribute=*)

for example (mailNickName=*)

Absence:

(!(attribute=*))

for example (!proxyAddresses=*)

Greater than:

(attribute>=abc)

for example (mdbStorageQuota>=100000)

Less than:

(attribute<=abc)

for example (mdbStorageQuota<=100000)

Proximity:

(attribute~=abc)

for example (displayName~=Foeckeler) Caution: ~= is treated as = in ADS environments !!

Wildcards or substring:

for example (sn=F*) or (mail=*@cerrotorre.de) or (givenName=*Paul*)

Examples

Fetching records using and not filters

The example pipeline demonstrates how to use and not filters to fetch records based on the specified common name (cn).

Step1: Configure the LDAP Search Snap with the Distinguished name as follows:

Step 2: Configure specific filters to obtain the required results, as shown below.

When you are not using any filter, we are checking the presence.

The Snap displays the records that start with the word user in the cn field. Here, you can see a single record.

not filter

Configure the LDAP Search Snap with a not filter.

The Snap displays all the records that do not start with the word user in the cn attribute.

and not nested filter

Configure the LDAP Search Snap with a nested filter.

The Snap displays all the records that do not start with adduser but start with the word user in the cn field. The Snap displays only one such record.

Download this pipeline.

Search results without any attributes

Search result with givenName and Company as the attributes

Snap Pack History

 Click to view/expand
ReleaseSnap Pack VersionDateTypeUpdates
May 2024main26341 StableUpdated and certified against the current SnapLogic Platform release.
February 2024main25112 StableUpdated and certified against the current SnapLogic Platform release.
November 2023main23721 StableUpdated and certified against the current SnapLogic Platform release.
August 2023main22460 StableUpdated and certified against the current SnapLogic Platform release.
May 2023433patches21488 LatestEnhanced the LDAP Search and LDAP Lookup Snaps with the Include string representation for binary attributes checkbox to add a string representation for binary attributes.

May 2023

main21015 

Stable

Upgraded with the latest SnapLogic Platform release.

February 2023432patches19873 Latest

The binary data output for the LDAP Search and LDAP Lookup Snaps is displayed as a byte array (Base64 encoded) instead of string data.

February 2023main19844 StableUpgraded with the latest SnapLogic Platform release.
November 2022main18944 StableUpgraded with the latest SnapLogic Platform release.
August 2022main17386 StableUpgraded with the latest SnapLogic Platform release.
4.29main15993 StableUpgraded with the latest SnapLogic Platform release.
4.28main14627 StableUpgraded with the latest SnapLogic Platform release.

4.27

main12833

 

Stable

Upgraded with the latest SnapLogic Platform release.
4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25main9554
 
Stable

Upgraded with the latest SnapLogic Platform release.

4.24main8556
StableUpgraded with the latest SnapLogic Platform release.
4.23 Patches 423patches7454 Latest

Added the Pass through check box in all the Snaps to include pass-through functionality. Select this checkbox to embed the upstream input documents under the original key of the output document along with other records.

4.23main7430
 
StableUpgraded with the latest SnapLogic Platform release.
4.22main6403
 
StableUpgraded with the latest SnapLogic Platform release.
4.21snapsmrc542

 

StableUpgraded with the latest SnapLogic Platform release.
4.20snapsmrc535
 
StableUpgraded with the latest SnapLogic Platform release.
4.19snaprsmrc528
 
StableUpgraded with the latest SnapLogic Platform release.
4.18snapsmrc523
 
StableUpgraded with the latest SnapLogic Platform release.
4.17ALL7402
 
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapsmrc515
 
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.16snapsmrc508
 
StableUpgraded with the latest SnapLogic Platform release.
4.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.
4.14 Patch ldap5701  Latest

Enhanced LDAP Snap to include Search attributes that helps reduce payload.

4.14snapsmrc490
 
StableUpgraded with the latest SnapLogic Platform release.
4.13

snapsmrc486

 
StableUpgraded with the latest SnapLogic Platform release.
4.12

snapsmrc480

 
StableUpgraded with the latest SnapLogic Platform release.
4.11snapsmrc465
 
StableUpgraded with the latest SnapLogic Platform release.
4.10 Patch ldap3959 Latest

Updated the Apache Active Directory API JAR from version 1.0.0-M21 to 1.0.0 to address scenarios where the number of open file descriptors may continue to grow.

4.10

snapsmrc414

 
StableUpgraded with the latest SnapLogic Platform release.
4.9snapsmrc405
 
StableUpgraded with the latest SnapLogic Platform release.
4.8

snapsmrc398

 
StableUpgraded with the latest SnapLogic Platform release.
4.7

snapsmrc382

 
StableUpgraded with the latest SnapLogic Platform release.
4.6snapsmrc362
 
StableUpgraded with the latest SnapLogic Platform release.
4.5.1

snapsmrc344

 
StableUpgraded with the latest SnapLogic Platform release.
4.5

snapsmrc344

Stable

Enhanced the error view output to include error, reason, and resolution.

4.4
 Stable

JIRA Search now has the Ignore empty result option.

  • No labels