Enable SAML for users and set up SSO login screen

Overview

Once single sign-on (SSO) is enabled, users and admins must be set up to use SAML for authentication.

Enable SAML for users

Once SSO is enabled, you can update these details using the SAML token:

  1. Aptem login description
  2. Login description note
  3. Identity providers

SAML token showing the Aptem login description, login description note and identity providers

Configuration options

You can change these options using any of the following:

  • Aptem user interface: enable SSO for each user manually.
  • CSV upload: include the fields Username, Email and SSO Enabled.
  • API: use Aptem's API for bulk updates.

Method 1: Aptem user interface

Go to the account programme and select the SAML settings token.

SAML settings token in the account programme

Enable the SAML programme component in the account programme.

Choose your identity provider from the dropdown list, or select Add more to create a new SAML login method. A tab with the name you give it is created.

When the SAML component is enabled, a Sign in using <Identity Provider Title> button appears on the sign-in page, under the standard Sign in widget. Selecting it redirects to the SAML authentication form, so registered users can sign in with their SAML account.

You can change the Aptem login description and the Identity providers. You can also define who SSO is allowed for.

SAML settings showing the Aptem login description and identity providers

On the detailed SAML settings tab on the right, you can change the Login description note.

Detailed SAML settings tab showing the login description note and IdP fields

  • Login description: text shown on the login page near the SAML button.
  • IdP Sign on URL: the URL used to send AuthRequests to the identity provider.
  • IdP Log out URL: the URL used to send LogoutRequests.
  • IdP provider certificate: the identity provider's public certificate, used to verify signatures on messages it sends.

User-level set up

Once SSO is enabled, you can change the authentication type for individual users.

When you create learners and admins, specify the Authentication type, SAML Identity provider and SAML unique id on the Create user and Create Admin pages in Aptem Classic. These are also in the Learner details section in Aptem Console. This lets users authenticate with Simple SAML and Azure AD accounts.

Authentication type, SAML Identity provider and SAML unique id fields on the Create user page

Note: for SSO, Aptem passes the user's SAML unique ID, not their username. Make sure it matches the user's email address in their identity provider exactly. Because SSO relies on the SAML unique ID, changing a user's username doesn't affect how they sign in. If the SAML unique ID is blank or doesn't match, the user sees "username or password not recognised". See Error messages.

Method 2: CSV upload

To enable SSO by CSV upload, go to the Users Overview tile and select Upload Users. Include these fields in your CSV file:

  • Username
  • Email
  • SSO Enabled

Method 3: Use Aptem's API

You can also use the Aptem API to enable SAML and set up the SSO login screen. Include these fields in the payload:

{
"authType": "SAML",
"idP": "Azure AD/Simple SAML",
"samlUserId": "student**"
}

SSO login screen

Users see a different screen when they log in, depending on the authentication type you select.

SSO login screen showing the Sign in using identity provider button

Notes

  • SSO isn't restricted to the provider organisation's email domain. It can be enabled for learners and admins with different email addresses.
  • SSO can be enabled for multiple organisations in one tenant, for example a consortium where one main provider has several providers under it.
  • Users with SSO can't change their password in Aptem.
  • Multi-factor authentication (MFA) doesn't work with SSO. MFA stops once SSO is enabled for a user.
Was this article helpful?
0 out of 1 found this helpful