Open Navigation

LDAP Client

A client for interacting with an LDAP/LDAPS server.
On This Page

Overview

The LDAP client connector provides operations for interaction with LDAP/LDAPS services.

Authentication

For all authentication types, you will require username, password, and the Base DN for your connection.

The Base DN is the base domain name for the LDAP directory. For example, if a user's DN was CN=Bob,CN=Users,DN=example,DN=com, the base DN would be DN=example,DN=com

LDAP Username/Password/DN Authentication

LDAP

If the connection you are making is regular LDAP, you only need the URL and Port for the host information. Do not include the protocol or the port in the URL.

URL and Port in LDAP Auth

LDAPS

When adding an LDAPS connection, URL and Port are required just like LDAP, but you can also provide additional options such as a certificate, or custom TLS Options.

A common TLS option to add here might be rejectUnatuhorized: false, allowing you to connect to LDAPS instances that have a self signed certificate. To do this, you would add a property to TLS Options, change the type to boolean and untick the box. The result can be seen below:

LDAPS Host settings with rejectUnauthorized false

The search operation can be used to perform LDAP queries, using a filter generated by the UI in the connector. If you want to enter your own custom filter, you can use the Search Raw operation, which will let you do so.

Alongside the filter, you can choose the scope for the query, as well as which attributes to return. You can return either a list of the DNs, or a selection of attributes. LDAP search attributes

If attributes is chosen, the default return type is to retrieve all attributes of the results. If you want to narrow this down further, you can provide a list of attributes to return.

Due to the possibility of very large result datasets, search operations will return up to 50 entries if returning as JSON. To return all the results, you can either choose to return the data as an XML file, or by paginating through the results as JSON by utilising the Batch get by DNs operation.

To return the data as an XML file, you can tick the Return as file option in the search operation. Return as file

Pagination

The easiest way to paginate is to perform a search query with DNs Only chosen for the return type, then processing the results in chunks. You can utilise the chunk operation in List Helpers to separate the list of DNs into groups of 50. Afterwards, you can loop through the groups of DNs and get their contents using Batch get by DNs.

Chunk operation

Batch get by DNs

Was this article helpful?
Yes
No
On This Page