SAML Single Sign On (SSO) into SonarQube using Okta

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

miniorange img Configuring Okta as IdP

  • Log into Okta Admin Console. Select "Classic UI" and then Application.
  • Okta SSO-new
  • Click on Add Applications.
  • Okta SSO-1
  • Click on Create New App.
  • Select SAML 2.0 as Sign on method.
  • Click on Create.
  • Okta SSO-2
  • In General Settings, enter App Name and click on Next.
  • In SAML Settings, enter the following:
  • Okta SSO-3
    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 from the value dropdown.

    For Name, enter "groups" and select Matches regex from the Filter dropdown and enter ".*"

    Okta SSO-4

miniorange img Assigning Groups/People

  • After creating and configuring the app go to the Assignment Tab in Okta.
  • Here we select the peoples and groups you want to give access to log in through this app. Assign this to the people/group you would to give access to.
  • Okta SSO-5
  • After assigning the people/groups to your app, go to Sign On tab.
  • Click on View Setup Instructions to get the SAML Login URL (Single Sign on URL), Single Logout URL, IDP Entity ID and X.509 Certificate. You will need this to configure the Service Provider.
  • Okta SSO-6

miniorange img Okta Verified SAML App

  • You can setup your plugin with our Okta Verified SAML app.
  • Okta verified SAML apps for all atlassian products like Jira and Confluence can be setup easily.
  • Search Miniorange in the search application box and add the app as per your requirements.
  • Okta SSO-5

Step 2: Configure SonarQube as Service Provider.

    miniorange img  Fetch the Identity Provider (IdP) Details

    • After configuring the IdP, get its metadata to configure SonarQube as a Service Provider(SP).
    • Copy the following details from the IdP metadata and paste them into the corresponding text fields in the SonarQube plugin.
      1. 1. IdP Entity ID
        2. Login URL
        3. X.509 Certificate

    • Save all the details.
    • sonarqube saml single sign on (sso) plugin - idp_details

    miniorange img  Test Configuration

    • Once you have filled all the IdP details, click on the Test Configuration button.
    • It will take you to 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.
      sonarqube saml single sign on (sso) plugin - test_configuration

    miniorange img  Attribute & Group Mapping

    • In order to map attributes from the Identity Provider to the application, the attribute names received in the SAML response need to be entered in their corresponding fields.
    • To view these attribute names, click on the Test Configuration button in the plugin.
    • Attributes used in SonarQube Application are described briefly as below:
  1. Login Attribute is a unique name assigned to the user to identify them uniquely within the SonarQube system. It's a required attribute.

  2. Name Attribute is the full name of the user, to be mapped from the IdP to the SonarQube. It's a required attribute.

  3. Email Attribute is an optional attribute and represents an email address of the user, to be mapped from the IdP to the SonarQube.

  4. 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].
    • sonarqube saml single sign on (sso) plugin - attribute_mapping

If you don't find what you are looking for, please contact us at or call us at +1 978 658 9387.