Breadcrumbs

How to: Setting up SAML

Configuring SAML to use for user login can be a slightly challenging task. This page describes all the necessary steps from the client’s side.

Prerequisites

  • The final custom domain must be configured

  • Circularo application needs to be registered in client’s AD

Registering the application in client’s AD

Most client utilize the MS Entra ID (formerly Azure Active Directory):

  1. Sign in to the Azure Portal

    1. Open the Azure Portal and log in with your credentials.

  2. Access MS Entra ID

    1. From the left-hand menu, select Microsoft Entra ID.

Microsoft Entra ID.png
Select Microsoft Entra ID

  1. Create a New Application

    1. Navigate to Enterprise applications.

New application.png
New application

b. Click + New application and select Create your own application.

Create your own application.png
Create your own application

c. Enter a name for the application and proceed to register it as a custom-built app.

  1. Configure the Application

    1. Navigate to Circularo Administration → Settings → Security → Login & Authentication.

      image-20260709-104117.png

    2. Toggle the “SAML enabled” switch.

      image-20260709-104147.png

    3. Go to “SAML SP Configuration”, ensure that the “Issuer” and “Callback” fields are filled and generate keys. Once the keys are generated, click on “Continue”.

      image-20260709-105258.png

    4. Download the Service provider metadata file.

      image-20260709-105742.png

    5. Navigate to your enterprise application in Entra ID → Single sign on → SAML and upload the SP metadata file.

Upload metadata file.png
Upload metadata (XML) file

f. Set up Single Sign-On (SSO) with SAML - the Identifier and Reply URL at minimum.

Basic config.png
Set the SAML configuration

  1. Locate the Federation Metadata Document

    1. Go to the Set up Single Sign-On with SAML section.

    2. Find the Federation Metadata XML link.

Federation metadata file.png
Federation Metadata XML link

  1. Download the Metadata File

    1. Click the Federation Metadata XML link to open it in your browser.

    2. Save the file to your device (e.g., right-click and choose Save As).

  2. Upload the Federation Metadata XML file to Circularo

    1. Go to Administration → Settings → Security → Login & Authentication → SAML IdP configuration

    2. Upload the Federation Metadata XML and click “Save”

      image-20260709-110223.png

For other AD systems the configuration should be similar but we currently unfortunately don’t have any experience with these.