This Snap has at most one document input view.

Expected input: Existing distinguished name, Filter attributes (Filter keys, Filter values).

• File Reader
• JSON Parser
• Structure

This Snap has exactly one document output view.

Expected output: The output data and the searched entries based on the specified existing distinguished name.

• Mapper
• File Writer

Required. 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: Search

Example: Active Directory Search

Required. Specify the LDAP API references an LDAP object by its distinguished name (DN). A DN is a sequence of relative distinguished names (RDN) connected by commas. An RDN is an attribute with an associated value in the form attribute=value, normally expressed in a UTF-8 string format.

The typical RDN attribute types include: DC = domainComponent, CN = commonName, OU = organizationalUnitName, O = organizationName, STREET = streetAddress, L = localityName, ST = stateOrProvinceName, C = countryName, UID = userid.

A distinguished name for an LDAP entry can be represented as: CN=AbcUser,CN=Users,DC=server,DC=company,DC=com. In this example, to refer to the entire user list, you can remove the initial attribute, CN=AbcUser.

You can also use special characters in the distinguished name. See using special characters in Distinguished Name.

Default value: None

Example: CN=User

Required. Specify the size of the page to receive search results. The maximum value accepted by Active Directory is 1000. Refer to Microsoft MSDN documentation for more information.

Default value: 1000

Example: 500

Specify the number of search records to be fetched from the Active Directory.

• If the value is 0, then the Snap will fetch all the records.
• Your existing Pipelines that use Page Size for limiting records may fail to execute. Hence, modify your Pipelines using the Limit field.

Default value: 0

Example: 5

Specify the scope type to search against. The options available include:

• SUBTREE_SCOPE: A subtree search (or a deep search) includes all child objects as well as the base object.
• ONELEVEL_SCOPE: A one-level search is restricted to the immediate children of a base object, but excludes the base object itself. This setting can perform a targeted search for immediate child objects of a parent object.
• OBJECT_SCOPE: A base search (OBJECT_SCOPE) limits the search to the base object. The maximum number of objects returned is always one. This search is useful to verify the existence of an object for retrieving group membership.

Default value: SUBTREE_SCOPE

Select to group the output result in a single array.

When Group result is checked, the documents will be grouped inside an array instead of individual documents.

Default value: Deselected

Select to include the entire input data in the Snap's output. The Snap includes this data within the $original field in the output.

In certain scenarios, the Snap may 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 Snaps 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.

Default value: Deselected