FAQ content

Adding a new OAuth 2 configuration to LibAuth

In this article

Getting there

To create and manage your LibAuth profiles, go to LibApps > Admin > LibAuth Authentication.

Navigating to the Manage Authentication page
LibApps admin-level users can access LibAuth settings via the LibApps dashboard, under Admin > LibAuth Authentication.

Before you begin

Before setting up your new OAuth 2configuration, you'll want to work with your IT staff on the following:

Permissions

  • We support the Access Code grant type for user logins.
  • When configuring your OAuth 2 application, use the following redirect URL for your region:
    • European customers: https://eu.libauth.com/login/oauth2
    • Canadian customers: https://ca.libauth.com/login/oauth2
    • All other customers: https://libauth.com/login/oauth2

Server Information

  • Obtain the Client Identifier and Client Secret from the OAuth 2 application you've set up to use with LibAuth.
  • Obtain the Authorization URL and Access Token URL endpoints for your OAuth 2 system.
  • Obtain the User Resource URL endpoint that returns user attributes for the specific logged in user.

Attributes

  • Obtain the attributes used for First Name, Last Name, Email, and User ID from your IT staff.

Add a new OAuth 2 configuration

  1. If you have not yet created a LibAuth configuration, skip to Step 2. Otherwise, click on the Add Configuration button to create another one.
Screenshot of the Add Configuration button
  1. Below the Search for Your Institution dropdown, click on the Manual Configuration link.
Clicking to set up a manual configuration
  1. Select OAuth 2 as your authentication protocol.
Selecting the OAuth 2 protocol
  1. Enter the server info and parameters provided by your IT staff.
    1. Client identifier: the client ID from your OAuth 2 application.
    2. Client secret: the client secret from your OAuth 2 application.
    3. Authorization URL: the authorization URL endpoint for your OAuth 2 system. This must start with https://.
    4. Access token URL: the access token URL endpoint for your OAuth 2 system. This must start with https://.
    5. User resource URL: the API endpoint that returns user attributes for the specific logged-in user. This must start with https://.
server info and parameters fields
  1. Configure the attributes released from your server.
    1. Enter the field name of the attribute that contains the user's first name. (Optional, but recommended.)
    2. Enter the field name of the attribute that contains the user's last name. (Optional, but recommended.)
    3. Enter the field name of the attribute that contains the user's email address. (Required.)
    4. Enter the name of the attribute that contains the user's user ID. (Optional, but recommended.)
attributes fields
  1. Give your configuration a name.
  2. If you'd like, you can also provide notes or details about this configuration for your reference.
  3. Click the Save Configuration button.
General fields & Save Configuration button