In This Article

Adding a new self-hosted configuration

Getting there

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

Navigating to the Manage Authentication page


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

Permissions

  • If you restrict connections to your self-hosted system, be sure to allow access for the LibAuth server's IP address. The address varies by region, as indicated below:
    • Asia-Pacific customers: au.libauth.com
    • Canadian customers: ca.libauth.com
    • European customers: eu.libauth.com
    • All other customers: us.libauth.com

Server Information

  • Obtain the URL to your self-hosted system. This is the URL where LibAuth should POST the data submitted via the login form.
    • These URLs must be secure. URLs beginning with http:// will not be accepted.
    • The script should accept two POST parameters (username and password) and return a result to indicate whether or not the authentication was successful.
    • LibAuth will send login data to your server via HTTPS. To maintain a secure transfer of data, we recommend that you provide an HTTPS server URL. 
  • Ask your IT staff what format of data your authentication system returns. LibAuth can accept a plain text message or JSON object (recommended).
    • We recommend the authentication return a JSON object like: {"firstname":"James","lastname":"Bond","email":"jbond@007.com","auth":true}
  • The text returned by your system's URL when the user passes authentication.
    • By default, LibAuth will look for +OK to indicate a successful authentication. Any other value will indicate that authentication failed.
    • If your system provides text other than +OK, then you will need to specify this in your LibAuth configuration.

Attributes

  • Obtain the attributes used for First Name, Last Name, and Email from your IT staff. 
Your mileage may vary: we understand that everyone's authentication system may be set up differently than what's considered standard. Because we can't anticipate all of the possible setup variations, your mileage may vary from what's covered in these guides. Please work closely with your IT staff and don't hesitate to contact Springy Support if you need any help!

Adding a self-hosted 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.
  2. Below the Search for Your Institution dropdown, click on the Manual Configuration link.
  3. Select SIP2 as your authentication protocol.
  4. Enter the URL for your self-hosted system provided by your IT staff. The URL must start with https://.
  5. For the Return Type, select the type of data being returned by your system (a text string or JSON object).
  6. If your system will return a message other than +OK for successful authentications, enter it in the Return Text field.
  7. 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.)
  8. Give your configuration a name.
  9. If you'd like, you can also provide notes or details about this configuration for your reference.
  10. Click the Save Configuration button.

Screenshot of the Add Configuration button

Clicking to set up a manual configuration

Example of adding a self-hosted configuration 

Related Articles