Set up OpenAthens Single-Sign On (SSO)

This guide provides all you need to know about configuring and testing your OpenAthens single sign-on (SSO) integration with Perlego.

Included: Enhanced, Ultimate
Add-on required: Essentials
Read more about plans and add-ons.

Table of Contents

  1. Configuration
    1. Share your entity ID
    2. Attribute release
  2. Testing

Configuration

Before you start the configuration make sure:

    • Your organisation is on the Enhanced or Ultimate plan OR you have purchased the SSO integration as an add-on.
    • You have access to the OpenAthens admin portal.
    • You have an OpenAthens account you can test with (this might be the same email address as your admin account).

Share your entity ID

You’ll need to tell us your OpenAthens IdP Entity ID, which can be found at https://login.openathens.net/org-list.

Send us your Entity ID by completing the Single Sign-On set up form.

Attribute release

We’ll let you know when SSO has been added to your account. The next step will be to release the required attributes.

You must release the following OpenAthens attributes (or the metadata attributes listed for Shibboleth).

Attribute Perlego account field
forenames First name
surname Last name
emailAddress Email

Documentation on the attributes can be found in OpenAthens support guides, including instructions for releasing them to the Perlego application.

Here’s a quick guide to the attribute release:

  1. Login to the OpenAthens admin portal.
  2. Go to the Preferences tab and select Attribute Release.
  3. Click on the Add as resource policy button, and search for Perlego.
  4. Under the Perlego resource, select the First Name(s), Last Name and Email Address options.
  5. Click Done.

Untitled (14)

Testing

Once you have released the attributes you are ready to test your SSO login. You’ll need an access link for your account.

  • Open the access link and accept the terms and conditions.
  • Click Create your account.
  • You’ll be re-directed to your OpenAthens authentication page.
  • Enter the OpenAthens credentials for your test account. The email must exist within your OpenAthens accounts.
  • Once entered you’ll be logged in to Perlego.

You can always check the account has been added by logging in as an Admin user.