Skip to main content
Prerequisites
  • Complete Create Entra ID App
  • Have access to Entra ID Portal with one of these roles: Cloud Application Administrator, Application Administrator, or owner of the service principal.
  • Know your customer ID xyz, e.g. xyz.activeguard.cloud
If you want to enable a different login mechanism like for example LDAP, have a look at Authentication Overview.

Activate SAML in Entra ID

  1. Go to Entra ID PortalEnterprise apps → click on the xorlab app.
  2. Open Single sign-on: Set up single sign-on
  3. Choose SAML.
  4. Edit the Basic SAML Configuration: Edit the basic SAML configuration
  5. Add an Identifier and a Reply URL entry, where xyz is your customer ID. SAML configuration
    The entraSaml part of both URLs is the SAML backend name. You will need to use exactly the same name later when configuring the SAML authentication in xorlab. Each SAML backend must have a unique name. If you are configuring multiple SAML providers in a multi-tenant deployment, use unique names that identify the tenant (e.g nameSAML).
  6. Save and click No, I’ll test it later.
  7. Copy and save the App Federation Metadata URL from SAML Certificates, you will need it later. App Federation Metadata

Configure users and roles in Entra ID

  1. Go to Entra ID PortalApp registrationsAll applications → click on the xorlab app. App registrations
  2. Click on App roles and then Create app role: Create app role
  3. Create three new app roles via Create app role. The optional ones can be omitted if they are not needed. App role configuration panel
  4. Open the Enterprise apps menu on the left side, choose again the xorlab app and click on Assign users and groups: Assign users and groups
  5. Click on Add user/group: Add user/group
  6. Add the users or groups who need access to xorlab and assign them one of the three created roles Administrator, Analyst or Quarantine user.
    Group assigning is only available in the Microsoft Entra ID P1+ license.

Activate SAML on xorlab

Now that you have the Entra ID configured, we will set up xorlab accordingly.
  1. Open the file auth/auth/auth.yml and add a SAML backend.
    auth.yml
    If you rename entraSaml, make sure to update the Identifier and Reply URL in Entra ID SAML configuration above.
  2. Enter the App Federation Metadata Url you copied before for the metadataUrl key.
  3. Map your Entra ID roles to xorlab roles by adding a roleMapping. More information about xorlab roles can be found at Built-in User Roles
    auth.yml
    The following example shows how to do a role pass-through without role mapping. In general this is not recommended because it is more error prone. However if you do it, make sure to:
    • Specify all xorlab roles in Entra ID (including xcc_insights and xcc_monitor) and assign them to your users
    • Provide only xorlab related roles in the SAML token to avoid an excessive token size
    auth.yml
  4. Click Publish. The authentication configuration becomes active within about one minute.
  5. Now the SAML integration is done and you can test the login with the link https://xyz.activeguard.cloud/?_agAuthBackend=entraSaml. Replace xyz with your customer ID.
Custom trust storeIn case your xorlab configuration uses a custom trust store, you will also have to add the DigiCert Global Root CA certificate when integrating SAML with Azure Active Directory. Please follow the steps described in Certificate configuration.

Next steps

Enable the protection mode for your tenant: Optionally, before going inline, import your existing emails: