# Introduction

Currently, only SAML SSO is supported.

If you use Okta or Microsoft Entra ID, see the following pages:

* [okta](https://docs.sonarsource.com/sonarqube-cloud/administering-sonarcloud/managing-user-accounts/setting-up-sso/configure-sso/okta "mention")
* [microsoft-entra-id](https://docs.sonarsource.com/sonarqube-cloud/administering-sonarcloud/managing-user-accounts/setting-up-sso/configure-sso/microsoft-entra-id "mention")

Otherwise, proceed as follows:&#x20;

1. In SonarQube Cloud, retrieve your enterprise. See [managing-enterprise](https://docs.sonarsource.com/sonarqube-cloud/administering-sonarcloud/managing-enterprise "mention") for more details.
2. Select **Administration** > **Single Sign-On**. The **Single Sign-On** page opens.
3. Select **Open Configuration** and then **Get Started**. The setup assistant opens.
4. Select **Custom SAML** and select **Next**.&#x20;
5. Follow the steps described below.

### Step 1: Create the SonarQube Cloud application in your identity provider <a href="#create-application" id="create-application"></a>

1. Create the SonarQube Cloud application in your identity provider.
2. Copy the **Service Provider Identity ID** field value from the setup assistant and paste it into the corresponding field in your identity provider.
3. Copy the **Single Sign-On URL** field value from the setup assistant and paste it into the corresponding field in your identity provider.
4. In the setup assistant, select **Next** to go to the step **2. Configure Connection**.

![](https://2223713658-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB4UT2GNiZKjtxFtcFAL7%2Fuploads%2Ftx0IXDiQqkbGFxACHTGv%2Fsonarqube-cloud-sso-step2-step1.png?alt=media\&token=87e89406-a058-4d66-8f3c-aafef484f4d1)

### Step 2: Configure the connection <a href="#configure-connection" id="configure-connection"></a>

The operation is different depending on whether your identity provider supports the SAML metadata URL field (URL used by SonarQube Cloud to access metadata information) or not.

<details>

<summary>Metadata URL supported</summary>

1. In your SonarQube Cloud application in your identity provider, copy the value of the field corresponding to the SAML metadata URL .&#x20;
2. Paste it into the **Metadata URL** field in the **Automatic** tab of the setup assistant page.
3. In the assistant, select **Create Connection** and **Proceed.** SonarQube Cloud is trying to connect to your Identity Provider. If the connection is established, the assistant moves to step **3. Attribute Mapping**.

{% include "<https://app.gitbook.com/s/B4UT2GNiZKjtxFtcFAL7/~/reusable/ufGwH39wtAt1RflK2buO/>" %}

</details>

<details>

<summary>Metadata URL not supported</summary>

1. In the assistant, select the **Manual** tab.
2. In your identity provider, copy the value of the SSO login URL field and paste it into **Single Sign-On Login URL** in the assistant.
3. In your identity provider, download the certificate and upload it to the assistant.
4. In the assistant, select **Create Connection** and **Proceed.** SonarQube Cloud is trying to connect to your Identity Provider. If the connection is established, the assistant moves to step **3. Attribute Mapping**.

<div align="left"><figure><img src="https://2223713658-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB4UT2GNiZKjtxFtcFAL7%2Fuploads%2Fgit-blob-b26ffed730b2fc7d685387ae0cd2987929eb0c4f%2Ffadbcbba2cd5927b0ee97b1157ee44188bcb0382.png?alt=media" alt="If you’re using the Manual configuration method in Step 2 when configuring your connection using SonarQube Cloud’s setup assistant, paste the value of your SO login URL into the Single Sign-On Login URL field." width="563"><figcaption></figcaption></figure></div>

</details>

### Step 3: Set up the attributes <a href="#set-up-attributes" id="set-up-attributes"></a>

1. In your identity provider, create the attributes for name, login, email, and groups (the group attribute is used for automatic group synchronization. To do so, for each attribute, copy the attribute name from the assistant and paste it into the attribute’s name field in your identity provider.
2. In the assistant, select **Next** to go to step **4. Test SSO**.

### Step 4: Test SSO <a href="#test-sso" id="test-sso"></a>

Select the **Test Connection** button. The test is started and the results are displayed on the page as illustrated below.

<div align="left"><figure><img src="https://2223713658-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB4UT2GNiZKjtxFtcFAL7%2Fuploads%2FFjS7wWwXB6pSq1vF5Gdz%2Fsonarqube-cloud-sso-step2-step4.png?alt=media&#x26;token=c56a82d0-c98a-402b-806a-c258b1359bf9" alt="Before you finish step 2 configuring your connection using SonarQube Cloud’s setup assistant, test and enable your configuration."><figcaption></figcaption></figure></div>

If the test was successful, select **Done**.&#x20;

### Related pages <a href="#related-pages" id="related-pages"></a>

* [verify-user-groups](https://docs.sonarsource.com/sonarqube-cloud/administering-sonarcloud/managing-user-accounts/setting-up-sso/verify-user-groups "mention")
* [inviting-users-to-sign-in](https://docs.sonarsource.com/sonarqube-cloud/administering-sonarcloud/managing-user-accounts/setting-up-sso/inviting-users-to-sign-in "mention")
* [terminate-setup](https://docs.sonarsource.com/sonarqube-cloud/administering-sonarcloud/managing-user-accounts/setting-up-sso/terminate-setup "mention")
* [editing-sso-configuration](https://docs.sonarsource.com/sonarqube-cloud/administering-sonarcloud/managing-user-accounts/setting-up-sso/editing-sso-configuration "mention")
* [deleting-sso-configuration](https://docs.sonarsource.com/sonarqube-cloud/administering-sonarcloud/managing-user-accounts/setting-up-sso/deleting-sso-configuration "mention")
