Search Results :

×
Sign Up Contact Us

Contents

Guide to Configure Umbraco SAML SSO using ADFS 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 ADFS considering ADFS as IdP.

download plugin button Download plugin pricing button plugin pricing button Pricing Plans
Select your umbraco version to configure SSO with:
NuGet Package
.NET CLI

PM> NuGet\Install-Package miniOrange.Umbraco8.SAML.SSO -Version 5.4.2

> dotnet add 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.
  • Run the application when the configuration is done.
  • 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.
  • 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.
  • Run the application when the configuration is done.
NuGet Package
.NET CLI

PM> NuGet\Install-Package miniOrange.Umbraco8.SAML.SSO -Version 5.4.2

> dotnet add 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.
  • Run the application when the configuration is done.
  • 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.
  • 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.
  • Run the application when the configuration is done.
NuGet Package
.NET CLI

PM> NuGet\Install-Package miniOrange.Umbraco.SAML.SSO.Login -Version 9.2.3

> dotnet add package miniOrange.Umbraco.SAML.SSO.Login --version 9.2.3

  • 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.
    Include only the highlighted section below in the startup.cs file of your application.
  using miniOrange.saml;
  using System.Reflection;

  namespace Application
  {
    public class Startup
    {

      // Add services to the container.
      public void ConfigureServices(IServiceCollection services)
      {
        services.AddUmbraco(_env, _config)
          .AddBackOffice()
          .AddWebsite()
          .AddComposers()
          .Build();

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

      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.
NuGet Package
.NET CLI

PM> NuGet\Install-Package miniOrange.Umbraco.SAML.SSO.Login -Version 10.2.3

> dotnet add package miniOrange.Umbraco.SAML.SSO.Login --version 10.2.3

  • 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.
    Include only the highlighted section below in the startup.cs file of your application.
  using miniOrange.saml;
  using System.Reflection;

  namespace Application
  {
    public class Startup
    {

      // Add services to the container.
      public void ConfigureServices(IServiceCollection services)
      {
        services.AddUmbraco(_env, _config)
          .AddBackOffice()
          .AddWebsite()
          .AddComposers()
          .Build();

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

      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.
NuGet Package
.NET CLI

PM> NuGet\Install-Package miniOrange.Umbraco.SAML.SSO.Login -Version 11.2.3

> dotnet add package miniOrange.Umbraco.SAML.SSO.Login --version 11.2.3

  • 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.
    Include only the highlighted section below in the program.cs file of your application.
  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.
NuGet Package
.NET CLI

PM> NuGet\Install-Package miniOrange.Umbraco.SAML.SSO.Login -Version 12.2.3

> dotnet add package miniOrange.Umbraco.SAML.SSO.Login --version 12.2.3

  • 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.
    Include only the highlighted section below in the program.cs file of your application.
  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.
NuGet Package
.NET CLI

PM> NuGet\Install-Package miniOrange.Umbraco.SAML.SSO.Login -Version 13.2.3

> dotnet add package miniOrange.Umbraco.SAML.SSO.Login --version 13.2.3

  • 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.
    Include only the highlighted section below in the program.cs file of your application.
  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.
NuGet Package
.NET CLI

PM> NuGet\Install-Package miniOrange.Umbraco.SAML.SSO.Login -Version 14.2.3

> dotnet add package miniOrange.Umbraco.SAML.SSO.Login --version 14.2.3

  • 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.
    Include only the highlighted section below in the program.cs file of your application.
  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.
NuGet Package
.NET CLI

PM> NuGet\Install-Package miniOrange.Umbraco.SAML.SSO.Login -Version 15.2.4

> dotnet add package miniOrange.Umbraco.SAML.SSO.Login --version 15.2.4

  • 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.
    Include only the highlighted section below in the program.cs file of your application.
  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.
NuGet Package
.NET CLI

PM> NuGet\Install-Package miniOrange.Umbraco.SAML.SSO.Login -Version 16.2.4

> dotnet add package miniOrange.Umbraco.SAML.SSO.Login --version 16.2.4

  • 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.
    Include only the highlighted section below in the program.cs file of your application.
  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.
NuGet Package
.NET CLI

PM> NuGet\Install-Package miniOrange.Umbraco.SAML.SSO.Login -Version 17.2.4

> dotnet add package miniOrange.Umbraco.SAML.SSO.Login --version 17.2.4

  • 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.
    Include only the highlighted section below in the program.cs file of your application.
  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.

Step by Step guide for Umbraco SAML SSO using ADFS as Identity Provider.

  • After integration, open your browser and browse the connector dashboard with the URL below:
 https://<umbraco-base-url>/?ssoaction=config
  • If the registration page or login page pops up, you have successfully added the miniOrange SAML SSO middleware in your application.
Umbraco SAML SSO - registration page

  • Register or log in with your account by clicking the Register button to configure the middleware.
  • After successful registration, you will receive a trial license key on your registered email address.
  • To activate the middleware, you can either:
    • Enter the license key received via email in the provided input field.

    OR

    • Upload the license file that you downloaded by clicking on the Click Here button.
Umbraco SAML SSO - Verify Trial License

  • Then, check the box "I have read the above conditions and I want to activate the middleware", and click the Activate License button.
Umbraco SAML SSO - Activate License

There are two ways detailed below with which you can get the SAML SP metadata to configure onto your Identity Provider 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 identity provider end.
  • You may refer to the screenshot below:
Umbraco SAML SSO - Service Provider 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 SAML SSO - enter SP metadata manually

  • First, search for ADFS Management application on your ADFS server.
ADFS Management

  • In ADFS Management, select Relying Party Trust and click on Add Relying Party Trust.
ADFS Management - Relying Party Trust

  • Select Claims aware from the Relying Party Trust Wizard and click on Start button.
ADFS Management - Claims aware

Select Data Source

  • In Select Data Source, select the data source for adding a relying party trust.
  • Navigate to Service Provider Metadata section from the Umbraco SAML middleware and copy the Metadata URL.
  • Select Import data about the relying party published online or on the local network option and add the metadata URL in Federation metadata address.
  • Click on Next.
Service Provider Metadata

  • Navigate to Service Provider Metadata section from the Umbraco SAML middleware and click on the Download XML metadata button to download the plugin metadata file.
  • Select Import data about the relying party from a file option and upload the downloaded metadata file.
  • Click on Next.
Service Provider Metadata

  • Navigate to Service Provider Metadata section of the Umbraco SAML middleware to get the endpoints to configure Service Provider manually.
  • In Add Relying Party Trust Wizard select option Enter data about the relying party manually and click on Next.
Service Provider Metadata

Specify Display Name

  • Enter Display Name and Click Next.
Specify Display Name

Configure Certificate (Premium feature)

  • Download the certificate from Service Provider Metadata Tab.
  • Upload the certificate and click on Next.
Configure Certificate

Configure URL

  • Select Enable support for the SAML 2.0 WebSSO protocol option and enter ACS URL from the plugin's Service Provider Metadata Tab.
  • Click on Next.
Configure URL

Configure Identifiers

  • In the Relying party trust identifier, add the SP-EntityID / Issuer from the plugin's Service Provider Metadata tab.
Configure Identifiers

Choose Access Control Policy

  • Select Permit everyone as an Access Control Policy and click on Next.
Choose Access Control Policy

Ready to Add Trust

  • In Ready to Add Trust click on Next and then Close.
Ready to Add Trust

Edit Claim Issuance Policy

  • In the list of Relying Party Trust, select the application you created and click on Edit Claim Issuance Policy.
Edit Claim Issuance Policy

  • In Issuance Transform Rule tab click on Add Rule button.
Edit Claim Issuance Policy

Choose Rule Type

  • Select Send LDAP Attributes as Claims and click on Next.
Choose Rule Type

Configure Claim Rule

  • Add a Claim Rule Name and select the Attribute Store as required from the dropdown.
  • Under Mapping of LDAP Attributes to outgoing claim types, Select LDAP Attribute as E-Mail-Addresses and Outgoing Claim Type as Name ID.
Configure Claim Rule

  • Once you have configured the attributes, click on Finish.
  • After configuring ADFS as IDP, you will need the Federation Metadata to configure your Service Provider.
  • To get the ADFS Federation Metadata, you can use this URL
    https://< ADFS_Server_Name >/federationmetadata/2007-06/federationmetadata.xml
  • You have successfully configured ADFS as SAML IdP (Identity Provider) for achieving Umbraco Single Sign-On (SSO).

Windows SSO (Optional)

Follow the steps below to configure Windows SSO

  • Steps to configure ADFS for Windows Authentication
    • Open elevated Command Prompt on the ADFS Server and execute the following command on it:
      setspn -a HTTP/##ADFS Server FQDN## ##Domain Service Account##
    • FQDN is Fully Qualified Domain Name (Example : adfs4.example.com)
    • Domain Service Account is the username of the account in AD.
    • Example : setspn -a HTTP/adfs.example.com username/domain.
  • Open AD FS Management Console, click on Services and go to the Authentication Methods section. On the right, click on Edit Primary Authentication Methods. Check Windows Authentication in Intranet zone.
ADFS Management Console ADFS Management Console
  • Open Internet Explorer. Navigate to Security tab in Internet Options.
  • Add the FQDN of AD FS to the list of sites in Local Intranet and restart the browser.
  • Select Custom Level for the Security Zone. In the list of options, select Automatic Logon only in Intranet Zone.
Security Settings - Local Intranet Zone

  • Open the powershell and execute following two commands to enable windows authentication in Chrome browser.
 Set-AdfsProperties -WIASupportedUserAgents ((Get-ADFSProperties | Select -ExpandProperty WIASupportedUserAgents) + "Chrome")
 Get-AdfsProperties | Select -ExpandProperty WIASupportedUserAgents;
  • You have successfully configured ADFS for Windows Authentication.
  • Click on the Add new IDP button to configure a new Identity Provider.
Umbraco SAML SSO using ADFS as IDP - Add New IDP

  • Under the Plugin Settings tab, select ADFS as your identity provider from the list shown.
Umbraco SAML SSO using ADFS as IDP - Select ADFS

There are two ways detailed below with which you can configure your SAML Identity Provider metadata in the middleware.

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 middleware using the Upload IDP Metadata option.
  • Copy metadata URL or download the metadata file to configure the same on your identity provider end.
  • You may refer to the screenshot below:
Umbraco SAML SSO - 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.
  • Click Save to save your IDP details.
Umbraco SAML SSO - Configure IDP Manually

  • After uploading the metadata details, navigate to the Identity Provider Settings section. Hover over the Select Actions dropdown and click on Test Configuration.
Umbraco SAML SSO - Test Configuration

  • The screenshot below shows a successful result. Click on SSO Integration to further continue with the SSO Integration.
Umbraco SAML SSO - Test Configuration Successful

  • If you are experiencing any error on the middleware end you’ll be shown with the window similar to below.
Umbraco SAML SSO - Test Configuration Error

  • To troubleshoot the error you can follow the below steps:
  • Under Troubleshoot tab, enable the toggle to receive the plugin logs.
Umbraco SAML SSO - TroubleShoot

  • Once enabled, you will be able to retrieve plugin logs by navigating to Plugin Settings tab and clicking on Test Configuration.
  • Download the log file from the Troubleshoot tab to see what went wrong.
Umbraco Login Type
  • After this, select the Login Type from the dropdown on the right side of the Identity Provider Settings page.
  • You can choose from BackOffice, Member, or Custom Attribute based.
  • Note: The Custom Attribute based login type is available in the Premium and Enterprise versions.
Umbraco SAML SSO - Umbraco Login Type
  • Attribute Mapping, Role Mapping and Domain Restriction are available in the Premium and Enterprise versions of the middleware.
Umbraco SAML SSO - Attribute Mapping

  • Hover on Select Actions and click on Copy SSO Link.
Umbraco SAML SSO - Copy SSO Link

  • Use the following URL as a link in the application from where you want to perform SSO:
  https://<umbraco-base-url>/?ssoaction=login
  • For example, you can use it as:
  <a href="https://<umbraco-base-url>/?ssoaction=login">Log in</a>
  • Use the following URL as a link to your application 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">Log out</a>

Related Articles


 Thank you for your response. We will get back to you soon.

Something went wrong. Please submit your query again

We'll Reach Out to You at the Earliest!


ADFS_sso ×
Hello there!

Need Help? We are right here!

support