Getting Started
Basic Concepts
Advanced Concepts
How-to Guides
Building integration flows
Data transformation
Integration patterns
Developing Components
Tenant Management
CRM components
ERP components
E-Commerce components
Marketing-related components
Finance-related components
Office components
Protocol components
Service components
Database components
Utility components
Component Descriptor
Covered in this article

Ldap component

LDAP component for the platform

Lightweight Directory Access Protocol is an open, vendor-neutral, industry standard application protocol for accessing and maintaining distributed directory information services over an Internet Protocol (IP) network. Directory services play an important role in developing intranet and Internet applications by allowing the sharing of information about users, systems, networks, services, and applications throughout the network.


This component has no trigger functions. This means it will not be accessible to select as a first component during the integration flow design.


Performs an LDAP search operation on the instance.

  • Base refers to the base object in the directory from which to start the search.
  • Filter allows you to specify one or more LDAP filters to restrict the results of the search.
  • Scope refers to the search scope. Options are base, one or sub (sometimes called baseObject, singleLevel or wholeSubtree respectively). The subordinates (a.k.a. subordinateSubtree) scope is not yet supported.

Each matched result is returned individually.


This component has some integration tests. In order to run the integration tests, one needs to create a .env file which contains the following environment variables:

LDAP_URL=<URL To Test Instance>
LDAPUSER=<User For Test Instance>
PASSWORD=<Password For Test Instance>
BASE=<Search Criteria which should match exactly 4 results>

Configuration Info

Required environment variables

No environment variables need to be configured.

Version and compatibility information

This component interacts with LDAP v3.


Apache-2.0 © GmbH