Modify LDAP Entry

Modify the data stored in an LDAP entry.

Description

This step performs an LDAP modify operation to alter the attributes of an existing entry in an external LDAP or Active Directory. Other journey steps may be used to add entries, bind entries, delete entries, modify passwords of entries, or search entries.

You can specify the LDAP by selecting either an LDAP connection or Active Directory connection. The LDAP entry to modify is specified by the DN (distinguished name). The step can be used to perform different types of modifications: add, replace, or delete. However, only one type of modification can be performed on any given attribute. For example, you cannot add and delete values of the same attribute at the same time.

If the step is successfully completed, the journey continues to the next step, and result data is outputted to a specified variable (if configured).

Note

All changes will be processed together so if one fails, the whole step fails.

Configuration

Field	Description
LDAP Provider	The LDAP connection or Active Directory connection to use
DN	Distinguished name (DN) that uniquely identifies an entry and describes its position in the database. For example: CN=Groups,OU=useast,DC=yourorg,DC=com
Output Variable	Name of the variable used to store the result data created by this step. This data represents the LDAP response.
Attributes to Replace	List of attributes for the replace modification type. Each list item represents a single attribute, where the name is the attribute description and the expression yields the value/s that will replace all existing ones. You can specify multiple values for an attribute using an array. Note: Specifying null for the item value will delete the attribute.
Attributes to Add	List of attributes for the add modification type. Each list item represents a single attribute, where the name is the attribute description and the expression yields the value/s to add to any existing ones. You can specify multiple values for an attribute using an array.
Attributes to Delete	List of attributes for the delete modification type. Each list item represents a single attribute, where the name is the attribute description and the expression yields the value/s to delete from existing ones. You can specify multiple values for an attribute using an array. Note: Specifying null for the item value will delete the attribute.

Result Data

The output variable stores the step response object with the following structure:

Field	Description
`is_successful`	Boolean. LDAP response which includes the status of the step (success or failure).
`result_code`	Number. LDAP response which includes a numeric result code to categorize the reason for the success or failure.
`error_message`	String. LDAP response message that is included with the result code.