What's New !!

Pricing Offers

We are happy to announce special offers for miniOrange Atlassian SSO, 2FA, REST API, User Sync and Group Sync Apps.

View Offers Now

Contact Info

For any query, product related information or any help , contact us now. You can also raise a ticket with our support.

 

Contact Us Now

SAML Single Sign On (SSO) into SonarQube using Google Apps/G Suite

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 GoolgeApps/G Suite. By the end of this guide, GoogleApps/G Suite 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 Google Apps/G Suite as Identity Provider

      Follow the following steps to set up Google Apps / G Suite as an Identity Provider


      Single Sign On using Google Apps/G-Suite, Google Apps/G-Suite SSO Login  Login as Administrator

        • Go to https://admin.google.com and login with your G Suite administrator account.
        • Navigate to the Apps tab in the left menu and click on Web and mobile apps.
          • Google Apps SSO Login Add SAML app
      Single Sign On using Google Apps/G-Suite, Google Apps/G-Suite SSO Login  Add a SAML app

        • Click on the Add App button, then in the dropdown select Add Custom SAML app tab to create a new saml app.
          • Google Apps SSO Login Setup own custom app
        • Enter details for your custom SAML app and click on Continue button.
          • Google Apps SSO Login, Setup own custom app1
      Single Sign On using Google Apps/G-Suite, Google Apps/G-Suite SSO Login  IDP Information

        • Click on Download Metadata button. This will be used for configuring your Service Provider.
        • You can also copy G Suite details like SSO URL, entity ID and Certificate to configure the Service Provider manually and then click on Continue button.
          • Google Apps SSO Login, SAML custom app Basic Information
      Single Sign On using Google Apps/G-Suite, Google Apps/G-Suite SSO Login  Service Provider Details

        • Enter details from the Service Provider Metadata tab in the SAML SP plugin.
          • ACS URL Copy and paste the ACS URL from the plugin.
          Entity ID Copy and paste the SP Entity ID/ Issuer from the plugin.
          Signed Response Check Signed Response ✓
          Name ID Format EMAIL
        • Click on Continue button.
          • Google Apps SSO Login, Service provider details
      Single Sign On into Google Apps/G-Suite, Google Apps/G-Suite SSO Login  Attribute Mapping

        • Click on Add Mapping button.
          • Google Apps SSO Login, Attribute mapping details
        • Add and select user fields in Google Directory, then map them to Service Provider attributes and Click on Finish button.
          • Google Apps SSO Login, Attribute mapping details
      Single Sign On using Google Apps/G-Suite, Google Apps/G-Suite SSO Login  Turn on

        • Go to SAML Apps again and click on OFF for everyone .
          • Google Apps SSO Login, Turn-On go to SAML Apps
        • Then, select ON for everyone to activate SSO.
        • Note: All the users will be asked to SSO to access G Suite Apps and they will not be able to login normally using a username and password.
          • Google Apps SSO Login, Turn-On go to SAML Apps 1

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. 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, 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.
      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 tab in the plugin support page.
    • 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


Free Trial

If you don't find what you are looking for, please contact us at support-atlassian@miniorange.atlassian.net or raise a support ticket here.