Integrating LDAP

What you need to integrate LDAP

A LDAP-compatible directory service server and the following information:

• The Directory Server Public IP/DNS Name
• The Directory Server Public Port Number
• User Full Name Attribute Name for all your directory users
• User Email Attribute Name for all your directory users
• Admin user with at least read and search permissions for all users you want to authenticate

LDAP Integration Settings

An important setting that you need to consider before enabling the integration is the option to Create new users in Nexudus if they don't exist.

Create new users in Nexudus if they don't exist OFF

Users trying to log in using their directory credentials (email + password) will only be able to access the Members Portal if they already have a customer account in Nexudus.

Example
A user has the following directory credentials:

email- name@example.com
password - example123

If the user trying to log in to the Members Portal using these directory credentials doesn't already have a customer account in Nexudus with name@example.com as their email address, they won't be able to log in.

Create new users in Nexudus if they don't exist ON

Users trying to log in to the Members Portal using their directory credentials (name/email + password) will be able to log in to the Members Portal, whether or not they already have a customer account in Nexudus.

If they happen to not have a customer account yet, Nexudus will automatically create a customer account (contact) for them using their username and email address from the directory.

Example

A user has the following directory credentials:

name- Customer Name
email- customername@example.com
password - example123

When they try to log in to the Members Portal using these directory credentials, Nexudus will check if they already have a customer account.

If they don't have a customer account yet, Nexudus will create an account for them with Customer Name as their name and customername@example.com as their email address.

Enabling the LDAP Integration

1. Log in to dashboard.nexudus.com if you aren't already.

2. Click Settings > Integrations > LDAP.

3. Enable the LDAP integration toggle.

4. Enable the Create new users if they don't exist if you want to regsiter directory users who don't have a Nexudus account as contacts.

5. Add your directory's public IP in the Server IP/host field.

6. Add your directory's server public port in the Server Port field.

7. Add the full path of the user you want to use to connect to your LDAP server in the Bind expression field.

8. Add the path to the container holding the users to authenticate in the Search expression field.

For example, "dc=example,dc=com".

Nexudus will try to locate a user in this container by performing a LDAP search using "({mail_attribute_name}={email})" search string.

9. Add the password for the user above in the Password field.

10. Add the name of your directory's FullName attribute in the Full name attribute name field.

This defaults to cn as it is the most common value.

11. Add the name of your directory's Email attribute in the Email attribute name field.

This defaults to email as it is the most common value.

This value will be used as the {mailattributename} variable when Nexudus does a LDAP search.

12. Click the Save Changes button.

You've successfully enabled the LDAP integration. We recommend you test the integration by trying to log in to your Members Portal using some directory user credentials.