Active Directory Update Entry

Overview

The Active Directory Update Entry Snap updates an entry in Active Directory.

An entry (user account) can be updated in any Organizational Unit (OU), Domain Controller (DC), etc. The attributes of the table will be created on suggest based on the existing distinguished name in Active Directory. The table consists of all the fields that need to be updated. To generate the suggested attributes into the table, the existing distinguished name is required.

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 exactly one document input view. Expected upstream Snaps: File Reader followed by any file parser followed by Structure. Expected input: Existing distinguished name, Entry attributes (Attribute keys, Attribute values).	File Reader Structure
Output	This Snap has exactly one document output view. Expected output: A document containing the status of the updated entry.	Mapper 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 Update Entry
Existing 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.
Attribute Value Delimiter `String/Expression`	Character or string to be used as delimiter to separate multiple values provided to the Attribute Value field. Example: `,` (Comma), `;` (Semi-colon), `:` (Colon), `/` (Forward slash) Default value: None
Entry attributes `Fieldset`	Required. The table of attribute key-value pairs to update the entry.
Attribute Key `String/Expression`	Required. The suggested attributes based on the provided Existing distinguished name property. Note: Some of the attribute keys and their values may be required to create the entry. For example: `objectClass`, `DistinguishedName`. Default value: None
Attribute Value `String/Expression`	Required. The corresponding values of the suggested key to update the entry. Note: Some of the attribute values corresponding to their keys are required to create the entry. For example: the value of the key `objectClass` as `top, user, organizationalPerson` and the value of the key `DistinguishedName` as `CN=SomeUser, CN=Users, DC=child, DC=parent, DC=Domain, DC=com`. Note: Space is considered to be a string in an attribute when using a multi-value attribute. 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.

Troubleshooting

None.