LDAP

Discover more about the LDAP connector and how to use it on the Digibee Integration Platform.

LDAP performs search, add, modify, and delete operations on an LDAP server from your Digibee pipeline.

Parameters

Configure the connector using the parameters below. Fields that support Double Braces expressions are marked in the Supports DB column.

General

Parameter	Description	Data type	Supports DB	Default value	Visible when
Account	Account used to authenticate the connector against the LDAP server. Must be a Basic account type, configured in Accounts on the Platform.	String	❌	N/A	—
SSL	If enabled, the connector encrypts the connection using SSL. Configure the certificate through the Custom SSL Certificate parameter.	Boolean	❌	false	—
Custom SSL Certificate	Custom account used for the SSL connection.	String	❌	N/A	SSL is enabled
Operation	LDAP operation the connector executes: Search, Add, Delete, or Modify.	String	❌	Search	—
Search Operation	Scope of the search: Object, One level, or Sub trees.	String	❌	Object	Operation is Search
Modify Operation	Type of change applied to the entry: Add Attribute, Remove Attribute, Replace Attribute, or Increment Attribute.	String	❌	Add Attribute	Operation is Modify
Hostname	Name or IP address of the LDAP server.	String	✅	199.199.199.1	—
Port	Port used to connect to the LDAP server.	Integer	✅	389	—
Authentication DN	Distinguished Name (DN) used to connect the LDAP server. If left blank, the account username is used as the complete bind DN, with no changes applied. If filled in, the connector combines it with the account username using the format CN=<username>,<Authentication DN>.	String	✅	CN=Users,DC=digibee,DC=io	—
Operation DN	Distinguished Name (DN) the operation applies to.	String	✅	{{message.$.dnOperation}}	—
Filter	Filter expression used to narrow down the search results.	String	✅	N/A	—
Entries	JSON expression representing the entry attributes to add or modify.	String	✅	N/A	Operation is Modify or Add
Binary Entries	List of entries added through the connector UI. Select + Add to add a new item, and use the reorder and delete controls to manage items.	List	❌	N/A	Operation is Modify or Add
Entry Name	Name of the entry, set within a Binary Entries item.	String	❌	N/A	Inside a Binary Entries item
Fail On Error	If enabled, the execution of the pipeline with an error is interrupted, and the exception includes both the translated message and the original error detail. Otherwise, the pipeline execution proceeds, but the result shows a false value for the "success" property.	Boolean	❌	false	—

Documentation

Parameter	Description	Data type	Supports DB	Default value
Documentation	Optional field to describe the connector configuration and any relevant business rules.	String	❌	N/A

Configuring the Authentication DN parameter

The Authentication DN parameter determines how the connector builds the bind DN used to authenticate against the LDAP server. The account username, configured in the Username field of a Basic account on the platform, is always part of this bind DN. Whether Authentication DN is filled in or left blank determines whether the username is combined with the Authentication DN to form the bind DN, or used on its own as the complete bind DN, as detailed below.

Authentication DN filled in

The connector builds the bind DN by combining CN=, the account username, and the Authentication DN value:

CN=<account username>,<Authentication DN>

If you already have the user's full DN, split it into these two parts:

• Username (registered in the Username field, under Accounts on the platform): Only the CN value, without the CN= prefix. Example: UserExample.

• Authentication DN (the connector parameter): Everything after the CN segment. Example: OU=FOLDER1,DC=abc,DC=com,DC=br.

With those values, the connector binds as cn=UserExample,OU=FOLDER1,DC=abc,DC=com,DC=br.

Important information:

• Don't include CN= in either field. The connector adds it automatically.

• The username configured in the account must match the "name" field configured in the LDAP server.

Authentication DN left blank

The connector uses the account username exactly as registered, with no changes applied. In this case, the Username field under Accounts must contain the complete bind DN, including its RDN attribute, for example:

UID=jsilva,OU=people,DC=abc,DC=com,DC=br

Use this mode when the user's RDN isn't CN, for example directories that authenticate with UID=, sAMAccountName, or a UPN such as user@domain.

When Authentication DN is blank, the connector validates the configuration at deploy time: the account username can't be empty, the DN must be parseable, and the account password can't be blank. Configuration errors are reported immediately instead of only surfacing at execution time.

Building expressions for LDAP parameters

Several LDAP parameters accept a fixed value, a Double Braces expression, or a combination of both. Double Braces expressions use JSON Path syntax; see the JsonPath specification for the full syntax reference.

Operation DN

You can:

• Use a fixed value: dnOperation = "ou=system,cn=users"

• Reference a field from the message: dnOperation = "{{ message.$.dn }}"

• Combine both: dnOperation = "ou={{ message.$.dn }}"

Filter

You can:

• Use a fixed value: filter = "(objectClass=)"

• Reference a field from the message: filter = "{{ message.$.filter }}"

• Combine both: filter = "objectClass={{ message.$.filter }}"

Entries

The Entries parameter is a JSON expression used to add or modify entries in the LDAP server.

You can:

• Use a fixed value: entries = {"objectClass": ["top", "person"], "cn": "test_ad", "sn": "test_sn"}

• Reference a field from the message: entries = "{{ message.$.entries }}"

• Combine both: entries = {"objectClass": ["top", "person"], "cn": "{{ message.$.entries }}", "sn": "test_sn"}

Search Operation values

Value	Meaning
0	Base Object
1	One Level
2	Full Subtree

Modify Operation values

Value	Meaning
0	Add attribute
1	Exclude attribute
2	Substitute attribute
3	Increment attribute

Operation, SSL, and error handling

• Operation: The operation to execute on the LDAP server: SEARCH, ADD, MODIFY, or DELETE.

• SSL: If true, the connection uses SSL. If false, the connection isn't encrypted.

• Fail On Error: If true, an error suspends the pipeline execution.

Messages flow

Operation search

Input

{
  "type": "connector",
  "name": "ldap-connector",
  "accountLabel": "ldap",
  "stepName": "ldap",
  "params": {
    "operation": "SEARCH",
    "host": "LDAP_IP",
    "port": 389,
    "dnAuthentication": "DC=digibee,DC=io",
    "dnOperation": "DC=digibee,DC=io",
    "filter": "(objectClass=)",
    "searchOperation": 0,
    "useSsl": false,
    "failOnError": false
  }
}

Output

{
    "result": [
        {
            "pwdhistorylength": "24"
        },
        {
            "msds-alluserstrustquota": "1000"
        },
        {
            "otherwellknownobjects": [
                "B:32:683A24E2E8164BD3AF86AC3C2CF3F981:CN=Keys,DC=digibee,DC=io",
                "B:32:1EB93889E40C45DF9F0C64D23BBB6237:CN=Managed Service Accounts,DC=digibee,DC=io"
            ]
        }
    ]
}

Operation add

Input

{
  "type": "connector",
  "name": "ldap-connector",
  "accountLabel": "ldap",
  "stepName": "ldap",
  "params": {
    "operation": "ADD",
    "host": "LDAP_IP",
    "port": 389,
    "dnAuthentication": "DC=digibee,DC=io",
    "entries": "{{ message.$.entries }}",
    "dnOperation": "DC=digibee,DC=io",
    "useSsl": false,
    "failOnError": false
  }
}

Payload

{
     "entries": {
            "objectClass": ["top", "person"],
            "cn": "test_ad",
            "sn": "test_sn"
     }
 }

Output

{
    "message": "Entry added successfully",
    "success": true
}

Operation modify

Input

{
  "type": "connector",
  "name": "ldap-connector",
  "accountLabel": "ldap",
  "stepName": "ldap",
  "params": {
    "operation": "MODIFY",
    "host": "LDAP_IP",
    "port": 389,
    "dnAuthentication": "DC=digibee,DC=io",
    "entries": "{{ message.$.entries }}",
    "dnOperation": "DC=digibee,DC=io",
    "modifyOperation": 0,
    "useSsl": false,
    "failOnError": false
  }
}

Payload

{
     "entries": {
            "objectClass": ["top", "person"],
            "cn": "test_ad",
            "sn": "test_sn"
     }
}

Output

{
    "message": "Entry modified successfully",
    "success": true
}

Operation delete

Input

{
    "type": "connector",
    "name": "ldap-connector",
    "accountLabel": "ldap",
    "stepName": "ldap",
    "params": {
        "operation": "DELETE",
        "host": "LDAP_IP",
        "port": 389,
        "dnAuthentication": "DC=digibee,DC=io",
        "dnOperation": "DC=digibee,DC=io",
        "useSsl": false,
        "failOnError": false
    }
}

Output

{
    "message": "Entry deleted successfully",
    "success": true
}