Active Directory Rename

Overview

The Active Directory Rename Snap renames an entry from a given old name to its new name.

In the LDAP v2, this corresponds to the modify RDN operation that renames an entry within the same context (that is, renaming a sibling). In the LDAP v3, this corresponds to the modify DN operation, which is like modify RDN, except that the old and new entries need not be in the same context.

This is a Write-type Snap.
Works in Ultra Tasks

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: Old name, New name.	File Reader JSON Parser
Output	This Snap has exactly one document output view. Expected output: A document containing the status of the rename operation, indicating whether the old name was successfully renamed to the new name.	JSON Formatter File Writer
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 Rename
Old entry `String/Expression`	Required. The DN value of the entry to rename. 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. Typical RDN attribute types: DC = domainComponent CN = commonName OU = organizationalUnitName O = organizationName STREET = streetAddress L = localityName ST = stateOrProvinceName C = countryName UID = userid Example: `CN=AbcUser,CN=Users,DC=server,DC=company,DC=com` Default value: None
New entry `String/Expression`	Required. The DN value for the new entry name. Refer to the Old entry property for the description of DN and RDN values. Example: `CN=NewAbcUser,CN=Users,DC=server,DC=company,DC=com` 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.