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


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 OpenAM as Identity Provider (IdP) and Moodle as Service Provider (SP).

miniorange img Pre-requisites : Download And Installation

To configure OpenAM 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

Step 1: Setup OpenAM as Identity Provider

All the information required to configure OpenAM as IdP i.e. plugin’s metadata is given in the Service Provider Metadata tab of the miniOrange plugin.

miniorange img  Create OpenAM as a Hosted Identity Provider
  • In the miniOrange 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.
  • moodle saml upload metadata
  • Login to the OpenAM admin console.
  • From the REALMS page, select the realm under which you want to create the SAML application. You will be redirected to the Realm overview page.
  • Click on Create SAMLv2 Providers in the Realm Overview page.

    SAML Single Sign-On (SSO) using OpenAM Identity Provider (IdP), Create SAMLv2 provider
  • Click on Create Hosted Identity Provider. You will be redirected to the configuration page.

    SAML Single Sign-On (SSO) using OpenAM Identity Provider (IdP), Create Hosted Identity Provider
  • Configure SAML IDP as given below:

    • Name: Name of the SAML IDP
    • Signing Key: Select the Signing key from the dropdown.
    • New Circle of Trust: Provide a name of the groups of IDP and SP that trust each other.
    • Attribute Mapping: Configure user profile attributes to be sent to the Service Provider application.

    • SAML Single Sign-On (SSO) using OpenAM Identity Provider (IdP), Add Metadata and Attribute mapping
  • Click on the Configure button on the top right corner.
  • SAML Single Sign-On (SSO) using OpenAM Identity Provider (IdP),Create SAMLv2 IdP on server
miniorange img  Configure Remote Service Provider
  • Go to OpenAM admin dashboard and open Realm Overview page.
  • Click on Create SAMLv2 Providers.

    SAML Single Sign-On (SSO) using OpenAM Identity Provider (IdP),Configure remote service provider SAMLv2
  • Now click on Register Remote Service Provider. You will be redirected to the configuration page.

    SAML Single Sign-On (SSO) using OpenAM Identity Provider (IdP),Register Remote Service Provider
  • Configure the Service Provider as given below:

    • Where does the metadata file reside: URL
    • URL of metadata: Paste the miniOrange plugin’s Metadata URL here. You can get it from the Service Provider Metadata tab
    • Circle of Trust: Add to existing
    • Existing Circle of Trust: Select the Circle of Trust (group) in which your hosted IDP is located
    • Attribute Mapping: Configure user profile attributes for mapping.

      SAML Single Sign-On (SSO) using OpenAM Identity Provider (IdP), Click ok after verifying IDP and SP from federation
  • Click on the Configure button on the top right corner and then click on OK button.
  • OpenAM sso-6
  • Verify the configuration of IdP and SP from the Federation tab of OpenAM.
  • You can download the OpenAM IdP metadata using the URL given below.
    • For Single Realm: [OpenAM ServerURL]/saml2/jsp/exportmetadata.jsp
    • For Multiple realms:
      [OpenAM ServerURL]/saml2/jsp/exportmetadata.jsp?entityid=[IdPentityID]&realm=/realmname
  • Keep the IDP Metadata handy as it will be used in configuring the miniOrange 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.




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.
  • wordpress saml upload 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.
  • wordpress saml upload metadata

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.
  • wordpress saml attribute mapping

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.
  • wordpress saml role mapping

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.
  • wordpress saml role mapping


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.
  • wordpress saml upload 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.
  • wordpress saml upload metadata

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.
  • wordpress saml attribute mapping

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.
  • wordpress saml custom attribute mapping

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.
  • wordpress saml role mapping

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
  • wordpress saml role mapping
  • Click on the to enable the plugin visibility.
  • Click on the ⬆ to set plugin preference.
  • wordpress saml role mapping
  • 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.
  • moodle saml role mapping


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

Hello there!

Need Help? We are right here!

support
Contact miniOrange Support
success

Thanks for your inquiry.

If you dont hear from us within 24 hours, please feel free to send a follow up email to info@xecurify.com