Skip to main content

LDAP Authentication

The LDAP Authentication plugin lets people sign in to UNICONNECT AI with their directory account, instead of a separate password. It supports Active Directory and OpenLDAP. In the example, AUS Bank's staff already have accounts in the bank's Active Directory, and the plugin lets the collections team use them. The plugin is found under Configuration → System → Plugins, and it is off until it is turned on and saved.

Plugin Manager with the LDAP Authentication plugin selected and switched on, showing the LDAP Configuration fields for the server URL, AD domain, base DN, account, password and attributes, and a Self Registration switch

Figure 1. The LDAP Authentication plugin with its configuration fields. The values shown are placeholders.

Configuring the Plugin​

  1. Open Configuration → System → Plugins and choose LDAP Authentication.
  2. Turn the plugin on. The LDAP Configuration fields appear.
  3. Enter the LDAP Server URL, the AD Domain and the Base DN. All three are required.
  4. Enter the account the plugin uses to connect to the directory. This is the LDAP Account and LDAP Password.
  5. Add any extra attributes and choose Self Registration.
  6. Click Save Configuration.

Field Reference​

FieldPurpose
LDAP Server URLRequired. The directory server address, over ldap or ldaps, for example ldap://ad.example.com:389 or ldaps://ad.example.com:636.
AD DomainRequired. The Active Directory domain name, for example ad.example.com.
Base DNRequired. The Base Distinguished Name used to search for users, for example DC=ad,DC=example,DC=com.
LDAP AccountThe account name the plugin uses to connect to the LDAP server.
LDAP PasswordThe password of that connection account.
LDAP AttributesExtra attributes to read from the directory, as a comma separated list, for example employeeId.
Self RegistrationA switch that lets an LDAP user who signs in for the first time create their own account.
info

Use ldaps, the secure form of the address, wherever the directory supports it.

warning

The LDAP Account and its password are stored in the plugin. Use a dedicated account that can only search the directory, not a personal or administrator account. Managing plugins needs the Module and Plugin Configuration permission. See Integrations Permissions.

tip

Turn Self Registration on only if every directory user should be able to reach UNICONNECT AI. Otherwise create the users first and leave it off.