LDAP Search

Overview

The LDAP Search Snap performs an LDAP search based on the Distinguished Name (DN) with a specific filter.



Supported Accounts

Behavior changes

  • 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 Description Examples of upstream and downstream Snaps
Input

This Snap has at most one document input view.

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

This Snap has at most one document output view.

The entry (if it exists) will be displayed with all its attributes.
Learn more about Error handling.

Examples

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description
Label*

String

Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: LDAP Search

Example: Search
Distinguished name*

String/Expression		 Specify the distinguished name of the entry you want to modify.

Default value: N/A

Example: cn=syed,ou=People,dc=Snaplogic,dc=com
Pass through

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 and the File Writer .

Default value: Deselected
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.

Default value: Deselected
Search scope*

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)

Default value: OBJECT

Example: SUBTREE
Filter*

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.

Default value: N/A

Example: (cn=s*)
Attributes

String/Expression		 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.

Default value: N/A

Example: givenName
Snap execution

Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • 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.

Default value: Validate and Execute

Example: Execute only

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