diff --git a/docs/identity/saas-apps/clearcompany-tutorial.md b/docs/identity/saas-apps/clearcompany-tutorial.md index 8922c5f08f0..acd08dab150 100644 --- a/docs/identity/saas-apps/clearcompany-tutorial.md +++ b/docs/identity/saas-apps/clearcompany-tutorial.md @@ -1,18 +1,18 @@ --- -title: Configure ClearCompany for Single sign-on with Microsoft Entra ID +title: Configure ClearCo or Single Sign-On with Microsoft Entra ID description: Learn how to configure single sign-on between Microsoft Entra ID and ClearCompany. ms.reviewer: celested ms.topic: how-to -ms.date: 03/25/2025 -# Customer intent: As an IT administrator, I want to learn how to configure single sign-on between Microsoft Entra ID and ClearCompany so that I can control who has access to ClearCompany, enable automatic sign-in with Microsoft Entra accounts, and manage my accounts in one central location. +ms.date: 04/27/2026 +# Customer intent: As an IT administrator, I want to learn how to configure single sign-on between Microsoft Entra ID and ClearCo so that I can control who has access to ClearCo, enable automatic sign-in with Microsoft Entra accounts, and manage my accounts in one central location. --- -# Configure ClearCompany for Single sign-on with Microsoft Entra ID +# Configure ClearCo for Single Sign-On with Microsoft Entra ID -In this article, you learn how to integrate ClearCompany with Microsoft Entra ID. When you integrate ClearCompany with Microsoft Entra ID, you can: +In this article, you learn how to integrate ClearCo with Microsoft Entra ID. When you integrate ClearCo with Microsoft Entra ID, you can: -* Control in Microsoft Entra ID who has access to ClearCompany. -* Enable your users to be automatically signed-in to ClearCompany with their Microsoft Entra accounts. +* Control in Microsoft Entra ID who has access to ClearCo. +* Enable your users to be automatically signed in to ClearCo with their Microsoft Entra accounts. * Manage your accounts in one central location. ## Prerequisites @@ -20,20 +20,20 @@ In this article, you learn how to integrate ClearCompany with Microsoft Entra I The scenario outlined in this article assumes that you already have the following prerequisites: [!INCLUDE [common-prerequisites.md](~/identity/saas-apps/includes/common-prerequisites.md)] -* ClearCompany single sign-on (SSO) enabled subscription. +* ClearCo single sign-on (SSO) enabled subscription. ## Scenario description In this article, you configure and test Microsoft Entra single sign-on in a test environment. -* ClearCompany supports **SP and IDP** initiated SSO. +* ClearCo supports **SP and IDP** initiated SSO. > [!NOTE] -> Identifier of this application is a fixed string value so only one instance can be configured in one tenant. +> The identifier of this application is a fixed string value, so only one instance can be configured in one tenant. -## Add ClearCompany from the gallery +## Add ClearCo from the gallery -To configure the integration of ClearCompany into Microsoft Entra ID, you need to add ClearCompany from the gallery to your list of managed SaaS apps. +To configure the integration of ClearCo into Microsoft Entra ID, you need to add ClearCo from the gallery to your list of managed SaaS apps. 1. Sign in to the [Microsoft Entra admin center](https://entra.microsoft.com) as at least a [Cloud Application Administrator](~/identity/role-based-access-control/permissions-reference.md#cloud-application-administrator). 1. Browse to **Entra ID** > **Enterprise apps** > **New application**. @@ -44,17 +44,17 @@ To configure the integration of ClearCompany into Microsoft Entra ID, you need t -## Configure and test Microsoft Entra SSO for ClearCompany +## Configure and test Microsoft Entra SSO for ClearCo -Configure and test Microsoft Entra SSO with ClearCompany using a test user called **B.Simon**. For SSO to work, you need to establish a link relationship between a Microsoft Entra user and the related user in ClearCompany. +Configure and test Microsoft Entra SSO with ClearCo using a test user called **B.Simon**. For SSO to work, you need to establish a link relationship between a Microsoft Entra user and the username in ClearCo. -To configure and test Microsoft Entra SSO with ClearCompany, perform the following steps: +To configure and test Microsoft Entra SSO with ClearCo, perform the following steps: 1. **[Configure Microsoft Entra SSO](#configure-azure-ad-sso)** - to enable your users to use this feature. 1. **Create a Microsoft Entra test user** - to test Microsoft Entra single sign-on with B.Simon. 1. **Assign the Microsoft Entra test user** - to enable B.Simon to use Microsoft Entra single sign-on. -1. **[Configure ClearCompany SSO](#configure-clearcompany-sso)** - to configure the single sign-on settings on application side. - 1. **[Create ClearCompany test user](#create-clearcompany-test-user)** - to have a counterpart of B.Simon in ClearCompany that's linked to the Microsoft Entra representation of user. +1. **[Configure ClearCo SSO](#configure-clearcompany-sso)** - to configure the single sign-on settings on application side. + 1. **[Create ClearCo test user](#create-clearcompany-test-user)** - to have a counterpart of B.Simon in ClearCo, that's linked to the Microsoft Entra representation of user. 1. **[Test SSO](#test-sso)** - to verify whether the configuration works. @@ -64,13 +64,13 @@ To configure and test Microsoft Entra SSO with ClearCompany, perform the followi Follow these steps to enable Microsoft Entra SSO. 1. Sign in to the [Microsoft Entra admin center](https://entra.microsoft.com) as at least a [Cloud Application Administrator](~/identity/role-based-access-control/permissions-reference.md#cloud-application-administrator). -1. Browse to **Entra ID** > **Enterprise apps** > **ClearCompany** > **Single sign-on**. -1. On the **Select a single sign-on method** page, select **SAML**. -1. On the **Set up single sign-on with SAML** page, select the pencil icon for **Basic SAML Configuration** to edit the settings. +2. Browse to **Entra ID** > **Enterprise apps** > **ClearCompany** > **Single sign-on**. +3. On the **Select a single sign-on method** page, select **SAML**. +4. On the **Set up single sign-on with SAML** page, select the pencil icon for **Basic SAML Configuration** to edit the settings. ![Edit Basic SAML Configuration](common/edit-urls.png) -1. On the **Basic SAML Configuration** section, If you wish to configure the application in **IDP** initiated mode, perform the following steps: +5. On the **Basic SAML Configuration** section, If you wish to configure the application in **IDP** initiated mode, perform the following steps: a. In the **Identifier** text box, type the URL: `https://api.clearcompany.com` @@ -78,19 +78,23 @@ Follow these steps to enable Microsoft Entra SSO. b. In the **Reply URL** text box, type the URL: `https://api.clearcompany.com/v1/auth/sso/saml` -5. Select **Set additional URLs** and perform the following step if you wish to configure the application in **SP** initiated mode: +6. Select **Set additional URLs** and perform the following step if you wish to configure the application in **SP** initiated mode: In the **Sign-on URL** text box, type a URL using the following pattern: - `https://.clearcompany.com` + `https://.clearcompany.com` > [!NOTE] - > The Sign-on URL value isn't real. Update the value with the actual Sign-on URL. Contact [ClearCompany Client support team](https://www.clearcompany.com/support) to get the value. You can also refer to the patterns shown in the **Basic SAML Configuration** section. + > The Sign-on URL value isn't real. Update the value with the actual Sign-on URL. Contact [ClearCo Client support team](support@clearcompany.com) to get the value. You can also refer to the patterns shown in the **Basic SAML Configuration** section. -4. On the **Set up Single Sign-On with SAML** page, in the **SAML Signing Certificate** section, select **Download** to download the **Certificate (Base64)** from the given options as per your requirement and save it on your computer. +7. On the **Set up Single Sign-On with SAML** page, go to the **SAML Signing Certificate** section, and then select **Download** to download the **Certificate (Base64)** and save it to your computer. Also download the **Federation Metadata XML**, as you'll need it later. ![The Certificate download link](common/certificatebase64.png) + + a. **Certificate (Base64)**: A public certificate used to verify and match identity provider (IdP) requests. + + b. **Federation Metadata XML**: A file that contains configuration details used for login setup, including the login URL and certificate information. -1. On the **Set up ClearCompany** section, copy the appropriate URL(s) as per your requirement. +9. On the **Set up ClearCompany** section, copy the appropriate URL(s) as per your requirement. ![Copy configuration URLs](common/copy-configuration-urls.png) @@ -98,30 +102,30 @@ Follow these steps to enable Microsoft Entra SSO. [!INCLUDE [create-assign-users-sso.md](~/identity/saas-apps/includes/create-assign-users-sso.md)] -## Configure ClearCompany SSO +## Configure ClearCo SSO -To configure single sign-on on **ClearCompany** side, you need to send the downloaded **Certificate (Base64)** and appropriate copied URLs from the application configuration to [ClearCompany support team](https://www.clearcompany.com/support). They set this setting to have the SAML SSO connection set properly on both sides. +To configure single sign-on on **ClearCo** side, you need to send the downloaded **Certificate (Base64)**, the **Federation Metadata XML** and the appropriate copied URLs from the application configuration to [ClearCo support team](support@clearcompany.com). They set this setting to have the SAML SSO connection set properly on both sides. -### Create ClearCompany test user +### Create ClearCo test user -In this section, you create a user called Britta Simon in ClearCompany. Work with [ClearCompany support team](https://www.clearcompany.com/support) to add the users in the ClearCompany platform. Users must be created and activated before you use single sign-on. +In this section, you create a user called Britta Simon in ClearCo. Work with [ClearCo support team](support@clearcompany.com) to add the users in the ClearCo platform. Users must be created and activated before you use single sign-on. ## Test SSO -In this section, you test your Microsoft Entra single sign-on configuration with following options. +In this section, you test your Microsoft Entra single sign-on configuration with following options. Set up time with ClearCo to test to help identify any errors. #### SP initiated: -* Select **Test this application**, this option redirects to ClearCompany Sign-on URL where you can initiate the login flow. +* Select **Test this application**, this option redirects to the ClearCo Sign-on URL, where you can initiate the login flow. -* Go to ClearCompany Sign on URL directly and initiate the login flow from there. +* Go to the ClearCo Sign on URL directly and initiate the login flow from there. #### IDP initiated: -* Select **Test this application**, and you should be automatically signed in to the ClearCompany for which you set up the SSO. +* Select **Test this application**, and you should be automatically signed in to the ClearCo for which you set up the SSO. -You can also use Microsoft My Apps to test the application in any mode. When you select the ClearCompany tile in the My Apps, if configured in SP mode you would be redirected to the application sign-on page for initiating the login flow and if configured in IDP mode, you should be automatically signed in to the ClearCompany for which you set up the SSO. For more information about the My Apps, see [Introduction to the My Apps](https://support.microsoft.com/account-billing/sign-in-and-start-apps-from-the-my-apps-portal-2f3b1bae-0e5a-4a86-a33e-876fbd2a4510). +You can also use Microsoft My Apps to test the application in any mode. When you select the ClearCo tile in the My Apps, if configured in SP mode, you would be redirected to the application sign-on page for initiating the login flow, and if configured in IDP mode, you should be automatically signed in to ClearCo or which you set up the SSO. For more information about the My Apps, see [Introduction to the My Apps](https://support.microsoft.com/account-billing/sign-in-and-start-apps-from-the-my-apps-portal-2f3b1bae-0e5a-4a86-a33e-876fbd2a4510). ## Related content -Once you configure ClearCompany you can enforce session control, which protects exfiltration and infiltration of your organization’s sensitive data in real time. Session control extends from Conditional Access. [Learn how to enforce session control with Microsoft Defender for Cloud Apps](/cloud-app-security/proxy-deployment-aad). +Once you configure ClearCo you can enforce session control, which protects exfiltration and infiltration of your organization’s sensitive data in real time. Session control extends from Conditional Access. [Learn how to enforce session control with Microsoft Defender for Cloud Apps](/cloud-app-security/proxy-deployment-aad).