Skip to Content
DocsConnectorsPrebuilt ConnectorsLDAP

LDAP

In an application, right-click on Sources -> select Create source -> type any Source name and select LDAPSource in the Source type field -> click Create.

  • hostName - host name, e.g. ldap.jumpcloud.com
  • port - port, e.g. 636
  • bindDN - DN of the user’s LDAP object, e.g. uid=<your-user-name>,ou=Users,o=<your-org-id>,dc=jumpcloud,dc=com
  • password - password of the user

Load data from LDAP

To load data from LDAP, use Load operation.

There is no reliable way to list all possible attributes that an LDAP object can have, thus you have to list what attributes you want to load from LDAP. The list of attributes is defined as Model specification that is then selected in the Model field in the Source section of Load operation.

LDAPSource can return data from LDAP in two table formats specified in the table format field, which is next to the Table field in the source section of Load operation:

  • table - each LDAP entry is parsed into a table record where each LDAP attribute is represented as a column. Values of multi-valued attributes are concatinated using valueSeparator (see below). In this case, the target source must support tables in the table format, for example, relational database.
  • file - Loading LDAP data in file format is useful to see all possible attributes returned for LDAP objects. You can use this knowledge to specify all attributes to load from LDAP. If file format is used, each LDAP entry is returned in The LDAP Data Interchange Format (LDIF). Entries are seperated using entrySeparator (see below). In this case, the target source must support tables in the file format, for example, file system or Amazon S3.

Load operation properties for loading data from LDAP:

  • Source - select an LDAPSource-typed source
  • Space - ignored
  • Table - an LDAP query in the InfoLink-proprietary JSON-object format that has the following properties:
    • baseDN - base DN that defines the root for search
    • filter - LDAP filter
    • searchScope - search scope as defined by UnboundID LDAP SDK in the SearchScope  class. Possible values (default value: ONE):
      • BASE - Indicates that only the entry specified by the base DN should be considered.
      • ONE - Indicates that only entries that are immediate subordinates of the entry specified by the base DN (but not the base entry itself) should be considered.
      • SUB - Indicates that the base entry itself and any subordinate entries (to any depth) should be considered.
      • SUBORDINATE_SUBTREE - Indicates that any subordinate entries (to any depth) below the entry specified by the base DN should be considered, but the base entry itself should not be considered, as described in draft-sermersheim-ldap-subordinate-scope.
    • valueSeparator - used to concatenate multiple values of an LDAP attribute. It is in the Java literal format. The default value is ;.
    • entrySeparator - used to concatenate multiple LDAP entries when LDAP data is load into a file. It is in the Java literal format. The default value is ------------\n
  • table format (next to the Table field) - can be table or file as described above.
  • Model - model specification that contains a list of attributes to be loaded from LDAP. In the specification, set Standard Type to text as it is the only type supported.

An example of an LDAP query in the Table field:

{"baseDN":"ou=Users,o=6400909c1fd886789e1b99dc,dc=jumpcloud,dc=com", "filter":"(objectClass=inetOrgPerson)", "searchScope": "ONE", "valueSeparator": "#", "entrySeparator": "---\n" }
Last updated on