# Setup in SonarQube

This page explains how to set up SAML with Ping Identity in SonarQube. This is the second step of the SAML authentication setup with Ping Identity. For an overview of the complete setup, see [Introduction](/sonarqube-server/10.7/instance-administration/authentication/saml/ping-identity/introduction.md).

Proceed as follows:

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

2\. Select **Create Configuration**.

![](/files/FBv3TvMhPXvtWZNWX9uO)

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

* Some fields must be filled with the values set in the application created in PingOne (or PingFederate) during the [Setup in Ping Identity](/sonarqube-server/10.7/instance-administration/authentication/saml/ping-identity/setup-in-ping-identity.md). To retrieve these values, retrieve the application in PingOne as follows: go to **Applications > Applications** and open the application’s detail page.
* Some fields must be filled with values retrieved from the metadata file downloaded in **Step 2** of [Setup in Ping Identity](/sonarqube-server/10.7/instance-administration/authentication/saml/ping-identity/setup-in-ping-identity.md).

| **Field in SonarQube**        | Description                                                                                         |
| ----------------------------- | --------------------------------------------------------------------------------------------------- |
| Application ID                | In the application’s **Configuration** tab: **Entity ID**.                                          |
| Provider ID                   | Is retrieved from the downloaded metadata file. See below.                                          |
| Provider Name                 | Name of the Identity Provider displayed in SonarQube login page when SAML authentication is active. |
| SAML Login URL                | Is retrieved from the downloaded metadata file. See below.                                          |
| Identity provider certificate | Is retrieved from the downloaded metadata file. See below.                                          |
| SAML user login attribute     | `login`                                                                                             |
| SAML user name attribute      | `name`                                                                                              |
| SAML user email attribute     | `email`                                                                                             |
| SAML group attribute          | `group_names`                                                                                       |

<details>

<summary>Retrieving values from the downloaded metadata file</summary>

1\. Open the metadata file (`saml2-metadata-idp-<UUID>.xml`) you downloaded in **Step 2** of [Setup in Ping Identity](/sonarqube-server/10.7/instance-administration/authentication/saml/ping-identity/setup-in-ping-identity.md). This file contains your X.509 certificate.

2\. Find the `<md:EntityDescriptor...` node and look for the `entityID` attribute. Set this value as your SonarQube SAML **Provider ID**.

![](/files/SxnMkfzPp71Hzesa8g61)

3\. Find the first instance of `<md:SingleSignOnService...` node and look for the `Location` attribute. Set this value as your SonarQube **SAML Login URL**.

![](/files/EdP1kmrEs0zdTXRZT5l4)

4\. Find the `<ds:X509Certificate>` node. Set its contents as the SonarQube **Identity provider certificate**. Note that end-of-line spaces and new line characters are fine, it does not need to be all on one line of text.

![](/files/uc0b7CGBasA1LLe6RSuP)

</details>

4\. Save the configuration.

5\. Before enabling SAML authentication on SonarQube, 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 login form now contains a SAML login button.

![](/files/MnDu1rVnJhqfempbgM0I)

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

* [Overview](/sonarqube-server/10.7/instance-administration/authentication/saml/overview.md)
* [Setup in Ping Identity](/sonarqube-server/10.7/instance-administration/authentication/saml/ping-identity/setup-in-ping-identity.md)
* [Setup of security features](/sonarqube-server/10.7/instance-administration/authentication/saml/ping-identity/optional-security-features.md)


---

# 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.7/instance-administration/authentication/saml/ping-identity/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.