Skip to main content
ExLibris
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    SAML-Based Single Sign-On/Sign-Off

    Translatable
    To configure a SAML type of integration profile, you must have the following role:
    • General System Administrator

    Alma supports the SAML 2.0 Web Browser SSO profile. This enables Alma to exchange authentication and authorization information, allowing a user to sign in or out of an external system and be automatically signed in or out of Alma, or vice versa.

    Following Alma profile activation and third-party configuration, your your institution’s support staff changes the Alma login shortcut to the following URL (see Your Alma Domain Names): https://<Alma domain>/SAML.

    For a detailed overview of SAML-based SSO, see https://developers.exlibrisgroup.com/alma/integrations/user-management/authentication/inst_idp/saml.

    If your production server and the sandbox use the same SAML identity provider, Ex Libris recommends that you use the same authentication profile in both environments. In this case, no additional configuration of SAML is required on the sandbox after a sandbox refresh. If your production server and the sandbox use different SAML identity providers, see Recommended Configuration to Account for Sandbox Refresh for more information.
    To configure a SAML type of integration profile:
    1. On the Integration Profile List page (Administration > General Configuration > Configuration Menu > External Systems > Integration Profiles), select Add Integration Profile. The first page of the integration profile wizard appears.
    2. Enter a code and name for the integration profile.
    3. Select the SAML option from the "Integration Type" dropdown list.
    4. From the "System dropdown list", select the system to be used for authentication, such as 'Shibboleth'.
    5. Select Next. You are taken to the next page.

      SAML_Integration_Profile.png

      SAML Definitions

      On this page, enter the following information. 

      SAML Integration Profile page - Action tab
      Field Description

      Metadata Upload method

      You can populate the profile information from metadata. To do that, select the Metadata Link option and provide the location of the link in the Metadata file link field. To use a metadata upload, select the Metadata upload option and select the file in the Upload IdP metadata file field.

      Dynamic refreshing/URL monitoring is not currently supported. The Populate Profile option is solely for the convenience of the implementer. If your IdP signing certificate is about to change, please follow the steps detailed here to prevent loss of SAML login functionality.

      Metadata file link

      Default SAML profile

      Select to configure this profile as the default.

      To use a profile that is not the default, use the /SAML/idpCode/[profile code] suffix in the Alma URL.

      IdP Issuer

      If the profile was not automatically populated with metadata (in the above fields), enter the settings for the IDP issuer, IDP Login URL, User ID Location, User ID Attribute Name, IDP Logout URL, and IDP Single Logout Service, and Sign Single Logout Requests.

      For more information on these fields, see https://developers.exlibrisgroup.com/alma/integrations/user-management/authentication/inst_idp/saml.

      IdP Login URL
      IdP ID location
      User ID attribute name
      IdP logout URL
      IdP single logout service
      Sign single logout requests
      Apply SHA1 signature (Default SHA2) Select Apply SHA1 signature (Default SHA2) to change the signature of the profile to SHA1 (also called SHA128) signature, in order to sign the logout requests with this signature. 
      For profiles created after July 2020, the default is SHA2 (also called SHA256), but you can change that to SHA1, if needed. 
      For profiles existing before SHA2 was introduced in July 2020, the default is SHA1, but you can change that to SHA2, if needed.
      Alma metadata file version Select an Alma metadata file version. When creating a new profile, two options are available, the self-signed Version 20XX and Signed certificate. When editing an existing profile, three options are available, the self-signed Version 20XX, Signed certificate, and whichever certificate you were using previously. It is important to note the expiration date when choosing a certificate and make sure to replace it prior to that date  If you opt to use a previous certificate, Alma continues to accept it, even after the expiration date. If you edit an existing profile and select a new certificate, once you save the profile, the previous certificate becomes unavailable. Before changing your certificate, you must check with your IT department.
      IdP Certificate 1 / 2

      New for June! Alma enables holding two certificates simultaneously and tries to authenticate using both certificates. This is useful when a SAML IdP changes their certificate (for security reasons). The certificate needs to be updated on the integration profile. Holding two certificates simultaneously allows the institution to add the new certificate ahead of time, without removing the old certificate until after the IDP has made the switch. Holding only one certificate can cause downtime if the certificate is not updated at the same time on both systems, since then Alma does not trust the response from the IDP  that was signed with the "wrong" certificate.

      The certificates are cyclic: adding a 3rd certificate removes the 1st certificate, and the new certificate becomes the 2nd). Uploading a second certificate is not mandatory. 

      For each certificate, in Certificate upload method, select the type of certificate to upload (see https://developers.exlibrisgroup.com/alma/integrations/user-management/authentication/inst_idp/saml). Alma accepts file uploads, free-text certificate entry, or JKS files. If JKS file or Free-text certificate file is selected, a field will be displayed to select the file from the user's file system. If Free-text certificate is selected, a field is displayed to accept the text of the certificate. A note beside the field indicates if a certificate has already been uploaded.

      As of January 1, 2017, Alma no longer supports certificates using the MD5withRSA encryption algorithm. For more information, see https://blogs.oracle.com/java-platform-group/entry/strengthening_signatures.

      Active When an authenticated SAML user logs in that does not have an existing Alma user, if you want a new Alma user to be automatically created, select Active in the Self Registration section.
      1. Enter the User Group, Resource Sharing Library, and Statistical Category that you want to have assigned to the automatically created user.
      2. You can also define the mapping of SAML attributes to their corresponding user fields in Alma by selecting the Mapping of assertion fields to Alma fields link.
        1. Enter the Alma field name in the Code field. Enter the SAML assertion code in the Description.
        2. Select Customize.
      User Group
      Resource Sharing library
      Statistical Category
      Update user upon login
      Recreate user roles upon login
      Mapping of assertion fields to Alma fields
      XSL configuration file
    6. Select Save.

    Testing Authentication on SAML Integration Profile

    You can test your SAML integration directly from the SAML configuration page. This removes the need to log out from Alma and log in again, and if the authentication fails, provides a clear indication of what went wrong. 

    To test authentication on SAML integration profile:
    1. Once you filled in all the relevant information on the SAML integration profile, click the "Test" button. A popup window opens. 
    2. In the popup window, select the product from the list of your institution's available products. This generates a test link to the IdP set in the integration profile. 
      If you work with bc.alma and want to configure the same domain – log in to na03.alma instead.
      Authentication test tool.png
    3. Copy this link and paste it to a different browser (or, if you are working with Chrome, to an Incognito tab). Your SAML login page opens. 
    4. Submit your credentials. You are redirected to a new page showing the authentication result and additional messages explaining what went on and possibly what went wrong. 
      The credentials are used only for the test and do not actually log in the user whose credentials were entered here.
      Authentication test tool - results.png
    5. Close the test window and return to Alma. If needed, update the integration profile/IdP and test again. If no changes are necessary, save the profile. 

    Replacing a Signed Certificate

    If you need to replace your Signed Certificate, you must do it with both Alma and Primo VE, in coordination with your IDP.

    Send the certificate file to your IT department along with the new metadata that is produced by selecting the appropriate link below (inserting your university's base Alma or Primo VE URL in place of <ALMA_VE_BASE_URL>):

    https://<ALMA_VE_BASE_URL>/view/saml/metadata?VERSION=VERSION_2025_NEW (2025 self signed)

    https://<ALMA_VE_BASE_URL>/view/saml/metadata?VERSION=SIGNED_2021 (Jan 2021 DigiCert)

    Make note of the date and time that the IDP will switch the certificate. As close as possible to that time, follow the process detailed in Alma Metadata file version above to select the new certificate in the integration profile.

    When either the institution or the IDP upgrades their certificate, the login will not work until the other switches over as well. This is why it is important to note when the IDP is switching over to minimize the down time.

    Replacing an IdP Signing Certificate

    New for June! This section is relevant only if your institution holds only one certificate in the "IdP Certificate 1 / 2" section of the integration profile. If both certificates were uploaded, then holding two certificates simultaneously allows the institution to add the new certificate ahead of time, without removing the old certificate until after the IDP has made the switch, and you can ignore the information below. 

    If the IdP signing certificate on your Alma SAML profile is about to change, upload the new certificate using one of the three supported methods:

    • Free-text certificate,
    • Certificate file,
    • JKS file. JKS is required for chain of trust certificates.

    Make sure to perform this change and click Save at the same time that the IdP switches over to the new certificate. Otherwise, SAML authentication will fail during the interval.

    Switching to a newer signing certificate automatically, without updating the SAML profile in Alma, might cause a system-down.

    • Was this article helpful?