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.

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

miniorange img  Login as Administrator

  • Go to and login with your G Suite administrator account.
  • Go to Apps from the left menu and click SAML Apps.

    google app sso-1
miniorange img  Add a SAML app

  • Click on the “+” button at the bottom right corner to create a new SAML app.
  • Select button SETUP MY OWN CUSTOM APP

    google app sso-2
miniorange img  IDP Information

  • Download IDP metadata from option 2. This is necessary for later configuration of the add-on.
  • You can also copy G Suite details from Option 1 and download the certificate to configure the add-on  manually.
  • Click Next.

    google app sso-3
miniorange img  Service Provider Details

    google app sso-4
  • Enter details from the SP Info tab in the add-on as given below.

    Information to be entered in G Suite Information to copy from the add-on in SP Info tab
    Entity ID SP Entity ID/ Issuer
    Signed Response
    Name ID Format EMAIL
  • Click Next.
miniorange img  Attribute Mapping

  • Click on Add New Mapping
  • Add mapping for first name and last name
  • Click on Finish

    google app sso-5
miniorange img  Turn on

  • By Default SAML Apps are turned off for everyone.
  • Select Edit Service option.
  • google app sso-6
  • Change the setting to select ON for everyone to activate SSO.

    google app sso-7

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.