What's a federation, you ask? A federation provides a common shared framework for providing access to online resources. They use a standard set of metadata and attributes, which make setting up LibAuth a breeze.
Before you begin
Before setting up your new LibAuth configuration, you'll want to work with your IT staff on the following:
- Only if your site does not automatically add InCommon service providers (see the InCommon Federation Technical Guide for more info), your IT staff will need to add Springshare as an authorized service provider using the appropriate Entity ID for your region. You will find a link to the Entity ID at the top of the Configuration tab after creating your new LibAuth configuration.
- You'll need to know the entityID of your SAML configuration.
- If you want to set up optional group permissions, you'll need to know the names of certain attributes (such as status or department), along with their possible values.
- For example, if you have an attribute for "Department", you'll want to know the names of the departments that you can pick from.
- This will allow you to create group permissions so you can restrict access to things by department.
LibApps Admin users can add and manage new configurations by going to LibApps > Admin > LibAuth Authentication.
Adding a new configuration for InCommon or UK Federation members
From the Admin > LibAuth Authentication page in LibApps:
- If you have not yet created a LibAuth configuration, skip to Step 2. Otherwise, click on the Add Configuration button to create another one.
- From the Search for Your Institution dropdown, select your institution from the list.
- Click the Save button to continue. The correct Server Info, Parameters, and Attributes will automatically be filled in for you.
- Optionally, you can edit your configuration to review and change any info, as well as enable additional features such as LibApps Login.
- If your institution has a custom logout URL, you can enter it under Server Info & Parameters. All other server info and attributes will be prefilled for you.
- Under General, give your configuration a name.
- If you'd like, you can also provide notes or details about this configuration for your reference.
- Click the Save Configuration button.
- Learn how to add group permission rules to your new configuration.
- Learn how to allow users to log in to LibApps with this configuration.
- This gives you the option to only allow users to log in via your SSO.
- Learn how to test and troubleshoot your InCommon or UK Federation configuration.