How to use IBM App Connect with LDAP

Lightweight Directory Access Protocol (LDAP) is a set of open protocols that enables applications to communicate with other directory services over a network.

Availability:
  • App Connect Enterprise as a Service connector
  • A local connector in a Designer instance of IBM App Connect in containers (Continuous Delivery release)Local connector in containers (Continuous Delivery release)
  • A local connector in a Designer instance of IBM App Connect in containers (Long Term Support)Local connector in containers (Long Term Support release)
  • A local connector in a Designer instance of IBM App Connect in containers (Support Cycle 2)Local connector in containers (Long Term Support Cycle-2 release)

Supported product and API versions

To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.

Connecting to LDAP

Complete the connection fields that you see in the App Connect Designer Catalog page or flow editor. If necessary, work with your LDAP administrator to obtain these values.

LDAP connection fields:

Principal Distinguished Name
Specify the distinguished name (DN) of the LDAP user; for example, CN=user, OU=Organization, DC=mydomain, DC=com.
  • Required: True
Password
Specify the password that is associated with the distinguished name of the user.
  • Required: True
LDAP URL
Specify a valid LDAP URL in the format ldap://<host or IP address>:<port>.
  • Required: True
Private network connection

Select the name of a private network agent that App Connect uses to connect to your private network. This list is populated with the names of private network agents that are created on the Private networks page. For more information, see Connecting to a private network.

To connect to a LDAP endpoint from the App Connect Designer Catalog page for the first time, expand LDAP, then click Connect. For more information, see Managing accounts.

Tip:

Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Catalog page, select the account, open its options menu (⋮), then click Rename Account.

General considerations

Before you use App Connect Designer with LDAP, take note of the following considerations:

  • (General consideration) You can see lists of the trigger events and actions that are available on the Catalog page of the App Connect Designer.

    For some applications, the events and actions in the catalog depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

  • (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and actions

LDAP events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Show configurable events

Events that are shown by default are pre-configured by using optimized connectivity. More items are available after you configure events that can trigger a flow by polling this application for new or updated objects. For more information about configurable events, see Configuring polled events to trigger flows.

LDAP actions

Your flow completes these actions on this application.

Devices
Create device
Retrieve devices
Update device
Delete device
Entries
Create entry
Retrieve entries
Update entry
Delete entry
Modify distinguished name
InetOrgPerson objects
Create inetOrgPerson object
Retrieve inetOrgPerson objects
Update inetOrgPerson object
Delete inetOrgPerson object
Organizational persons
Create organizational person
Retrieve organizational persons
Update organizational person
Delete organizational person
Organizational units
Create organizational unit
Retrieve organizational units
Update organizational unit
Delete organizational unit
Persons
Create person
Retrieve persons
Update person
Delete person
Rooms
Create room
Retrieve rooms
Update room
Delete room

More items are available when you have connected App Connect to LDAP.

Examples

Dashboard tile for a template that uses LDAP

Use templates to quickly create flows for LDAP

Learn how to use App Connect templates to quickly create flows that complete actions on LDAP. For example, open the Templates gallery, and then search for LDAP.