Search Results :

×
Sign Up Contact Us

Contents

Guide to Configure Umbraco SAML SSO using PingFederate 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 PingFederate considering PingFederate 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 PingFederate 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

  • Login to your Ping Federate User Admin dashboard.
  • Click on the Identity Provider in the left navigation menu.
  • Under SP CONNECTION, click on Create New button.
Ping Federate User Admin dashboard

  • Select the Browser SSO Profiles connection template on the Connection Type tab and click Next.
Browser SSO Profiles

  • Select Browser SSO on the Connection Options tab and click Next.
PingFederate - Connection Options

  • Select File as the method for importing metadata and click Choose file to choose the miniOrange SSO plugin’s metadata on the Import Metadata tab. Click Next.
PingFederate - Import Metadata

  • Review the information on the Metadata Summary tab and click Next.
  • In the General Info tab ensure that the Service Provider’s Entity ID, Connection Name, and Base URL fields pre-populate based on the metadata. Click Next.
  • Navigate to the Browser SSO tab and click on the Configure Browser SSO. You will be redirected to Browser SSO Setup wizard.
    • Select the IdP-Initiated SSO and SP-Initiated SSO options on the SAML Profiles tab and click Next.
    SP and IDP initiated SSO

    • Enter your desired assertion validity time from on the Assertion Lifetime tab and click Next. By default, it is configured 5 minutes for both.
    • Navigate to the Assertion Creation and click on the Configure Assertion Creation. You will be redirected to the assertion creation setup wizard.
      • In the Identity Mapping tab select STANDARD and click Next.
      • Select a Subject Name Format for the SAML_SUBJECT on the Attribute Contract tab and click Next.
      • Click Map New Adapter Instance on the Authentication Source Mapping.
      Map New Adapter Instance

      • Select an Adapter Instance and click Next. The adapter must include the user’s email address.
      Adapter Instance

      • Select the Use only the adapter contract values in the SAML assertion option on the Mapping Method tab and click Next.
      • Select your adapter instance as the Source and the email as the Value on the Attribute Contract Fulfilment tab and click Next.
      Attribute Contract Fulfilment

      • (Optional) Select any authorization conditions you would like on the Issuance Criteria tab and click Next.
      • Click Done on the Summary.
      • Click Next on the Authentication Source Mapping tab.
      • Click Done on the Summary tab.
      • Click Next on the Assertion Creation.
  • Navigate to the Protocol Settings tab of the Browser SSO wizard and click on the Configure Protocol settings.
    • Select POST for Binding and specify the single sign-on endpoint URL in the Endpoint URL field on the Assertion Consumer Service URL Click Next.
    Assertion Consumer Service URL

    • Select POST on the Allowable SAML Bindings tab and click Next.
    • Select your desired signature policies for assertions on the Signature Policy tab and click Next.
    Signature Policy

    • Select your desired encryption policy for assertions on the Encryption Policy tab and click Next.
    • Click Done on the Protocol Settings Summary tab.
  • Navigate to the Credentials and click on the Configure Credentials. You will be redirected to the Credentials setup wizard.
    • Select the Signing Certificate to use with the Single Sign-On service and select Include the certificate in the signature element in the Digital Signature Settings tab. Click Done.
    Digital Signature Settings

    • Click Done on the Summary.
    • Click Next on the Credentials.
  • Select Active for the Connection Status on the Activation & Summary tab and click Save.
  • Now, navigate to the Ping Federate User Admin dashboard → Identity Provider.
  • Click Manage All under SP Connections.
  • Click Export Metadata for the desired service provider connection.
  • Click Export on the Export & Summary tab and click Done.

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

  • Click on the Add new IDP button to configure a new Identity Provider.
Umbraco SAML SSO using PingFederate as IDP - Add New IDP

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

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