> For the complete documentation index, see [llms.txt](https://docs.sonarsource.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sonarsource.com/sonarqube-server/10.8/instance-administration/authentication/saml/ping-identity/setup-in-ping-identity.md).

# Setup in Ping Identity

This page explains how to register SonarQube Server 10.8 in PingOne (or PingFederate). This is the first step of SAML authentication setup with Ping Identity.

{% hint style="info" %}
**For AI agents:** You're in the SonarQube Server 10.8 documentation. For a list of all 10.8 pages, see the [SonarQube Server 10.8 page index](https://312504542-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiJj3TXBdWssTGGg8qK5I%2Fuploads%2FmeJ1nVNGPezOurNrTy4A%2Fsonarqube-server-10.8-llms.txt?alt=media). For the whole site, see the [page index](https://docs.sonarsource.com/llms.txt) or the [full text](https://docs.sonarsource.com/llms-full.txt). For another version, replace 10.8 in the URL with that version. The [latest version](https://docs.sonarsource.com/sonarqube-server/) has no version number in its URL.
{% endhint %}

This page explains how to register SonarQube Server in PingOne. The procedure with PingFederate is similar (The properties and values to be configured are the same.). This is the first step of SAML authentication setup with Ping Identity. For an overview of the complete setup, see [Introduction](/sonarqube-server/10.8/instance-administration/authentication/saml/ping-identity/introduction.md).

## Step 1: Create the SAML application for SonarQube Server <a href="#create-saml-app" id="create-saml-app"></a>

1\. In PingOne, go to **Applications > Applications**.

2\. Select the **+** icon.

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

3\. Enter the application name and description.

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

4\. In **Choose Application Type**, select **SAML Application**.

5\. Select **Configure**.

6\. Select the **Manually Enter** option and set:

* * **ACS URL** (Assertion Consumer Service): Must be in the format: `<sqServerBaseUrl>/oauth2/callback/saml`

Example: `https://my-sonarqube.com/oauth2/callback/saml`

* * **Entity ID:** Identifier of the application for SonarQube Server in PingOne\
    Example: `sonarqube`

7\. Select **Save**.

## Step 2: Configure the application <a href="#configure-app" id="configure-app"></a>

1\. Go to the **Attribute mappings** tab of the application for SonarQube Server you created in step 1 (To retrieve the application, go to **Applications > Applications** and open the application details page.**)**.

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

2\. Select the pencil icon and the **+Add** button to add an attribute mapping: select a PingOne user attribute and map it to an attribute in the application. See the example below.

<details>

<summary>SAML attribute mapping example</summary>

| SAML attribute in the application | PingOne user attribute | Description                                                                                                                                                                                                 |
| --------------------------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| saml\_subject                     | User ID                | <p><br></p>                                                                                                                                                                                                 |
| login                             | Family Name            | A unique name to identify the user in SonarQube Server.                                                                                                                                                     |
| name                              | Given Name             | User name.                                                                                                                                                                                                  |
| email                             | Email Address          | User email address.                                                                                                                                                                                         |
| <p><br></p><p>group\_names</p>    | Group Names            | Required only if you use the group synchronization feature (If a matching group is found in SonarQube Server, the Entra ID user account’s memberships in that group are synchronized in SonarQube Server.). |

</details>

3\. Select **Save**.

4\. Go to the **Configuration** tab and select the **Download Metadata** button to download the SAML metadata containing your X.509 certificate.

## Step 3: Enable the application <a href="#enable-app" id="enable-app"></a>

1. In PingOne, retrieve the application: go to **Applications > Applications** and open the application details page.
2. In the top right corner of the application, select the toggle button.

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

## Step 4: Assign users and groups to the application <a href="#assing-users" id="assing-users"></a>

1. To create users, go to **Identities > Users** and select **+ Add User**.
2. To create a group:
   * Go to **Identities > Groups.**
   * Select **+** to create and save a group.
   * On the page of the new group, open the **Users** tab, and add users to the group.

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

* [Overview](/sonarqube-server/10.8/instance-administration/authentication/saml/overview.md)
* [Setup in SonarQube Server](/sonarqube-server/10.8/instance-administration/authentication/saml/ping-identity/setup-in-sq.md)
* [Setup of security features](/sonarqube-server/10.8/instance-administration/authentication/saml/ping-identity/optional-security-features.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.sonarsource.com/sonarqube-server/10.8/instance-administration/authentication/saml/ping-identity/setup-in-ping-identity.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
