Active Directory List Users

Overview

The Active Directory List Users Snap lists the user with the specified Distinguished Name in Active Directory.



Prerequisites

None.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has exactly one document input view.

Expected input: Distinguished name.

Output

This Snap has exactly one document output view.

Expected output: Lists the users in Active Directory based on the provided distinguished name.

Learn more about Error handling.

Snap settings

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

String

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: Active Directory List Users

Distinguished name

String/Expression

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 Active Directory Create Entry Snap first.

Example: CN=AbcUser,CN=Users,DC=server,DC=company,DC=com. To refer to the entire user list, 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

Pass through

Checkbox

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

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.