Child pages
  • LDAP_Servers
Skip to end of metadata
Go to start of metadata

Introduction

Open-AudIT can be configured to use LDAP servers (Microsoft Active Directory and/or OpenLDAP) to authenticate a user and in addition, to create a user account using assigned roles and orgs based on LDAP group membership.

How Does it Work?

If using Active Directory, you do not need to populate the user_dn or user_membership_attribute attributes. These are used by OpenLDAP only.
If the user logging on to Open-AudIT does not have the access to search LDAP, you can use another account which does have this access. Use the dn_account and dn_password to configure this.

Examples:

If you need to configure OpenLDAP access for your users and a given users access DN is normally uid=username@domain,cn=People,dc=your,dc=domain,dc=com then you should set base_dn to dc=your,dc=domain,dc=com and user_dn to uid=@username@@domain,cn=People. The special words @username and @domain will be replaced by the login details provided by your user on the login page.

If you need to configure Active Directory access, you can usually use the example of cn=Users,dc=your,dc=domain,dc=com for your base_dn. here is no need to set user_dn.

These are only examples. You may need to ajust these attributes to suit your particular LDAP.

Creating a LDAP Server Entry

A LDAP Server can be created using the web interface if a user has a role that contains the ldap_servers::create permission. Go to menu: Admin -> Ldap Servers-> Create Ldap Server. There is also a create button on the collection page.

 

 

View a LDAP Server Details

Go to menu:  Admin -> Ldap Servers-> List Ldap Servers.

You will see a list of Ldap Servers. You can view the details of a Ldap Server by clicking on the blue view icon.

You can also edit or delete the entry.

 

 

Database Schema

The schema for the database is below. It can also be found in the application if the user has database::read permission by going to menu: Manage -> Database -> List Database, then clicking on the "ldap_servers" table.

A typical entry looks as below.

API / Web Access

You can access the /ldap_servers collection using the normal Open-AudIT JSON based API. Just like any other collection. Please see the API documentation for further details.

Access is provided as part of a roles permissions. Ldap Servers is a standard resource and can have create, read, update and delete permissions.

The API routes below are usable from both a JSON Restful API and the web interface. The Web application routes are specifically designed to be called from the web interface (a browser).

API Routes

Request Method
ID
Action
Resulting Function
Permission Required
URL Example
Notes
Example Response
POSTn createldap_servers::create/ldap_serversInsert a new ldap server entry. 
GETy readldap_servers::read/ldap_servers/{id}Returns a ldap server details. 
PATCHy updateldap_servers::update/ldap_servers/{id}Update an attribute of a ldap server entry. 
DELETEy deleteldap_servers::delete/ldap_servers/{id}Delete a ldap server entry. 
GETn collectionldap_servers::read/ldap_serversReturns a list of ldap servers. 
POSTnimportimportldap_servers::create/ldap_servers/importImport multiple ldap servers using a CSV. 

Web Application Routes

Request Method
ID
Action
Resulting Function
Permission Required
URL Example
Notes
GETncreatecreate_formldap_servers::create/ldap_servers/createDisplays a standard web form for submission to POST /ldap_servers.
GETyupdateupdate_formldap_servers::update/ldap_servers/{id}/updateShow the ldap server details with the option to update attributes using PATCH to /ldap_servers/{id}
GETnimportimport_formldap_servers::create/ldap_servers/importDisplays a standard web form for submission to POST /ldap_servers/import.

 

 

 

  • No labels