SCIM with Microsoft Entra ID

Enable SCIM to automate user and group provisioning from Microsoft Entra ID to SonarQube Server.

Automatic provisioning through SCIM is available starting in Enterprise Edition.

You can enable SCIM to automate user and group provisioning from Microsoft Entra ID (previously known as Azure AD) to SonarQube Server. For an overall understanding of the feature, read the SCIM overview page.

Prerequisites

  • You have a working SAML configuration. See Introduction to SAML with Microsoft Entra ID.

  • The connection from the Identity Provider to SonarQube must not be blocked on the network (unlike SAML, SCIM requires a direct network connection from the Identity Provider to SonarQube).

Configuring SonarQube Server

1. Within SonarQube Server, go to Administration > Authentication > SAML.

2. Under Provisioning, click Automatic user and group provisioning with SCIM.

3. Click Save and validate the pop-up window if you are sure you want to enable SCIM.

SCIM is now enabled in SonarQube Server, it will handle all the queries coming from Microsoft Entra ID about users and groups.

Configuring Microsoft Entra ID

  1. In Microsoft Entra ID, go to Identity > Applications > Enterprise applications > All applications and select the application created for SonarQube Server. On the application’s page, select Provisioning.

Select Manage > Provisioning in MS Entra ID to start the SCIM configuration
  1. On the Provisioning page, click Get started.

  2. Under Provisioning Mode, select Automatic.

  3. Configure the Admin Credentials section as follows:

    • Tenant Url: <sqServerBaseUrl>/api/scim/v2

    • Secret token: Paste a SonarQube Server's user-type token (see Managing your tokens) for an admin account in this field. For safety reasons, we recommend using a token from a local admin account (not managed through SCIM).

In the Provisioning page of MS Entra ID, set the automatic mode and enter the admin credentials
  1. Click Test Connection to check that your credentials are valid, then click Save.

  2. Under Mappings, click on Provision Microsoft Entra ID Groups. This opens the Attribute Mapping dialog for groups.

  3. Under Target Object Actions, make sure that Create, Update, and Delete are enabled.

In the Attribute mapping page of MS Entra ID, select the target object actions to confiugre SCIM
  1. In Attribute Mappings, make sure displayName appears in both columns of the mapping. This ensures groups are mapped based on their names.

In Attribute Mappings in MS Entra ID, make sure displayName appears in both columns
  1. Click Save. This takes you back to the Provisioning page. If this was the default configuration, go back to the previous page.

  2. Under Mappings, click on Provision Microsoft Entra ID Users. This opens the Attribute Mapping dialog for users.

  3. Under Target Object Actions, make sure that Create, Update, and Delete are enabled.

  4. In Attribute Mappings , map the userName customappsso Attribute (target) to the Microsoft Entra ID Attribute (source) used as SAML user login attribute in your SAML configuration. For example, if your login attribute is http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress in your SonarQube Server’s SAML configuration and it is mapped to user.userprincipalname (default), use userprincipalname here. Otherwise, if it is mapped to user.mail, then use mail instead.

in MS Entra ID, map the userName attribute

To check which Microsoft Entra ID attribute is used as SAML user login attribute:

  1. In SonarQube, go to Administration > Authentication > SAML.

  2. In SAML Configuration > SAML, select Edit. The MS Entra ID attribute is the value of SAML user login attribute.

  1. Click Save. This takes you back to the Provisioning page.

  2. In the Settings > Scope section, select Sync only assigned users and groups.

In MS Entra ID, select Sync only assigned users and groups
  1. Set the provisioning status to On and click Save. The Microsoft Entra ID users and groups will be synchronized with SonarQube Server.

Microsoft Entra ID runs a SCIM synchronization every 40 minutes. Changes in Microsoft Entra ID are not reflected immediately in SonarQube Server.

Last updated

Was this helpful?