Search Results :

×

Umbraco SAML Single Sign-On Setup Guides

Choose your SAML identity provider to configure Single Sign-On (SSO)

Not able to find your IdP? Contact us at umbracosupport@xecurify.com and we will help you setup Umbraco SSO with your IdP in no time.

Couldn't find your IdP?

Reach out to us at umbracosupport@xecurify.com and we will help you setup Umbraco SSO with your identity provider (IdP) in no time.

Umbraco SAML SSO - Azure B2C as IDP logo

Azure B2C

Umbraco SAML SSO - Ping Federate as IDP logo

Ping Federate

Umbraco SAML SSO - Google as IDP logo

Google

Umbraco SAML SSO - Salesforce as IDP logo

Salesforce

Umbraco SAML SSO - Onelogin as IDP logo

Onelogin

Umbraco SAML SSO - WordPress as IDP logo

WordPress

Umbraco SAML SSO - Auth0 as IDP logo

Auth0

Umbraco SAML SSO - Keycloak as IDP logo

Keycloak

Umbraco SAML SSO - Degreed as IDP logo

Degreed

Steps to Configure the Umbraco SSO using SAML 2.0 Module

Select your umbraco version to configure SSO with:

Step 1: Download and extract the package

  • 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.
  • 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 called miniorange-saml-sso.dll and a folder called miniOrange-sso-configuration that contains a configuration file called configuration.json.

Step 2: Add module in 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.
  • 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) - Login Page
  • Register or Login for configuring the module.
  • Add the miniorange-saml-sso.dll reference in your Umbraco application.
  • Umbraco SAML Single Sign-On (SSO) -  Add miniOrange DLL file
  • Add the miniOrange-sso-configuration folder in the root folder of your 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 SAML Single Sign-On (SSO) -  ASP.NET login page
  • Register or log in with your account by clicking the Register button to configure the plugin

Step 3: Configure your Identity Provider

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) - 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) - Service provider metadata
  • Under the Plugin Settings tab, select your identity provider from the list shown below:
  • Umbraco SAML Single Sign-On (SSO) - Select your IDP
  • 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 Single Sign-On (SSO) - 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 SAML Single Sign-On (SSO) - Copy SP Metadata

Step 4: Configure your Service Provider

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) - Upload Metadata
  • You can choose any one of the options according to the metadata format you are available with.
  • 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 SAML Single Sign-On (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.
  • Umbraco SAML Single Sign-On (SSO) -  Enter IDP metadata manually
  • Click Save to save your IDP details
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) - test configuration

Step 5: 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) - 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 SAML Single Sign-On (SSO) - 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 SAML Single Sign-On (SSO) -  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.

Step 6: Attribute Mapping

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

Step 7: Add following link in your Umbraco to initiate Single Sign-On (SSO)

  • 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

Step 8: Add following link in your Umbraco to initiate Single Logout (SLO)

  • 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 SiteFinity SAML 2.0 Single Sign-On (SSO) module with any Identity Provider 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.


Additonal 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