Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

To integrate customer LDAP (active directory) with OpenSpecimen, one needs to register LDAP with OpenSpecimen. OpenSpecimen needs the below config parameters to communicate with LDAPfollowing details are required:
  • LDAP/Directory URL
  • Bind user and password
  • User search base
  • User search filter

LDAP directory can be configured using UI(v6.1 onwards) or API. One Users can configure one or more LDAPs LDAP directories at the same time. Once configured, the LDAPs The LDAP directory names will appear on the login and sign up page as a dropdown.

Configure the LDAP Directory via UI

Super admins can configure LDAP directory via UI (v6.1 onwards) by going navigating to Extras from the home page. 

...

Click on 'Identity Providers' and create a new entry for registering to your LDAP directory. Select the type as LDAP and fill all required details

...

Once created, the list of all LDAPs LDAP directories registered are displayed and can be updated if required.

...

Item
Description
Host URL

LDAP directory URLs have this syntax: ldap[s]://<hostname>:<port>


ComponentDescription
ldap[s]://URL begins with the ldap:// protocol prefix (or ldaps://, if the server is communicating over an SSL connection) and specifies a search request to be sent to an LDAP server.
<hostname>Name of the LDAP server. Eg. ldap.forumsys.com
<port>

Port number of LDAP server. Eg. 696

If the port number is not specified, the standard LDAP port 389 is used.

Eg. ldap://ldap.forumsys.com:389


Bind DN

This is required for authenticating to the directory. Eg. "cn=read-only-admin,ou=users,dc=example,dc=com"

Password

Password of the Bind DN user.

Search Base

User search base, from where the search will be started. It might be an empty string like "" or "ou=People".

If Oracle DBMS is used, then an empty string is treated as null, which will fail LDAP authentication. Therefore it is advised to specify the base node from which the search needs to be carried.

Eg.

Code Block
Suppose users are resided in following directory:
  1. ou=others,dc=example,dc=com
  2. ou=users,dc=example,dc=com
  3. ou=people,dc-example,dc=com
 
url - ldap://ldap.forumsys.com:389
SearchFilter - "(uid={0})" or "(sAMAccountName={0})"
SearchBase - ""
Search will start from "dc=example, dc=com", It will search user in all the sub directories.
 
OR

url - ldap://ldap.forumsys.com:389
SearchFilter - "(uid={0})" or "(sAMAccountName={0})"
SearchBase - "ou=people"
Search will start from "ou=people,dc=example,dc=com". It will search user only in ou=people.


Search FilterSearch user using an attribute. Eg. "(uid={0})" or in case of active directory "(sAMAccountName={0})"

...