LDAP system

The LDAP system contains the configuration needed to communicate with a LDAP system. It is used by LDAP sources to stream entities from LDAP catalogs. Note that Microsoft ActiveDirectory is also supported through its LDAP-compatible interface/API.

It supports the following properties:

Prototype

{
    "host": "FQDN of LDAP host",
    "port": 389,
    "use_ssl": false,
    "username": "$ENV(username-variable)",
    "password": "$SECRET(password-variable)",
    "charset": "latin-1"
}

Properties

Property

Type

Description

Default

Req

host

String

The fully qualified domain name (FQDN) of the LDAP host server

“localhost”

port

Integer

The TCP port of the LDAP service.

389

use_ssl

Boolean

Indicates to the client whether to use a secure socket layer (SSL) or not when communicating with the LDAP service

false

username

String

The user to authenticate as against the LDAP service. If not set, no authentication will be attempted.

password

String

The password to use for authenticating with the LDAP service. Required if username is set.

Yes

charset

String

The charset used to encode strings in the LDAP database. Defaults to "latin-1" aka "ISO-8859-1", as "UTF-8" is usually not the default encoding in LDAP catalogs at the time of writing.

“latin-1”

Example configuration

{
    "_id": "example_ldap",
    "name": "Example LDAP server",
    "type": "system:ldap",
    "host": "ldap.example.org",
    "port": 389,
    "username": "$ENV(username-variable)",
    "password": "$SECRET(password-variable)"
}