LDAP Client


Performs a LDAP query.

This functions supports the following operations:

  • Add
  • Compare
  • Delete
  • Extended operation
  • Modify
  • Modify distinguished name
  • Search

The input to the function is configured in Settings -> Parameters.

A usecase can be to expose a LDAP database over HTTP.


When an event is received on the in port a LDAP query is performed according to the parameters configured in Settings -> Parameters.

If the query is sucess full, the event is routed to success. Otherwise‚ i.e. if an error occurs, the event is routed to error.

Input/Output Format


The parameters in Settings -> Parameters may be configured solely with static data. In that case, there is no assumptions made about the format of the received event, beyond it being an object.

However, if the functions is configured to use dynamic data through variable interpolation, then those make inherent assumptions about the shape of the received event.



In case of a successful query, the event received on the in port is routed as is through to the success port. When a compare, extended operation, or search operation is performed, the result of that operation is placed in the property ldapRes on the event. The specific format of said property is as follows:

A boolean.

Extended operation
The value depends on the operation, please consult relevant documentation.

An array. The items in the array are object with one of the following properties:

  • entry,
  • result, or
  • referral.

Per the specification, an entry is one LDAP entry that matches the search query, a referral indicates that a matching entry can be found on another server, and result contains indication of success or details on errors that occured during the processing of the query.

The following sub-properties may be useful:
{entry: {object}},
{result: {status}}, and
{referral: {uris}}.


If an error occurs, the received event is routed to the error port. The property ldapErr on the event is assigned an error value containing details on the error that occured.


This functions does not listen for, nor emit any events.


A bind operation is always done as the first operation after a connections is established.