Active Directory Disable Entry

Overview

The Active Directory Disable Entry Snap disables an entry in the Active Directory based on the provided distinguished name.

Supported Accounts

Active Directory Basic Auth Account

Prerequisites

None.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has at most one document input view.

Expected input: Distinguished name.
Output

This Snap has exactly one document output view.

Expected output: The disabled 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 Disable Entry
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

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 using special characters in Distinguished Name.
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.

Using Special Characters in Distinguished Name

You can include special characters in the Distinguished name and Existing distinguished name fields. As of Patch activedirectory8789, the fields do not require the following special characters to be prefixed with an escape character:

  • Forward slash (/)
  • Backward slash (\)
  • Plus (+)
  • Double-quote (")
  • Less than symbol (<)
  • Greater than symbol (>)
  • Semi-colon (;)

If an escape character is prefixed, the Snap reads it, else, it prefixes it to the special character to correctly process the data.

Note: Comma (,) and Equals (=) have a special meaning in the distinguished name, as comma (,) is used to separate RDNs and equals (=) is used for designating key value pairs (key=value). Therefore, these must still be prefixed with an escape character to be passed as special characters. For example, \, or \=.

Example: Using Special Characters

Let us say you need to specify a distinguished name like CN=man/eesh,CN=Users,DC=ad1,DC=clouddev,DC=snaplogic,DC=com, where the common name man/eesh contains a special character.

The Snap supports both scenarios:

  • If the special character is prefixed with an escape character. For example, CN=man\/eesh.
  • If no escape character is used. For example, CN=man/eesh.

In both cases, the Snap generates the same output during Pipeline validation. This ensures existing Pipelines do not break in either case.

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