Transitioning your enterprise to SAML SSO
With the Enterprise plan, you can transition from the DevOps platform (DOP) authentication mode to SAML SSO.
To transition your enterprise to SAML SSO:
- Verify the user groups of the enterprise's organizations: see below.
- Register SonarQube Cloud in the SAML identity provider.
- Configure SAML SSO for your enterprise in SonarQube Cloud. This step must be performed by an enterprise admin.
- Perform post-configuration steps: see below.
Verifying the user groups of the enterprise's organizations
To ensure that the automatic group synchronization can take place properly, verify that:
- The user groups defined in your IdP service exist in the relevant organizations of your SonarQube Cloud enterprise (i.e. a group with the same (context-sensitive) name exists in the relevant organization(s)).
- The user groups in SonarQube Cloud have the correct permissions.
To manage the user groups in SonarQube Cloud, see Managing the user groups in your organization.
Group definition example
The figure below shows a group definition example with Okta as IdP.
Microsoft Entra ID's SAML tokens have a limit regarding the number of groups a user can belong to (see the description of groups in the Claims in SAML Token table). In such cases, you might need to reduce the number of groups the user is in.
Post-configuration steps
- Test the SSO connection.
- Send the SSO login URL to invite enterprise users to sign in to SonarQube Cloud with SSO. Once they have signed in, their SAML SSO account is created in SonarQube Cloud and they have access to their organization(s) through the automatic group synchronization with the identity provider. They should:
- Check that they have access to their organization(s) and can perform their tasks as before.
- Generate their analysis tokens with their SAML SSO account. (They can still use their DevOps platform service (DOP) account tokens to execute analysis as long as their DOP account still exists).
- Sign up with SonarQube Cloud by using the enterprise’s SSO log in URL. Your SAML SSO account is created.
- Sign in to SonarQube Cloud with your DOP account and grant your SAML SSO account the Administer Enterprise permission.
- Once the enterprise users have successfully transitioned to SAML SSO (and, during a trial, once you are sure you want to purchase the Enterprise plan), you can remove their DOP accounts from the organizations and the users can delete their DOP account. We recommend that you don’t remove the admin DOP accounts since, with a SAML SSO account, you currently cannot bind a SonarQube Cloud organization with the corresponding DOP organization.
When created, SAML SSO accounts will have no history. That means that comments on issues, favorite projects, etc., will not be transferred from the corresponding DOP account's history.
Was this page helpful?