Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Entra ID SAML SSO docs #8151

Merged
merged 5 commits into from
Sep 20, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
158 changes: 68 additions & 90 deletions website/docs/how-to/how-to-add-sso-azure-saml.md
Original file line number Diff line number Diff line change
@@ -1,130 +1,108 @@
---
title: How to add SSO with SAML 2.0 Azure
title: How to add SSO with SAML 2.0 and Microsoft Entra ID
slug: 'how-to/how-to-add-sso-azure-saml'
description: 'Configure Microsoft Entra ID SSO with SAML 2.0 for your Unleash instance.'
---

import Figure from '@site/src/components/Figure/Figure.tsx'

:::info Availability
:::note Availability

The **Single-Sign-On capability** is only available for customers on the Enterprise subscription. Check out the [Unleash plans](https://www.getunleash.io/plans) for details.
**Plan**: [Enterprise](https://www.getunleash.io/pricing)

:::

## Introduction {#introduction}
This guide walks you through setting up single sign-on (SSO) using SAML 2.0, with [Microsoft Entra ID](https://www.microsoft.com/en-us/security/business/identity-access/microsoft-entra-id) as the identity provider (IdP). Unleash supports a variety of identity providers and protocols; visit our [reference documentation](../reference/sso.md) to explore other options.

This guides shows you how to use [Unleash's Single-Sign-On (SSO) integration](../reference/sso.md) with SAML 2.0 and how to connect it to Azure Active Directory as an ID provider (IdP).
## Prerequisites

## Basic configuration
To follow along, you'll need:

### Prerequisites
- An Unleash instance with administrator access.
- Microsoft Entra access for the instance you want to integrate with.

This guide expects you to already have:
## Create an enterprise application in Microsoft Entra ID

- Administrator access to the Unleash instance you want to configure
- Azure AD access for your Azure instance
To create a new enterprise application in Microsoft Entra, do the following:
1. In the Microsoft Entra admin center, go to **Identity > Applications > Enterprise applications** and click **New application**.
2. In the Microsoft Entra Gallery, click **Create your own application**.
3. Enter an app name, select the **Integrate any other application you don't find in the gallery** option, and click **Create**.

### Step 1: Create an Enterprise Application within Azure AD {#step-1}
## Configure SAML SSO for the application

**a) Sign in to your Azure AD and create a new Enterprise Application**.
### Add SAML configuration

<Figure caption="In the Azure directory overview, use the add button and select the enterprise application option." img="/img/sso-azure-saml-add-enterprise-app.png"/>
To configure SSO for the new application, do the following:
1. In the overview page of the application, go to **Manage > Single sign-on** and click **SAML**.
2. In the **Basic SAML Configuration** section, click **Edit**.
3. Click **Add identifier** and enter the Unleash identifier. For hosted instances, that is `https://<region>.app.unleash-hosted.com/<your_unleash_instance_name>`.
4. Click **Add reply URL** and enter the URL shown in the Unleash Admin UI at **Admin > Single sign-on > SAML 2.0**. For example, `<your_unleash_url>/auth/saml/callback`.
5. Click **Save**.

**b) In the Azure AD gallery, select the option to create your own application.**
### Manage attributes and claims

![The Azure AD gallery. The "create your own application" button is highlighted.](/img/sso-azure-saml-create-own-app.png)
To confirm attributes and claims for the new application, do the following:
1. In the single sign-on settings of your application, go to **Attributes & Claims** and click **Edit**.
2. Go to **Required claim** and click **Unique User Identifier (Name ID)**.
3. For **Name identifier format**, select **Email address**.
4. For **Source**, select **Attribute** and for **Source attribute** select `user.mail`.
5. Click **Save**.

**c) Next, provide the application with a name. When asked what you're looking to do with the application, select the "Integrate any other application you don't find in the gallery (Non-gallery)" option.**
<Figure caption="Edit the SAML configuration in Microsoft Entra admin center." img="/img/microsoft-entra-admin-center.png" />

![Azure application creation form. The name is set to "UnleashSSO" and the "non-gallery" option is selected.](/img/sso-azure-saml-name-app.png)

### Step 2: Configure SSO via SAML in Azure AD {#step-2}
### Save SAML certificate, identifier, and login URL

**a) On the single sign-on page ("single sign-on" in the side bar), select the "SAML" option**
Save the following information from the single sign-on settings of your application:
- [SAML certificate](#saml-certificate)
- [Login URL](#login-url)
- [Microsoft Entra Identifier](#microsoft-entra-identifier)

![Azure: SSO method selection page](/img/sso-azure-saml-saml-choice.png)
#### SAML certificate
To save the SAML certificate, go to the single sign-on settings of your application. In **SAML Certificates > Federation Metadata XML**, click **Download**. Open the file and copy the contents between the `X509Certificate` tag.

**b) Section 1: Basic SAML Configuration {#basic-saml-configuration}**
<Figure caption="Save the X509 Certificate from the SAML certificate XML file. The example has been redacted." img="/img/x509cert.png" />

When configuring SSO with SAML, you'll need to add an **identifier** and a **reply URL**.
The **identifier** is your Unleash URL. (For hosted instances, that's usually `https://<region>.app.unleash-hosted.com/<instanceName>`).
#### Login URL
To find your login URL, go to the single sign-on settings of your application. In the **Set up {your-application-name}** section, copy and save **Login URL**. For example: `https://login.microsoftonline.com/<your_identifier>/saml2`.

The **reply URL** is the Unleash callback URL. The Unleash callback URL is available on the Unleash SSO configuration page, and is typically your Unleash URL followed by `/auth/saml/callback`.
#### Microsoft Entra identifier

![Azure: The basic SAML configuration form with example values filled out for the required fields.](/img/sso-azure-saml-section-one.png)
To find your Microsoft Entra identifier, go to the single sign-on settings of your application. In the **Set up {your-application-name}** section, copy and save **Microsoft Entra Identifier**. For example: `https://sts.windows.net/<your_identifier>/`

**c) Section 2: Attributes & Claims {#attributes-and-claims}**

1. Set the "name identifier format" to "Email address".
2. Select "attribute" as the source.
3. Enter "user.mail" in the source attribute field.
## Configure the SAML 2.0 provider in Unleash

Optionally, you can also provide a first name and a last name. If provided, these will be used to enrich the data in Unleash.
To finalize the configuration, do the following:

![Azure: The manage claim form with email configuration filled out](/img/sso-azure-saml-unique-id-email-id.png)
![Azure: The list of claims used by the SAML setup, including the optional claims for given name and surname](/img/sso-azure-saml-attributes-claim.png)
1. In the Unleash Admin UI, go to **Admin > Single sign-on> SAML 2.0**.
2. In **Entity ID**, enter your [Microsoft Entra identifier](#microsoft-entra-identifier).
3. In **Single sign-on URL**, enter your [Login URL](#login-url).
4. In **X.509 Certificate**, [enter your SAML certificate](#saml-certificate).
5. Optional: To automatically create users for first-time sign-ins, select **Auto-create users**. Select a default root role new users should have, and configure the list of valid email domains.
6. Click **Save**.

:::info URLs and formats
<Figure caption="Configure SAML 2.0 in Unleash." img="/img/saml2.0.png" />

Make sure to replace URLs with the public URL for your Unleash instance. This will require correct region prefix and the instance name.
## Test your configuration

The correct format is: https://**[region]**.app.unleash-hosted.com/**[instanceName]**/auth/saml/callback
To test that things are working as expected, log out of Unleash and verify that the login screen gives you the option to sign in with SAML 2.0. You can also test the integration in Microsoft Entra in the single sign-on settings of your application.

:::

**d) Sections 3 and 4: Azure AD setup details {#azure-details}**

You will need some details from section 3 and 4 of the SAML setup form to configure the integration within Unleash. These details are:
- Azure AD Identifier (from section 4)
- Login URL (from section 4)
- X.509 Certificate (in the Federation Metadata XML from section 3)

<Figure caption="Section 3 contains a download link for the Federation Metadata XML file. Section 4 lists the Azure AD identifier and the login URL" img="/img/sso-azure-saml-azure-details.png"/>
<Figure caption="Within the Federation Metadata XML file, find the `X509Certificate` tag. You'll need the content within that tag." img="/img/sso-azure-saml-x509cert.png"/>

### Step 3: Configure SAML 2.0 provider in Unleash {#step-3}

In order to configure SSO with SAML with your Unleash enterprise you should navigate to the Single-Sign-On configuration section and choose the "SAML 2.0" tab.

![Unleash: sso-config screen](/img/sso-configure-saml.png)

Use the values from the [previous section](#azure-details) to fill out the form:
1. In the entity ID field, add the **Azure AD identifier**. It should look a little like this `https://sts.windows.net/**[identifier]**`.
2. In the single sign-on URL field, add the **login URL**. It should look something like `https://login.microsoftonline.com/**[identifier]**/saml2`
3. In the X.509 certificate field, add the content of the `X509Certificate` tag from the **federation metadata XML**.

Optionally, you may also choose to “Auto-create users”. This will make Unleash automatically create new users on the fly the first time they sign-in to Unleash with the given SSO provider (JIT). If you decide to automatically create users in Unleash you must also provide a list of valid email domains separated by commas. You must also decide which root Unleash role they will be assigned. Without this enabled you will need to manually add users to Unleash before SSO will work for their accounts and Unleash.

![Unleash: SAML 2.0 filled out with entity ID, Single Sign-On URL, and X.509 certificate and auto-creating users for users with the '@getunleash.ai' and '@getunleash.io' emaiil domains.](/img/sso-azure-saml-unleash-config.png)

### Validate {#validation}

If everything is set up correctly, you should now be able to sign in with the SAML 2.0 option. You can verify that this works by logging out of Unleash: the login screen should give you the option to sign in with SAML 2.0.
## Enable group syncing

You can also test the integration in Azure by using the "test single sign on" step in the SAML setup wizard.
Optionally, you can sync groups from Microsoft Entra ID to Unleash to [map them to groups in Unleash](../how-to/how-to-set-up-group-sso-sync.md).

<Figure caption="The SAML setup wizard contains a step that lets you test your SAML 2.0 integration. You can use this to verify that everything is configured correctly within Azure." img="/img/sso-azure-saml-test-user.png"/>
To create the group in Microsoft Entra, do the following:
1. In the Microsoft Entra admin center, go to the single sign-on settings of your application, and select **Attributes & Claims**.
2. Click **Add a group claim** and select **Groups assigned to the application**.
3. In the **Advanced options** click **Customize the name of the group claim**, and enter a name.
4. Click **Save**.

### Group Syncing {#group-syncing}

Optionally, you can sync groups from Azure AD to Unleash to [map them to groups in Unleash](../how-to/how-to-set-up-group-sso-sync.md).

**a) Add a group claim in Azure**
In section 2 (Attributes and claims) of the Azure SAML set-up, select the option to "Add a group claim".

Check the box to "Customize the name of the group claim" and update the "Name" to something simple, such as "groups".

Azure AD only supports sending a maximum of 150 groups in the SAML response. If you're using Azure AD and have users that are present in more than 150 groups, you'll need to add a filter in this section to the group claim to ensure that only the groups you want to sync are sent to Unleash.

![Azure: section 2, attributes and claims, adding a group claim with the name 'group'](/img/sso-azure-saml-group-setup.png)


**b) Unleash SSO Setup**
In the Unleash Admin SSO section, enable the option to "Enable Group Syncing".

Add the same "Name" you used from the previous section (eg. "groups") as the "Group Field JSON Path".

![Unleash: SAML 2.0 SSO setup, enabled group syncing with the Group Field JSON Path as 'groups'](/img/sso-azure-saml-unleash-group-settings.png)

**Note that Azure only supports sending up to 150 groups.** If you have more groups than this, you can setup a filter in Azure to only send the relevant groups to Unleash.
:::info Note
Microsoft Entra limits the number of groups emitted in a SAML response to 150, including nested groups. If you have users who are present in more than 150 groups, add a filter in the advanced section of group claims to ensure the response only includes the groups you want to send to Unleash.
:::

![Unleash: SAML 2.0 setup, filtering groups by name ](/img/sso-azure-saml-group-filtering.png)
To enable group syncing in Unleash, do the following:
1. In the Unleash Admin UI, go to **Admin > Single sign-on > SAML 2.0**.
2. Select **Enable Group Syncing** and add the name in your group in Group Field JSON Path.
3. Click **Save**.
2 changes: 1 addition & 1 deletion website/docs/how-to/how-to-add-sso-open-id-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: How to add SSO with OpenID Connect

:::note Availability

The **Single-Sign-On capability** is only available for customers on the Enterprise subscription. Check out the [Unleash plans](https://www.getunleash.io/plans) for details.
**Plan**: [Enterprise](https://www.getunleash.io/pricing)

:::

Expand Down
4 changes: 2 additions & 2 deletions website/docs/how-to/how-to-add-sso-saml-keycloak.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: How to add SSO with SAML 2.0 Keycloak

:::note Availability

The **Single-Sign-On capability** is only available for customers on the Enterprise subscription. Check out the [Unleash plans](https://www.getunleash.io/plans) for details.
**Plan**: [Enterprise](https://www.getunleash.io/pricing)

:::

Expand Down Expand Up @@ -49,7 +49,7 @@ Navigate to “Realm Settings” and open the “SAML 2.0 Identity Provider Meta

### Step 4: Configure SAML 2.0 Authentication provider in Unleash {#step-3}

Go back to Unleash Admin Dashboard and navigate to `Admin Menu -> Single-Sign-On -> SAML`. Fill in the values captured in the step 3.
Go back to Unleash Admin Dashboard and navigate to Admin Menu > Single-Sign-On > SAML. Fill in the values captured in the step 3.

- Entity ID (3b a)
- Single Sing-On URL (3a b)
Expand Down
3 changes: 1 addition & 2 deletions website/docs/how-to/how-to-add-sso-saml.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ title: How to add SSO with SAML 2.0 Okta

:::note Availability

The **Single-Sign-On capability** is only available for customers on the Enterprise subscription. Check out
the [Unleash plans](https://www.getunleash.io/plans) for details.
**Plan**: [Enterprise](https://www.getunleash.io/pricing)

:::

Expand Down
4 changes: 2 additions & 2 deletions website/docs/how-to/how-to-set-up-group-sso-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: How to Set Up User Group SSO Syncing
---

:::info availability
:::note Availability

User group syncing was released in Unleash 4.18 and is available for enterprise customers.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: 4.18+

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Enable SCIM by turning on the toggle and keep the token Unleash provides you for

:::info Note

This guide assumes you already have an SSO application setup for Unleash. If you don't already have an application configured, please see our [guide](../how-to/how-to-add-sso-azure-saml.md) on setting up SSO.
This guide assumes you already have an SSO application setup for Unleash. If you don't already have an application configured, please see our [guide](./how-to-add-sso-azure-saml.md) on setting up SSO.

:::

Expand Down
5 changes: 3 additions & 2 deletions website/docs/how-to/how-to-setup-sso-keycloak-group-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
title: 'How to set up Keycloak and Unleash to sync user groups'
---

:::info availability

User group syncing was released in Unleash 4.18 and is available to enterprise customers.
:::note Availability

**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: 4.18+

:::

Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ Unleash enterprise supports multiple authentication providers.
- [OpenID Connect with Okta](../how-to/how-to-add-sso-open-id-connect.md)
- [SAML 2.0 with Okta](../how-to/how-to-add-sso-saml.md)
- [SAML 2.0 with Keycloak](../how-to/how-to-add-sso-saml-keycloak.md)
- [SAML 2.0 with Azure](../how-to/how-to-add-sso-azure-saml.md)
- [SAML 2.0 with Microsoft Entra ID](../how-to/how-to-add-sso-azure-saml.md)
- [Google Authentication](../how-to/how-to-add-sso-google.md) (deprecated)
8 changes: 4 additions & 4 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -533,20 +533,20 @@ module.exports = {
},
},
{
label: 'Single Sign-On (SSO)',
label: 'Single sign-on SSO',
items: [
'how-to/how-to-add-sso-open-id-connect',
'how-to/how-to-add-sso-saml',
'how-to/how-to-add-sso-saml-keycloak',
'how-to/how-to-add-sso-google',
'how-to/how-to-add-sso-azure-saml',
'how-to/how-to-setup-sso-keycloak-group-sync',
'how-to/how-to-add-sso-google',
],
type: 'category',
link: {
type: 'generated-index',
title: 'How-to: Single Sign-On',
description: 'Single Sign-On how-to guides.',
title: 'How-to: Single sign-on',
description: 'Single sign-on guides.',
slug: '/how-to/sso',
},
},
Expand Down
melindafekete marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/static/img/saml2.0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed website/static/img/sso-azure-saml-name-app.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed website/static/img/sso-azure-saml-test-user.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed website/static/img/sso-azure-saml-x509cert.png
Binary file not shown.
Binary file added website/static/img/x509cert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading