This space contains the old OpenAthens SP documentation and is no longer maintained.
OpenAthens SP software is already out of support and reached end of life in May 2020.

Check out OpenAthens Keystone instead. It's supercool and makes dealing with SAML much easier.


Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »




  • A server running Java
  • Server time synced with NTP or equivalent
  • Familiarity with your chosen platform
  • The username and password you use to access the publisher dashboard. PLACEHOLDER - LINK
  • Access to the publisher dashboard. PLACEHOLDER - LINK


  1. Install OpenAthens software

    1. The recommended method is to use our Maven repository. You can also download the software from Both will use the same OpenAthens credentials as the publisher dashboard.

      Add to your settings.xml file


      For information on how Maven encrypts and uses server passwords, see


      Add to your pom.xml file


      The id must match your .m2/setting.xml file and be 'eduserv'


    2. If you have installed from a downloaded zip file instead, check that the files have been placed in the correct location.

  2. Create metadata keys

    1. Linux

    2. Windows

  3. If you have not already done so, create an application in the publisher dashboard. PLACEHOLDER LINK


    1. Linux

    2. Windows

  5. Configure your web.xml file. The publisher dashboard will have  generated a configuration to copy and paste. In the file you will also need to:

    1. Update the protected location to cover your application.

    2. Restart your web server to download the configuration from the publisher dashboard and start using it.


  • No labels