...
...
...
...
...
In this article
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Overview
You can use the LDAP Search Snap to perform an LDAP search based on the Distinguished Name (DN) with a specific filter.
...
Snap
...
Read
...
Description:
This Snap performs a search operation on the LDAP server.
...
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 |
| 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 |
...
Input | This Snap has at most one input view, which contains the distinguished name of the unit to be searched, scope level and filter to be applied. |
---|---|
Output | This Snap has at most 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
...
Distinguished name
...
. |
...
[None]
...
This Snap uses account references created on the Accounts page of SnapLogic Manager to connect to an LDAP server. See LDAP Account for information on setting up this type of account.
Output | Document |
| 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:
Learn more about Error handling in Pipelines. |
Snap Settings
Info |
---|
|
Field Name | Field Type | Description |
---|---|---|
Label* Default Value: LDAP Search | String | Specify a unique name for the Snap. |
Distinguished name* Default Value: None | String | Specify the distinguished name of the entry you want to modify. |
Pass through Default |
...
Search scope
Required. The depth of the search. The options available include:
...
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 |
Search scope* Default Value: OBJECT | Dropdown list | Select one of the scopes for the search:
|
...
|
...
Filter
...
|
Default value: OBJECT
Filter* Default Value: N/A | String/Expression | Specify the filter to refine and return the search results. |
...
|
...
Example: (cn=s*)
...
| ||
Attributes
| 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. |
...
Example: givenName
Default value: None
...
Multiexcerpt include macro | ||||
---|---|---|---|---|
|
...
Multiexcerpt include macro | ||||
---|---|---|---|---|
|
Example of a Search result without any attributes:
...
Different filters supported by the LDAP Search Snap
Filter | Syntax for the filter |
---|---|
|
for example |
|
for example |
|
for example |
|
for example |
|
for example |
|
for example |
|
for example |
| for example |
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. | |
| |
Configure the LDAP Search Snap with a | The Snap displays all the records that do not start with the word user in the cn attribute. |
| |
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. |
Search results without any attributes
...
Search result with givenName and Company as the attributes
...
...
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|