LDAP Add

This page describes the LDAP Add Pipes valve and its supported options.

Introduction

Prerequisites

Before using this valve the LdapClient module must be configured and deployed.

Configuration

Note

Valve name: LDAPAdd

Common LDAP valve configuration can be found here.

Operates on the current item. By default item.id() is used as the LDAP DN. If dn_parameter is set, that value is used instead.

Properties

Name	Description	Default	Mandatory	Expanded
attributes	List of item properties to include as attributes.	N/A
ignore_empty_values	Ignore empty values in properties. The attribute is not sent to the LDAP client if empty.	false
dn_parameter	If not using item.id() as DN value.	N/A

Example

{
  "name": "LDAPAdd",
  "config": {
    "destination": "default",
    "dn_parameter": "${item.dn}",
    "attributes": ["uid", "mail", "mobile"]
  }
}

Audit

Every successful add operation publishes raw changes to the platform audit trail automatically — there is no audit flag to configure on the valve or the LdapClient anymore. Whether anything is actually recorded depends on whether an Audit module is deployed to consume it.

Note

Attribute values matching a sensitive keyword (password, unicodePwd, pwd, and similar) are masked as ***** before publishing.

Valve config

{
  "name": "LDAPAdd",
  "config": {
    "attributes": ["cn", "sn", "objectClass"]
  }
}

Published changes

[
  { "field": "objectClass", "after_value": "inetOrgPerson" },
  { "field": "cn",          "after_value": "Demo User" },
  { "field": "sn",          "after_value": "User" }
]

• object_type user, package_type UserCreated — always, regardless of what kind of entry is actually added; this valve has no concept of object type beyond "user"
• object_id — the DN of the created entry, taken from item.id() (or dn_parameter)
• one change per attribute listed in attributes, one row per multi-value attribute

See Audit for how published changes are grouped into events and change packages, and for the built-in UI and REST API to view them.