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 Okta. By the end of this guide, Okta users should be able to log in and register to the SonarQube Server.
Step 1: Setup Okta as Identity Provider
Follow the steps below to configure Okta as an Identity Provider
Configuring Okta as IdP
- Log into Okta Admin Console. For developer account, switch to Classic UI to configure app.
- Go to the Application from the left menu and then click on Add Application.
- Click on Create New App.
- Select SAML 2.0 as Sign on method.
- Click on Create.
- In General Settings, enter App Name and click on Next.
- In SAML Settings, enter the following:
| Single Sign On URL |
Enter ACS (AssertionConsumerService) URL from the Service Provider info tab of the module. |
| Audience URI (SP Entity ID) |
Enter SP Entity ID / Issuer from the Service Provider info tab of the module. |
| Default Relay State |
Enter Relay State from the Service Provider info tab of the module. |
| Name ID Format |
Select E-Mail Address as a Name Id from dropdown list. |
| Application Username |
Okta username. |
- Configure Attribute Statements and Group Attribute Statement (Optional).
- For Name, enter "firstName" and select user.firstName from the value dropdown.
- For Name, enter "lastName" and select user.lastName from the value dropdown.
- For Name, enter "Email" and select user.email from the value dropdown.
- For Name, enter "groups" and select Matches regex from the Filter dropdown and enter ".*"
×
![]()
Step 2: Configure SonarQube as Service Provider.
Test Configuration
- 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 SonarQube Logs.
- 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 %SONARQUBE_HOME% / logs directory.
- 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].
×
![SAML_sso_Click on Manage Apps]()
×
![]()
If you don't find what you are looking for, please contact us at info@xecurify.com or call us at +1 978 658 9387.
