SonarQube SAML plugin gives the ability to enable SAML Single Sign On for the SonarQube. Here we will go through a guide to configure SSO between SonarQube and Salesforce. By the end of this guide, Salesforce users should be able to log in and register to the SonarQube Server.
You can refer the steps from the video or documentation below to configure your IDP with SonarQube.
Step 1: Setup Salesforce as Identity Provider
Log into your
Salesforce account. Switch to
Salesforce Classic mode from profile menu and then go to the Setup page. From the left pane, select
Security Controls. Identity Provider In the
Service Provider section, click on the link to create the Service Provider using Connected Apps.
Connected App Name, API Name and Contact Email.
Web App Settings, check the Enable SAML checkbox and enter the following values:
SP-EntityID / Issuer from
Service Provider Info Tab
ACS (AssertionConsumerService) URL from
Service Provider Info Tab
Name ID Format
Now from the left pane, under
Administer section, go to Manage Apps. Click on the app you just created. Connected Apps Under
Profiles section click Manage Profiles button and select the profiles you want to give access to log in through this app. Under
SAML Login Information, click on Download Metadata. Keep this metadata handy for the next steps.
Step 2: Configure SonarQube as Service Provider.
1. IdP Entity ID
2. Login URL
3. X.509 Certificate
Save all the details.
Once you have filled all the IdP details, go to
Administration >>Configuration >>miniOrange SAML Support and then click on the Test Configuration tab. It will show you the IdP login page. Enter your
IdP credentials and log in. If all the configurations are correct, it will show you the user details received from the IdP.
If the test fails, check if you have missed out any steps or try to debug through
To be able to troubleshoot through logs, first you'll have to set a higher log level in your SonarQube application.
To do so, go to the SonarQube Dashboard >>Administration >>System.
Under the system settings, you'll find an option to change the log's level. Select DEBUG and save it. Now try to configure the plugin.
If you face any problem during configuration, go to directory. %SONARQUBE_HOME% / logs
Find and open the web.log file. Go through the logs recorded.
You'll find the stacktrace of performed actions, along with date and time information.
To know more about the
SonarQube Logs click here.
Login Attribute is a unique name assigned to the user to identify them uniquely within the SonarQube system. It's a required attribute.
Name Attribute is the full name of the user, to be mapped from the IdP to the SonarQube. It's a required attribute.
Email Attribute is an optional attribute and represents an email address of the user, to be mapped from the IdP to the SonarQube.
Group Attribute mapping requires the group names, in the application, to be same as the group names in the Identity Provider. Otherwise, the default SonarQube Group is assigned to the user.
Eg. To map group value
Everyone from SAML response we have to paste groupName in Group Attribute field [Refer with above image].