Versions Compared


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

OpenAthens can connect directly to an LDAP server so that you do not have to issue accounts yourself. Anything that uses standard LDAP protocols is acceptable e.g. ActiveDirectory and OpenLDAP.

To connect your LDAP:


so this works with ActiveDirectory too.

As well as the ability to use local accounts instead of maintaining a separate set of credentials, accesses to federated resources that already involve discovery (identifying the users' home organisation) will take the user directly to your LDAP login at our authentication point - no further discovery is required.


Before you start you will need:

  • An LDAP server that can be connected to queried from outside of your network.
    • If this is not possible, you should stop now and consider an ADFS connection might be what you need instead.
  • A member of your IT team to supply or enter the connection details.
  • A copy of your LDAP server's certificate (base 64 encoded X.509, often called pem format).

Add the connection

In the administration interface go to Management > Connections

  1. Click the add button on the left and select LDAP

  2. Have your colleague from the IT team complete the form and click add at the bottom.

  3. At this point the status panel will probably show failures for connection and bind:

  4. Switch to the certificate tab and paste in the contents of the certificate file which should look like similar to this:

    Code Block
    -----END CERTIFICATE-----
  5. . This will be converted to a summary panel:

  6. Save changes

  7. At this point the status panel will update and should now show success if it did not before

  8. You should be able to use the test authentication button now with your own username and password.




The name of the connection as it will appear to users at our authentication point. This should be a form of your organisation name so users can find it in a list if when they need to.

Directory type

Used to set default values where Active Directory is different from the underlying LDAP standard.

Server host

The address where OpenAthens can connect to your server. This address will need to be accessible by our services from outside of your network.

Server port

The port that your server uses for LDAP traffic. You can specify a non-standard port if necessary.

Connection type

The form of security used. StartTLS is the industry standard but ldaps:// can be chosen for older systems.

Admin bind DN

The full distinguished name of a user that can connect and view all the users you need to authenticate, e.g:


Bind password

The password for the user specified in the admin bind

Base DN

The distinguished name of your directory, e.g:



Allows you to specify the username field, plus limitations where necessary. The field you identify as =${uid} will be the user identifier in statistics reports

Live & visible = production ready. Users will be able to access this login at the authentication point. It will become the default login whenever your organisation is known (e.g. for any resources where access involves your entityID).

Live and not visible = testing mode. Will work with a crafted test URL, but the authentication point will only use OpenAthens accounts.

Not live = cannot be used. The visibility setting is ignored.

Changes to the status can take up to PLACEHOLDER-TIME to go live.