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


Single Sign On using GoogleApps, GoogleApps SSO Login-6  Login as Administrator

  • Go to https://admin.google.com and login with your G Suite administrator account.
  • Go to Apps from the left menu and click SAML Apps.

    SAML Single Sign On (SSO) using GoogleApps Identity Provider, SAML Apps
Single Sign On using GoogleApps, GoogleApps SSO Login-6  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

    SAML Single Sign On (SSO) using GoogleApps Identity Provider, Setup Custom App to Enable SSO
Single Sign On using GoogleApps, GoogleApps SSO Login-8  IDP Information

  • Copy G Suite details from Option 1 of Step 2 and download the Certificate to configure the add-on manually.
  • OR You can also download the IDP metadata from Option 2 of Step 2, and then click Next.
  • Fill up the Basic Information for custom App such as Application Name( Eg. SAML App) and Description as per your choice.
  • Click Next.

    SAML Single Sign On (SSO) using GoogleApps Identity Provider, Fill Basic Information for Custom App
Single Sign On using GoogleApps, GoogleApps SSO Login-10  Service Provider Details

    SAML Single Sign On (SSO) using GoogleApps, Fill Service Provider Details
  • 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
    ACS URL ACS URL
    Entity ID SP Entity ID/ Issuer
    Signed Response
    Name ID Format EMAIL
  • Click Next.
Single Sign On into GoogleApps, GoogleApps SSO Login-1  Attribute Mapping

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

    SAML Single Sign On (SSO) using GoogleApps Identity Provider, Attribute Mapping
Single Sign On using GoogleApps, GoogleApps SSO Login-3  Turn on

  • By Default SAML Apps are turned off for everyone.
  • Select Edit Service option.
  • SAML Single Sign On (SSO) using GoogleApps Identity Provider, Edit Service
  • Change the setting to 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.


  • SAML Single Sign On (SSO) using GoogleApps Identity Provider, Assign App to Everyone

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, 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

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.