Skip to main content

Prerequisites

  • Ensure that your system meets the system requirements.
  • Ensure that you have already installed Git, Node.js, and npm.
  • For most platforms, you will need to have root and/or administrator privileges.

Install the connector for Windows

Download and run the installer

Go to Auth0 Dashboard > Authentication > Enterprise > Active Directory/LDAP, and select the connection you want to configure. In the Setup tab, select the Install For Windows button to download the latest installer, which is an MSI file. Run the installer and follow the instructions to install the AD/LDAP Connector as a Windows Service.
AD/LDAP Connector Services
Once the installation is complete, you will see a screen in a browser pointing to localhost:
AD/LDAP Connector Admin Ticket
Enter the TICKET URL provided when you provisioned the connection. The TICKET URL uniquely identifies this connector in Auth0. The Connector will use this to communicate with Auth0 Server and automatically complete the configuration. Enter the LDAP settings:
adldap-connector-admin-settings
Once you submit the above information, the connector will perform a series of tests to validate the information you entered. The results are displayed under Configuration Log in the console screen.
adldap-connector-admin-settings-ok
Make sure that all tests are green.

Install the connector for other platforms

  1. Download and install the latest version of the Auth0 Active Directory/LDAP Connector package to /tmp. To learn more, review the AD/LDAP Connector repository.
  2. Start your server. node server.jsWhen prompted for the ticket number, enter the full ticket URL from the Settings tab of the Setup AD/LDAP connector screen in the Auth0 Management Dashboard.
  3. You will be prompted to edit the config.json configuration file with your LDAP connection and authentication details:
  4. Run node server.js once more to start the Connector. Note that the LDAP_BIND_PASSWORD line in config.json changes to LDAP_BIND_CREDENTIALS at this point.
  5. Once the Connector is running, you will need to daemonize the Connector (if you don’t already have a tool selected, you can consider systemd). For example, for using systemd with Ubuntu Xenial, the file /lib/systemd/system/auth0-adldap.service could contain the following:
  6. Run node admin/server.js to access the admin UI. The admin UI will be running and available on http://localhost:8357.
If you get an Invalid Ticket message when configuring the Connector for the first time, the most likely cause is a network issue (for example, you have the Connector running behind a proxy).

Learn more