Search Results :

×
Sign Up Contact Us

Umbraco SAML Single Sign-On (SSO) with Auth0 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 Auth0 considering Auth0 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

PM> NuGet\Install-Package miniOrange.Umbraco8.SAML.SSO -Version 5.4.2
  • 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.
  • Download Umbraco SAML Single Sign-On (SSO) middleware.
  • For Setting up the middleware, you will be required to add the below namespaces, services and middleware in your startup.cs file (marked in green), below here is a sample example 
    •                 
    
            
      
        using miniOrange.saml;
        using System.Reflection;
    
        namespace Application
        {
            public class Startup
            {
    
        // Add services to the container.

        public void ConfigureServices(IServiceCollection services)
        {
          var umbracoBuilder = services.AddUmbraco(_env, _config)
           .AddBackOffice()
           .AddWebsite()
           .AddComposers()

           services.AddminiOrangeServices(Assembly.GetExecutingAssembly());
           umbracoBuilder.Build();
       }

        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {

         if (env.IsDevelopment())
          {
           app.UseDeveloperExceptionPage();
           }
           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-middleware-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 SAML Single Sign-On (SSO) using Azure AD as IDP - Umbraco login page
    • Register or log in with your account by clicking the Register button to configure the plugin
  • Download Umbraco SAML Single Sign-On (SSO) middleware.
  • For Setting up the middleware, you will be required to add the below namespaces, services and middleware in your program.cs file (marked in green), below here is a sample example 
    •                         
    
                    
              
                using miniOrange.saml;
                using System.Reflection;
                WebApplicationBuilder builder = WebApplication.CreateBuilder(args);
            
                builder.CreateUmbracoBuilder()
                    .AddBackOffice()
                    .AddWebsite()
                    .AddDeliveryApi()
                    .AddComposers()
                    .Build();
            
                // Add services to the container.
        
                builder.Services.AddminiOrangeServices(Assembly.GetExecutingAssembly());

                WebApplication app = builder.Build();

                await app.BootUmbracoAsync();

                app.UseUmbraco()
                   .WithMiddleware(u =>
                    {
                     u.UseBackOffice();
                     u.UseWebsite();
                     u.AppBuilder.UseminiOrangeSAMLSSOMiddleware();
                     })
        
                     .WithEndpoints(u =>
                     {
                    u.UseBackOfficeEndpoints();
                    u.UseWebsiteEndpoints();
                   });
               await app.RunAsync();
    • Run the application when the configuration is done.
    • After integration, open your browser and browse the plugin dashboard with the URL below: https://<umbraco-middleware-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 SAML Single Sign-On (SSO) using Azure AD as IDP - Umbraco login page
    • Register or log in with your account by clicking the Register button to configure the plugin
    • After Registration the license key activation page will get displayed. Here enter the license key received on your registed email
      • Umbraco SAML Single Sign-On (SSO) using Azure AD as IDP - Umbraco login page
    • If you didn't received the license key then click here
  • After integration, open your browser and browse the connector dashboard with the URL below:
    https://<your-application-base-url>/?ssoaction=config
  • If the registration page or login page pops up, you have successfully added the miniOrange Umbraco SAML SSO connector to your application.
    • Umbraco SAML Single Sign-On (SSO) using Azure AD as IDP - Umbraco SAML Registration
  • Register or log in with your account by clicking the Register button to configure the module.

1. Configure Auth0 as IDP

There are below two ways with which you can get the SAML SP metadata to configure on your identity provider 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 identity provider end.
  • You can refer to the below screenshot:

    Umbraco Single Sign-On (SSO) using Auth0 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 Auth0 as IDP - Service provider metadata
  • Log in to your Auth0 dashboard.
  • Click on Applications.
    • Umbraco Single Sign-On (SSO) using Auth0 as IDP - Navigate to Applications
  • Click on Create Application.
    • Umbraco Single Sign-On (SSO) using Auth0 as IDP - Add or create application
  • A new window will pop-up. Enter a name for the application and select Regular Web App. Click on CREATE button.
    • Umbraco Single Sign-On (SSO) using Auth0 as IDP - Choose regular Web app
  • Select the Addons tab.
    • Umbraco Single Sign-On (SSO) using Auth0 as IDP - Select SAML SSO Add-ons
  • Enable SAML2 option in the addons. It will open up a Configuration window.
    • Umbraco Single Sign-On (SSO) using Auth0 as IDP - Enable SAML 2.0 Add-on webapp
  • Enter Application Callback URL, Audience, Recipient and other settings using SP entity ID and ACS URL copied from the plugin as shown below:
    • Umbraco Single Sign-On (SSO) using Auth0 as IDP - Add SP entity ID and URL from Plugin
  • Scroll down and click on Save.
    • Umbraco Single Sign-On (SSO) using Auth0 as IDP - Save entity ID
  • Go to the Usage tab and click on the Identity Provider Metadata download link. It will download the metadata XML file which you'll need for setting up the SAML plugin.
    • Umbraco Single Sign-On (SSO) using Auth0 as IDP - IDP metadata download

You have successfully configured Auth0 as SAML IdP (Identity Provider) for achieving Auth0 SSO login into your Umbraco application.

2. 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 Auth0 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 Auth0 as IDP - test configuration

3. Testing SAML SSO

  • 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 SAML Single Sign-On (SSO) using Azure AD as IDP - Do test SAML SSO
  • If you are experiencing any error on the module end you’ll be shown with the window similar to below.
    • Umbraco SAML Single Sign-On (SSO) using Azure AD as IDP - Error Window
  • To troubleshoot the error you can follow the below steps:
    • Under Troubleshooting tab, enable the toggle to receive the plugin logs.
      • Umbraco SAML Single Sign-On (SSO) using Azure AD as IDP - Enable debug logs
    • Once enabled, you will be able to retrieve plugin logs by navigating to Identity Provider 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.
  • 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 SAML Single Sign-On (SSO) using Azure AD as IDP - Do test SAML SSO
  • If you are experiencing any error on the module end you’ll be shown with the window similar to below.
    • Umbraco SAML Single Sign-On (SSO) using Azure AD as IDP - Error Window
  • To troubleshoot the error you can follow the below steps:
    • Under Troubleshooting tab, enable the toggle to receive the plugin logs.
      • Umbraco SAML Single Sign-On (SSO) using Azure AD as IDP - Enable debug logs
    • Once enabled, you will be able to retrieve plugin logs by navigating to Identity Provider 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.
  • 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 SAML Single Sign-On (SSO) using Azure AD as IDP - Do test SAML SSO
  • If you are experiencing any error on the module end you’ll be shown with the window similar to below.
    • Umbraco SAML Single Sign-On (SSO) using Azure AD as IDP - Error Window
  • To troubleshoot the error you can follow the below steps:
    • Under Troubleshooting tab, enable the toggle to receive the plugin logs.
      • Umbraco SAML Single Sign-On (SSO) using Azure AD as IDP - Enable debug logs
    • Once enabled, you will be able to retrieve plugin logs by navigating to Identity Provider 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.

4. Login Settings

  • Go to Select Actions and click on Copy SSO Link.
    • Umbraco SAML Single Sign-On (SSO) using Azure AD as IDP - Copy SSO Link
  • Use the copied link in the application from where you want to perform SSO
  • For example you can use it as:
    <a href="copied-sso-link”>Login</a>"
  • Use the following URL as a link in the application from where you want to perform SSO: https://<umbraco-middleware-base-url>/?ssoaction=login
  • Use the following URL as a link in the application from where you want to perform SSO: https://<umbraco-middleware-base-url>/?ssoaction=login

5. Logout Settings

  • Use the following URL as a link in your Umbraco from where you want to perform SLO:
    https://umbraco-middleware-base-url/?ssoaction=logout
  • For example you can use it as:
    <a href="https://umbraco-middleware-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, WordPress, 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.

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