This documentation is about a version that is out of support, here is the latest documentation version.

How about downloading a newer, supported version?

LDAP Connector

The LDAP connector allows a process to retrieve data from an LDAP server by running a query.

If you are looking for LDAP Authentication please go to: Active Directory or LDAP authentication.

Configuring an LDAP connector with the wizard:

  1. In the General screen:

    • Enter a name and description for the connector.

    • Specify whether the connector runs at the start or the end of the step.

    • Specify the behavior if the connector fails.

    • Click Next.

  2. Specify the LDAP server information:

    Input Description Type

    Host

    IP address or name of server hosting LDAP directory

    string

    Port

    LDAP directory port number

    number

    Protocol

    LDAP directory port number

    select

    user

    LDAP user name

    string

    password

    LDAP user password

    string

    Then click Next.

  3. Specify the search criteria:

    Input Description Type

    Base DN

    the Distinguished Name at which to start search

    string

    Filter

    specify a subset, e.g. (&(objectClass=person)(givenname=John))

    string in accordance with LDAP syntax

    Attributes

    define attributes to return in result entries using LDAP syntax

    string of strings separated by ","

    Scope

    subtree: entire subtree starting as the base DN, one level: entries immediately below the base DN, base: search just the named entry

    select

    Size limit

    maximum number of entries to return

    number

    Time limit (in seconds)

    maximum time to allow search to run

    number

    Referral handling

    ignore or follow referrals

    select

    Alias dereferencing

    always: always dereference aliases, searching: dereference aliases only after name resolution, never: never dereference aliases, finding: dereference aliases only during name resolution

    select

    Then click Next.

  4. Specify the output operations. The connector returns a list object.

  5. Click Finish.