Search Results :

×
Sign Up Contact Us

Contents

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

  • In Okta Developer site, navigate to Applications tab and select Applications.
Okta Developer Console

  • Click on the Create App Integration button to create new app.
Create App Integration

  • Select SAML 2.0 as Sign-On method and Click on Next button.
Create App Integration

  • In General Settings tab, enter App Name and click on Next button.
General Settings tab

  • In Configure SAML tab, enter the required details:
Single Sign On URL ACS (AssertionConsumerService) URL from the Service Provider Metadata tab of the Plugin
Audience URL(SP Entity ID) SP Entity ID / Issuer from the Service Provider Metadata tab of the Plugin
Name ID Format Select E-Mail Address as a Name Id from dropdown list
Application Username Okta username
SAML Settings

  • Configure Group Attribute Statements (Optional) and click on Next button.
Group Attribute Statements

  • Select type of configured application and click on Finish button.
Group Attribute Statements

Assigning Groups/People:

  • Navigate to the application you created and click on the Assignments Tab in Okta.
Assigning Groups/People

  • Click on Assign button to Assign People and Assign Groups.
Assigning Groups/People

  • Once you Assign the user, click on Done button.
Assigning Groups/People

  • Click on Sign On tab and scroll down to the SAML Signing Certificates section.
  • Under Settings section in the Sign On tab, click on Copy button to copy the Metadata URL.
Metadata URL

  • Or you can also get IDP Metadata URL by following the further steps, click on Action dropdown for the Active certificate and then click on the View IdP Metadata option to get IdP Metadata which will be required for configuring your Service Provider.
IdP Metadata

  • Copy the Metadata URL.
Metadata URL

You have successfully configured Okta 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 Okta as IDP - Add New IDP

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

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