Umbraco SAML Single Sign-On (SSO) using Azure AD as IDP


Umbraco SAML Single Sign-On (SSO) plugin gives the ability to enable SAML Single Sign-On for your Umbraco applications. Using Single Sign-On you can use only one password to access your Umbraco application and services. 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 Umbraco and Azure AD considering Azure AD as IdP. To know more about the features we provide for Umbraco SSO, click here.

Select your umbraco version to configure SSO with:

Pre-requisites : Download And Installation

  • Download Umbraco SAML Single Sign-On (SSO) module.
  • For Setting up the module, extract the umbraco-saml-sso-connector.zip, you will find a DLL file miniorange-saml-sso.dll, a configuration file saml.config and a integration.md file which contain the steps for adding the module into your application.

1. Add module in Umbraco Application

  • Add miniorange-saml-sso.dll in the bin folder (where your other DLL files exist) for your Umbraco site.
  • Register miniorangesamlsso module for your umbraco SSO according to the provided steps in the integration.md file.
  • Add the provided configuration file saml.config in the root directory for your umbraco site.
  • After integration open browser and browse the module dashboard with URL below:
    https://<umbraco-base-url>/?ssoaction=config
  • If it pops up the registration page or login page, you have successfully added the miniOrange saml sso module for your application.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP - Login Page
  • Register or Login for configuring the module.
  • Add the reference miniorange-saml-sso.dll file in your Umbraco application:
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP - Add miniOrange DLL file
  • Add the miniOrange-sso-configuration file in your Umbraco application.
  • In the Startup.cs file:
    • Add the namespace miniOrange.samlusing miniOrange.saml;
    • Update the Umbraco middleware snippet lines in Startup.Configure method as below:
    • app.UseUmbraco()
          .WithMiddleware(u => {
              u.UseBackOffice();
              u.UseWebsite();
              u.AppBuilder.UseminiOrangeSAMLSSOMiddleware();
          })
          .WithEndpoints(u => {
              u.UseInstallerEndpoints();
              u.UseBackOfficeEndpoints();
              u.UseWebsiteEndpoints();
          });
  • Run the application when the configuration is done.
  • After integration, open your browser and browse the plugin dashboard with the URL below:
  • https://<umbraco-application-base-url>/?ssoaction=config
  • If the registration page or login page pops up, you have successfully added the miniOrange Umbraco SAML middleware in your Umbraco application.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP - ASP.NET login page
  • Register or log in with your account by clicking the Register button to configure the plugin

2. Configure Azure AD as IDP

There are below two ways with which you can get the SAML SP metadata to configure on your Azure AD end.

A] Using SAML metadata URL or metadata file:
  • Under the Service Provider Settings section, you can find the metadata URL as well as the option to download the SAML metadata
  • Copy metadata URL or download metadata file to configure the same on your Azure AD end.
  • You can refer to the below screenshot:

    Umbraco Single Sign-On (SSO) using Azure AD as IDP - Service provider metadata
B] Uploading metadata manually:
  • From the Service Provider Settings section, you can copy the service provider metadata manually like SP Entity ID, ACS URL, Single Logout URL, and provide it to your identity provider for configuration.
  • You can refer to the below screenshot:

    Umbraco Single Sign-On (SSO) using Azure AD as IDP - Service provider metadata
  • Under the Plugin Settings tab, select Azure AD as your identity provider from the list shown below:
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP - Select your IDP
  • There are two ways detailed below with which you can get the SAML SP metadata to configure onto your Azure AD end.
  • A] Using SAML metadata URL or metadata file:
  • In the plugin settings menu, look for Service Provider settings. Under that, you can find the metadata URL as well as the option to download the SAML metadata.
  • Copy metadata URL or download the metadata file to configure the same on your Azure AD end. You may refer to the screenshot below:
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP - Download SP Metadata
    B] Uploading metadata manually:
  • From the Service Provider settings section, you can manually copy the service provider metadata like SP Entity ID, ACS URL, Single Logout URL and share it with your identity provider for configuration. You may refer to the screenshot below:
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP - Copy SP Metadata

  • Log in to Azure AD Portal
  • Select Azure Active Directory.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP -  Enterprise registrations
  • Select Enterprise Application.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP -  Enterprise registrations
  • Click on New Application.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP -  New Application
  • Click on Create your own Application.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP -  Add Non-Gallery Application
  • Enter the name for your app, then select Non-gallery application section and click on Create button.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP -  Add Non-Gallery Application
  • Click on Setup Single sign-on .
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP -  Add Non-Gallery Application
  • Select the SAML  tab.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP -  Add Non-Gallery Application
  • After clicking on Edit, enter the SP Entity ID for Identifier and the ACS URL for Reply URL from Service Provider Metadata tab of the plugin.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP -  Select SAML authentication SSO Umbraco Single Sign-On (SSO) using Azure AD as IDP -  Select SAML authentication SSO
  • By default, the following Attributes will be sent in the SAML response. You can view or edit the claims sent in the SAML response to the application under the Attributes tab.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP -  Configure SAML 2.0
  • Copy the App Federation Metadata Url to get the Endpoints required for configuring your Service Provider.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP -  Setup SAML 2.0
  • Assign users and groups to your SAML application
    • Navigate to Users and groups tab and click on Add user/group.
    • Umbraco Single Sign-On (SSO) using Azure AD as IDP -  assign groups and users
    • Click on Users to assign the required user and then click on select.
    • Umbraco Single Sign-On (SSO) using Azure AD as IDP -  add users
    • You can also assign a role to your application under Select Role section.

You have successfully configured Azure AD as SAML IDP (Identity Provider) for achieving Umbraco Single Sign-On (SSO).

3. Configure Umbraco as SP

There are below two ways with which you can configure your SAML identity provider metadata in the module.

A] Upload metadata using the Upload IDP Metadata button:
  • If your identity provider has provided you with the metadata URL or metadata file (.xml format only) then you simply configure the identity provider metadata in the module using the Upload IdP Metadata option.
  • You can refer to the below screenshot

    Umbraco Single Sign-On (SSO) using Azure AD as IDP - Upload Metadata
  • You can choose any one of the options according to the metadata format you are available with.
B] Configure the identity provider metadata manually:
  • After configuring your Identity Provider, it will provide you with IDP Entity ID, IDP Single Sign On URL and x.509 Certificate. Configure these values under IDP Entity ID, Single Sign-On URL and SAML X509 Certificate fields respectively.
  • Click Save to save your IDP details.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP - test configuration
  • There are two ways detailed below with which you can configure your SAML identity provider metadata in the plugin.
  • A] Upload metadata using the Upload IDP Metadata button:
  • If your identity provider has provided you with the metadata URL or metadata file (.xml format only), then you can simply configure the identity provider metadata in the plugin using the Upload IDP Metadata option. You may refer to the screenshot below:
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP - Upload IDP Metadata
  • You can choose any one of the options according to the metadata format you have available.
  • B] Configure the identity provider metadata manually:
  • After configuring your Identity Provider, it will provide you with IDP Entity ID, IDP Single Sign On URL and SAML X509 Certificate fields respectively.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP - Enter IDP metadata manually
  • Click Save to save your IDP details

4. Test Configuration

  • Click on Test Configuration button to test whether the SAML configuration you’ve done is correct or not.
  • The below screenshot shows a successful result.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP - saml dll testconfig
  • Click on the Test Configuration button to test whether the SAML Configuration you’ve done is correct.
  • The screenshot below shows a successful result. Click on SSO Integration to further continue with the SSO Integration.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP - successful test configuration
  • If you are experiencing any error on the plugin end you’ll be shown with the window similar to below.
  • To troubleshoot the error you can follow the below steps:
    • Under the Troubleshoot tab, enable the toggle to receive the plugin logs.
    • Umbraco Single Sign-On (SSO) using Azure AD as IDP - Troubleshooting
    • Once enabled, you will be able to retrieve plugin logs by navigating to the Plugin Settings tab and clicking on Test Configuration.
    • Download the log file from the Troubleshoot tab to see what went wrong.
    • You can share the log file with us at umbracosupport@xecurify.com and our team will reach out to you to resolve your issue.

5. Attribute Mapping

  • Map your umbraco attributes with the Identity Provider (IdP) attributes.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP - attribute mapping
  • Click on Save Attribute Mapping button to save the settings.

6. Login Type

The Umbraco platform supports two different ways of login:



  • Under the Login Setup tab, select Member login as your preferred form of login and then click Save.
  • Umbraco Single Sign-On (SSO) using Azure AD as IDP - Umbraco Member login

7. Login Settings

  • Use the following URL as a link in your Umbraco site from where you want to initiate SSO:
    https://umbraco-base-url/?ssoaction=login
  • For example you can use it as:
    <a href="https://umbraco-base-url/?ssoaction=login”>Login</a>"
  • Use the following URL as a link in the application from where you want to perform SSO:
  • https://<umbraco-application-base-url>/?ssoaction=login

8. Logout Settings

  • Use the following URL as a link in your Umbraco from where you want to perform SLO:
    https://umbraco-base-url/?ssoaction=logout
  • For example you can use it as:
    <a href="https://umbraco-base-url/?ssoaction=logout”>Logout</a>"

You can configure the Umbraco SAML 2.0 Single Sign-On (SSO) module with any Identity Providers such as ADFS, Azure AD, Bitium, Centrify, G Suite, JBoss Keycloak, Okta, OneLogin, Salesforce, AWS Cognito, OpenAM, Oracle, PingFederate, PingOne, RSA SecureID, Shibboleth-2, Shibboleth-3, SimpleSAML, WSO2 or even with your own custom identity provider. Check the list of identity providers here.

9. Additional Resources

Need Help?

Not able to find your identity provider? Mail us on umbracosupport@xecurify.com and we'll help you set up SSO with your IDP and for quick guidance (via email/meeting) on your requirement and our team will help you to select the best suitable solution/plan as per your requirement.

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