# Setup in SonarQube Server

This page explains how to set up SAML in SonarQube Server when using Microsoft Entra ID as the identity provider. This is the second step of SAML authentication setup with Microsoft Entra ID. For an overview of the complete setup, see [introduction](https://docs.sonarsource.com/sonarqube-server/10.8/instance-administration/authentication/saml/ms-entra-id/introduction "mention").

Proceed as follows:

1. Open MS Entra ID to prepare the copy-paste of single-sign-on settings in SonarQube Server.
2. Configure SAML in SonarQube Server.

## Open MS Entra ID <a href="#open-entra-id" id="open-entra-id"></a>

To prepare the copy-paste of single-sign-on settings in SonarQube Server:

1. In Microsoft Entra ID, go to **Identity** > **Applications** > **Enterprise applications** > **All applications and** select the application you created for SonarQube Server.
2. On the application’s page, select **Single sign-on**. You will need to retrieve values related to sections **1**, **2**, and **4**. In section **2**, select **Edit** first to open the **Attributes & Claims** page.

![](https://312504542-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiJj3TXBdWssTGGg8qK5I%2Fuploads%2Fgit-blob-c56ef6eb0b9ab52116129dde22c0de42dc27c43d%2Fbb2c0cebaba5b6f48ed2ee534ac03bf2703703a4.png?alt=media)

## Configure SonarQube Server <a href="#configure-sq" id="configure-sq"></a>

1\. Go to **Administration > Configuration > General Settings > Authentication> SAML**.

2\. Select **Create Configuration**.

![](https://312504542-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiJj3TXBdWssTGGg8qK5I%2Fuploads%2Fgit-blob-941d3baa942653e8bf71b0764b15cde018ce0607%2F9234c56e45de9d269bfd986b068a2a2f183ae440.png?alt=media)

3\. Fill in the fields as explained in the table below.

| **Field in SonarQube Server** | Description                                                                                                                                                                                                                                                                                              |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Application ID                | Value in MS Entra ID:In the **Basic SAML Configuration** section (**1**), value of the **Identifier(Entity ID)** field.                                                                                                                                                                                  |
| Provider ID                   | Value in MS Entra ID:In the **Set up \<applicationForSonarQubeServer>** section (**4**), value of the **Microsoft Entra ID Identifier** field.                                                                                                                                                           |
| Provider Name                 | Name of the Identity Provider displayed in SonarQube Server login page when SAML authentication is active.                                                                                                                                                                                               |
| SAML Login URL                | Value in MS Entra ID:In the **Set up \<applicationForSonarQubeServer>** section (**4**), value of the **Login URL** field.                                                                                                                                                                               |
| Identity provider certificate | Certificate downloaded in **Step 2** of [setup-in-entra-id](https://docs.sonarsource.com/sonarqube-server/10.8/instance-administration/authentication/saml/ms-entra-id/setup-in-entra-id "mention").                                                                                                     |
| SAML user login attribute     | <p>Value in MS Entra ID:In the <strong>Attributes & Claims</strong> section (<strong>2</strong>), select <strong>Edit</strong> and retrieve the <strong>Claim name</strong> (URL type value) of the attribute to be used for Login.</p><p>For an example, see the SonarQube Server screenshot below.</p> |
| SAML user name attribute      | <p>Value in MS Entra ID:In the <strong>Attributes & Claims</strong> section (<strong>2</strong>), select <strong>Edit</strong> and retrievethe <strong>Claim name</strong> (URL type value) of the attribute to be used for Name.</p><p>For an example, see the SonarQube Server screenshot below.</p>   |
| SAML user email attribute     | <p>Optional.<br>Value in MS Entra ID:In the <strong>Attributes & Claims</strong> section (<strong>2</strong>), select <strong>Edit</strong> and retrieve the <strong>Claim name</strong> (URL type value) of the attribute to be used for email.</p>                                                     |
| SAML group attribute          | <p>Optional (if you want to use the group synchronization).<br>Value in MS Entra ID:In the <strong>Attributes & Claims</strong> section (<strong>2</strong>), select <strong>Edit</strong> and retrieve the <strong>Claim name</strong> (URL type value) of the <code>groups</code> attribute.</p>       |

Below is a SonarQube Server screenshot with SAML user login and name value examples.

![](https://312504542-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiJj3TXBdWssTGGg8qK5I%2Fuploads%2Fgit-blob-de8fced6f0907082813307f766dcf89fc19147aa%2Fdf3b35e6d38519ae6cac9aca777ed529296a7a44.png?alt=media)

4\. Save the configuration.

5\. Before enabling SAML authentication on SonarQube Server, you can verify that the configuration is correct by selecting **Test Configuration**. This will initiate a SAML login and return useful information about the SAML response obtained from the identity provider.

6\. Select **Enable configuration**.

7\. Check that the SonarQube Server login form now contains a SAML login button.

![](https://312504542-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiJj3TXBdWssTGGg8qK5I%2Fuploads%2Fgit-blob-41954772102054ac237e088497505128a7d5a975%2F88f43194c006c28bb6715026f6a1ec08f076d504.png?alt=media)

## Related pages <a href="#related-pages" id="related-pages"></a>

* [overview](https://docs.sonarsource.com/sonarqube-server/10.8/instance-administration/authentication/saml/overview "mention")
* [setup-in-entra-id](https://docs.sonarsource.com/sonarqube-server/10.8/instance-administration/authentication/saml/ms-entra-id/setup-in-entra-id "mention")
* [optional-security-features](https://docs.sonarsource.com/sonarqube-server/10.8/instance-administration/authentication/saml/ms-entra-id/optional-security-features "mention")
* [scim-provisioning-with-azure-ad](https://docs.sonarsource.com/sonarqube-server/10.8/instance-administration/authentication/saml/scim/scim-provisioning-with-azure-ad "mention")


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.sonarsource.com/sonarqube-server/10.8/instance-administration/authentication/saml/ms-entra-id/setup-in-sq.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.