Skip to main content
Help Center

Changing Your Authentication Method

A library can begin with manually managed patron accounts and move to an automated authentication method later.

Changing authentication requires coordination with ePlatform Support and, depending on the selected method, your IT team or Library Management System provider.

When to change authentication methods

You may want to change your authentication method if:

  • your library currently maintains patron accounts manually;
  • your school has introduced a new Single Sign-On provider;
  • you want patrons to use their existing school or organisation credentials;
  • your Library Management System supports SIP2 or an API connection; or
  • your current authentication system is being replaced.

Many schools begin with a manual spreadsheet import so patrons can start borrowing while an automated connection is being considered or configured.

Available authentication options

Automated authentication options can include:

  • Single Sign-On using Google, Microsoft, SAML, or another supported provider;
  • LDAP or Active Directory;
  • SIP2 through a Library Management System; and
  • a supported Library Management System API.

The appropriate option depends on the systems used by your organisation and the connection details available from your IT team or system provider.

Before requesting a change

Before contacting ePlatform Support, confirm:

  • the authentication method your library currently uses;
  • the authentication method you want to use;
  • the name of your identity provider, directory, or Library Management System;
  • who from your IT team or system provider can assist with the setup;
  • which patron information the connected system can provide; and
  • which accounts can be used for testing.

Patron information

Confirm whether the new system can provide the patron information required by your library. Depending on your setup, this may include:

  • a unique patron identifier;
  • the patron’s name;
  • their role;
  • their class or form;
  • their year level; or
  • their date of birth.

If your library restricts titles by age or year level, the new connection must provide the relevant year-level or date-of-birth information.

Request the change

  1. Submit a support request or email support@eplatform.co.
  2. Include your library name.
  3. Identify your current authentication method.
  4. Identify the method and provider you want to use.
  5. Include the contact details of the staff member coordinating the setup.
  6. Provide the available connection information for the selected method.

ePlatform Support will advise which additional configuration details are required for your selected authentication method.

Connection information

The required information depends on the connection:

  • SAML SSO: Provider details, metadata, and the user attributes available through the connection.
  • LDAP: Directory server details and any required firewall configuration.
  • SIP2: Credentials, server address, and port supplied by your Library Management System provider.
  • Library system API: The API key, API secret, and endpoint URL supplied by the system provider.

Test the new authentication method

Test the new method with two or three accounts before providing new sign-in instructions to all patrons.

  1. Open your library’s ePlatform sign-in page.
  2. Select or use the newly configured authentication method.
  3. Sign in using the first test account.
  4. Confirm that the account reaches the correct ePlatform library.
  5. Confirm that the expected patron information is available.
  6. Borrow an available eBook or Audiobook.
  7. Open the title and confirm that reading or playback begins.
  8. Repeat the test with the remaining accounts.

If your library uses age or year-level restrictions, test accounts with different age or year-level information.

After testing

After the new authentication method has been tested successfully:

  • confirm the change with ePlatform Support;
  • provide patrons with the updated sign-in instructions;
  • update any internal guides or library launch material; and
  • monitor the first sign-in attempts for any reported problems.

Need help?

If the new authentication method does not work as expected, contact support@eplatform.co.

Include:

  • your library name;
  • the new authentication method;
  • the identity provider or Library Management System involved;
  • whether the problem affects one test account or every test account; and
  • the error message displayed, if any.