Configuring SAML with Ping Identity in SonarQube Server
On this page
This page explains how to set up SAML with Ping Identity in in SonarQube Server. This is the second step of SAML authentication setup with Ping Identity. For an overview of the complete setup, see Setting up SAML with Ping Identity.
Proceed as follows:
1. Go to Administration > Configuration > General Settings > Authentication> SAML.
2. Select Create Configuration.
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. 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.
| Field in in SonarQube Server | 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 in SonarQube Server 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 |
Retrieving values from the downloaded metadata file
1. Open the metadata file (saml2-metadata-idp-<UUID>.xml) you downloaded in Step 2 of Setup in Ping Identity. 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 Server's SAML Provider ID.
3. Find the first instance of <md:SingleSignOnService... node and look for the Location attribute. Set this value as your in SonarQube Server's SAML Login URL.
4. Find the <ds:X509Certificate> node. Set its contents as the in SonarQube Server's 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.
4. Save the configuration.
5. Before enabling SAML authentication on in 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.
Related pages
Was this page helpful?
© 2008-2024 SonarSource SA. All rights reserved. SONAR, SONARSOURCE, SONARQUBE, and CLEAN AS YOU CODE are trademarks of SonarSource SA.
