On this Page

Snap type:

Write

Description:

This Snap lists the user with the specified Distinguished Name in Active Directory.

Expected upstream Snaps: File Reader followed by any file Parser followed by Structure.
Expected downstream Snaps: Any file Formatter followed by File Writer.
Expected input: Distinguished name
Expected output: Lists the users in Active Directory based on the provided distinguished name.

Prerequisites:

[None]

Support and limitations:

Works in Ultra Tasks.

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:

Input	This Snap has exactly one document input view.
Output	This Snap has exactly 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

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

Distinguished name

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

This field is applicable only to existing users. If the user does not exist, create an entry using the Create Entry Snap first.

Example: 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.

Default value: [None]

You can also use special characters in the distinguished name. See the section Using Special Characters in Distinguished Name below.

Pass through

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

Default value: Not selected

Examples

The following table provides some examples of the data returned for varying Distinguished name values.

Distinguished name value	Returns

Distinguished name value	Returns
CN=user,CN=Users,DC=server,DC=company,DC=com	Details about that user.
CN=Users,DC=server,DC=company,DC=com	Details about all items in "Users" under that domain.
DC=server,DC=company,DC=com	Details about all objects on that server domain.

Active Directory List Users

Settings

Examples