AWS IAM Identity Center (successor to AWS SSO) Integration Guide for SonarQube
Introduction
This document helps you configure IAM Identity Center to facilitate single sign-on (SSO) for SonarQube using SAML.
Topics
Prerequisites
You’ll need the following to set up SSO access to SonarQube:
-
Access to the IAM Identity Center console with permissions to manage applications.
-
A SonarQube account with permissions to configure SAML SSO.
-
SonarQube supports only SP (Service Provider) initiated flow.
Setup instructions
- On the Configure page in the IAM Identity Center Console, in the Details section, fill in the Display name, and the Description(optional) of the application.
Note
We suggest that you choose a unique display name if you plan to have more than one of the same application.
-
Login to your SonarQube account as an administrator.
-
On the home page, choose Administration, then choose Marketplace.
-
Under Plugins, search for SAML 2.0 Authentication for SonarQube and then choose Install.
-
Wait for notification pop up asking SonarQube needs to be restarted in order to install x plugins, choose Restart, then Restart again.
-
In the left navigation pane, expand User Management, expand Identity Provider and then choose SAML.
-
Insert these values:
- Download the IAM Identity Center certificate and paste it's content in Provider certificate. Remove the -----BEGIN CERTIFICATE----- and -----END CERTIFICATE----- from the certificate content copied.
- Insert these values:
Field | Value |
---|---|
SAML user login attribute | login |
SAML user name attribute | username |
SAML user email attribute |
-
Scroll to the top of the SAML configuration page, and enable the toggle next to Enabled.
-
Go back to the IAM Identity Center console page where you are configuring the Application.
-
Under Application properties, insert the value:
Field | Value |
---|---|
Application start URL | https://SONARQUBEURL/sessions/init/saml?return_to=%2F |
- Under Application metadata, choose If you don't have a metadata file, you can manually type your metadata values. to display the application metadata settings. Insert these values:
Field | Value |
---|---|
Application ACS URL | https://SONARQUBEURL/oauth2/callback/saml |
Application SAML audience | sonarqube |
-
Choose Save Changes.
-
Assign a user to the application in IAM Identity Center.
Verification
Use the following sections to verify the SSO integration.
Note
Ensure that the user performing the verification is logged out of both IAM Identity Center and the application before performing the steps in each section.
Verifying SSO from IAM Identity Center
-
Access the AWS access portal using the credentials of a user assigned to the SonarQube application.
-
In the list of applications, choose SonarQube to initiate a login to SonarQube.
-
If login was successful you will be signed-in to the SonarQube application.
Troubleshooting
If sign in was not successful, please see the troubleshooting steps.
Verifying Service Provider Initiated SSO from SonarQube
-
Access SonarQube http://SONARQUBEURL/sessions/init/saml?return_to=%2F.
-
You will be redirected to the IAM Identity Center user portal login page.
-
Type the credentials of a user assigned to the application in the IAM Identity Center console.
-
Choose Sign In.
-
On the SonarQube home page, verify that both Cloud CMS and IAM Identity Center are logged in with the same user.
Troubleshooting
If sign in was not successful, please see the troubleshooting steps.
Troubleshooting
Error | Issue | Solution |
---|---|---|
Other | When IAM Identity Center creates a SAML Assertion for a user, it uses the value of the 'email' and 'subject' fields (if they are present) from the connected directory to populate the 'Email' and 'Subject' attributes in the SAML assertion. Many service providers expect these attributes to contain the user’s email address. By default your directory is configured to send 'windowsUPN' in both fields. | Your directory may be configured to contain the users email in the 'Email' attribute instead. If so, you may need to change this in your Connected directory settings. |
For general troubleshooting problems, please refer to Troubleshooting Guide.
User Provisioning Types
There are two user provisioning you need to aware of:
-
Preprovisioned users
Preprovisioned users, means users must already exist in the downstream SaaS application. For instance, you may need to create SaaS users with the same subject as the AD users.
-
JIT users
JIT (or Just-In-Time) users, means users do not necessarily exist in the downstream SaaS application, and will be provisioned/created/registered the first time the user federates. You may need to enable JIT option in your SaaS application for the AD domain.