Single Sign-On (SSO) into Moodle using Keycloak as IDP

SAML Single Sign-On (SSO) for your Moodle site can be achieved using our miniOrange SAML SSO plugin. Our plugin is compatible with all the SAML compliant Identity providers. Here we will go through a step-by-step guide to configure Single Sign-On (SSO) between Keycloak as Identity Provider (IdP) and Moodle as Service Provider (SP).

miniorange img Pre-requisites : Download And Installation

To configure Keycloak as IdP with Moodle, you will need to install the miniOrange SAML 2.0 SSO plugin:

miniOrange SAML 2.0 SSO

SSO Single Sign On to Moodle with Azure, Azure B2C, Okta, ADFS, Keycloak, Onelogin, Gsuite, Shibboleth & many SAML IdPs [24/7 SUPPORT]

Tested with 3.10.1

Get this plugin

Step 1: Configure Keycloak as IDP

Follow the steps below to configure Keyclock as an Identity Provider

miniorange img Setup IDP

In theminiOrange SAML 2.0 SSO plugin, navigate to Service Provider Metadata tab. Here, you can find the SP metadata such as SP Entity ID and ACS (AssertionConsumerService) URL which are required to configure the Identity Provider.

In your Keycloak admin console, select the realm that you want to use.
Click on Clients from the left menu and then click on Create button to create a new client/application.

SAML Single Sign-On (SSO) using JBoss Keycloak as Identity Provider (IdP),SAML 2.0 JBoss Keycloak Login - Creating an APP

Enter Client ID as the SP-EntityID / Issuer from the Service Provider Metadata and select SAML as the Client Protocol.

SAML Single Sign-On (SSO) using JBoss Keycloak as Identity Provider (IdP),SAML 2.0 JBoss Keycloak Login - Add Client

Now click on Save.
Configure the following in Keycloak:

Client ID	The SP-EntityID / Issuer from the plugin's Service Provider Metadata tab
Name	Provide a name for this client
Description	Provide a description
Name ID Format	Email
Root URL	Leave empty or Base URL of Service Provider
Valid Redirect URIs	The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab

SAML Single Sign-On (SSO) using JBoss Keycloak as Identity Provider (IdP),SAML 2.0 JBoss Keycloak Login - Settings

Under Fine Grain SAML Endpoint Configuration, configure the following:

Assertion Consumer Service POST Binding URL	The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab
Logout Service Redirect Binding URL (Optional)	The Single Logout URL from the plugin's Service Provider Metadata tab

SAML Single Sign-On (SSO) using JBoss Keycloak as IdP,SAML 2.0 JBoss Keycloak Login SAML Endpoint Configuration

Click on Save.

Add Mappers

Go to Mappers tab and click on Create button.

SAML Single Sign-On (SSO) using JBoss Keycloak as Identity Provider (IdP),SAML 2.0 JBoss Keycloak Login - Mappers Tab

In Create Protocol Mapper enter the details as given below.

Client ID	The SP-EntityID / Issuer from the plugin's Service Provider Metadata tab
Name	Username
Mapper Type	User Attribute
SAML Attribute Name	username
SAML Attribute NameFormat	Basic

Click On Save.
Click on Add Builtin button.

Check the boxes of X500 givenName, X500 surname and X500 email attributes.

SAML Single Sign-On (SSO) using JBoss Keycloak as Identity Provider (IdP),SAML 2.0 JBoss Keycloak Login - Add buitl-in protocol mapper

Click on Add Selected button. You will see the mappings as shown in the photo below.

SAML Single Sign-On (SSO) using JBoss Keycloak as Identity Provider (IdP),SAML 2.0 JBoss Keycloak Login - Add Selected

miniorange img Download setup file

Go to Realm Settings, click on SAML 2.0 Identity Provider Metadata mentioned as endpoints in the General Tab.

Note the URL and keep it handy. Here you can find the information which will be used to configure the plugin.

Step 2: Configuring Moodle site as Service Provider

We will go through the steps to setup Moodle as a Service Provider. Here, we will be adding the IdP metadata to configure the plugin.

Free
Premium

Free

In the miniOrange SAML SSO plugin, go to the Service Provider Setup tab of the plugin. There are two ways to configure the plugin:

A. By uploading IDP metadata:

Click on the Upload IDP metadata button.
Enter the Identity Provider Name.
You can copy and paste the IdP metadata XML file and click on the Upload Metadata button or use a metadata URL and click on Fetch Metadata.

B.Manual Configuration:

Provide the required settings (i.e. Identity Provider Name, IdP Entity ID or Issuer, SAML Login URL, X.509 Certificate) as provided by your Identity Provider.
Click on the Save button to save your configuration.

Step 3: Attribute Mapping

When the user performs SSO, the NameID value is sent by the Identity Provider. This value is unique for every user.
To assign by which attribute value the user should authenticate or create, select Email (default) or Username in Login/Create Moodle account by:
For the plugin to access these attributes, assign the values for Email and Username as 'NameID' (without quotes).
Click on the Save button to save your configuration.

Step 4: Role Mapping

In the free plugin, you can choose a default role that will be assigned to all the non-admin users when they perform SSO. [NOTE: Roles will be assigned to new users created by SSO. Existing Moodle users’ roles will not be affected.]
Go to the Attribute/Role Mapping tab and navigate to the Role Mapping section.
Select the Default Role and click on the Save button to save your configuration.

Step 5: SSO Settings

In the plugin, you can add a login widget to enable SP-Initiated SSO on your site.
Go to the Plugins >> Authentication >> Manage authentication.
Click on the to enable the plugin visibility.
Click on the ⬆ to set plugin preference.

Premium

In the miniOrange SAML SSO plugin, go to the Service Provider Setup tab of the plugin. There are two ways to configure the plugin:

A. By uploading IDP metadata:

Click on Upload IDP metadata button.
Enter the Identity Provider Name
You can copy and past IdP metadata XML file and click on Upload Metadata button or use a metadata URL and click on Fetch Metadata.

B.Manual Configuration:

Provide the required settings (i.e. Identity Provider Name, IdP Entity ID or Issuer, SAML Login URL, X.509 Certificate) as provided by your Identity Provider.
Click on the Save button to save your configuration.

Step 3: Attribute Mapping

When the user performs SSO, the NameID value is sent by the Identity Provider. This value is unique for every user.
To assign by which attribute value user should authenticate or create select Email or Username in Login/Create Moodle account by:
For the plugin to access these attribute assign the Email and Username attribute.
Addtionally user attributes can be mapped (such as Firstname and Lastname).
Click on the Save button to save your configuration.

Step 4: Custom Attribute Mapping:

This feature allows you to map custom attribute sent by the IDP to the Moodle attributes.
You can add multiple attributes by click on "+" button.
Click on the Save button to save your configurations.

Step 5: Role Mapping

This feature allows you to assign and manage roles of the users when they perform SSO. Along with the default Moodle roles, this is compatible with any custom roles as well.
Group/Role attribute will provide a mapping for the field name which contains role-related information sent by the IDP and will be used for Role Mapping.
Navigate to role mapping section and provide the mappings for the respective roles.
For example, If you have a user whose Group/Role attribute value is idp-teacher and you want to assign it to the teacher group then, just provide idp-teacher in the Teacher: field of Role mapping section.
Click on the Save button to save your configurations.

Step 6: SSO settings

In the plugin you can add a login widget to enable SP-Initiated SSO on your site.
Click on Click here link which will redirect to the Manage authentication menu

Click on the to enable the plugin visibility.
Click on the ⬆ to set plugin preference.

To enable auto-redirect from Moodle login page to WordPress site .
Click on the Enable Auto-redirect to IDP from Moodle login page.
Note down Backdoor URL it will be useful when SSO fails.
Click on the Save button to save your configuration.

Pre-requisitesDownload And Installation
Step 1Configure Keycloak as an IdP
Step 2Configure Moodle as SP

If you are looking for anything which you cannot find, please drop us an email on samlsupport@xecurify.com

Guide to Configure Single Sign-On (SSO) between Keycloak as IDP and Moodle as SP

Step 1: Configure Keycloak as IDP

Step 2: Configuring Moodle site as Service Provider

Free

Step 3: Attribute Mapping

Step 4: Role Mapping

Step 5: SSO Settings

Premium

Step 3: Attribute Mapping

Step 4: Custom Attribute Mapping:

Step 5: Role Mapping

Step 6: SSO settings

Contents

STAY CONNECTED

Product

Solutions

Why miniorange

Company