Edit

Tutorial: Integrate Vtiger CRM (SAML) with Microsoft Entra ID

  • Article

In this tutorial, you'll learn how to integrate Vtiger CRM (SAML) with Microsoft Entra ID. When you integrate Vtiger CRM (SAML) with Microsoft Entra ID, you can:

  • Control in Microsoft Entra ID who has access to Vtiger CRM (SAML).
  • Enable your users to be automatically signed-in to Vtiger CRM (SAML) with their Microsoft Entra accounts.
  • Manage your accounts in one central location.

Prerequisites

To get started, you need the following items:

  • A Microsoft Entra subscription. If you don't have a subscription, you can get a free account.
  • Vtiger CRM (SAML) single sign-on (SSO) enabled subscription.

Scenario description

In this tutorial, you configure and test Microsoft Entra SSO in a test environment.

  • Vtiger CRM (SAML) supports SP initiated SSO.
  • Vtiger CRM (SAML) supports Just In Time user provisioning.

To configure the integration of Vtiger CRM (SAML) into Microsoft Entra ID, you need to add Vtiger CRM (SAML) from the gallery to your list of managed SaaS apps.

  1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.
  2. Browse to Identity > Applications > Enterprise applications > New application.
  3. In the Add from the gallery section, type Vtiger CRM (SAML) in the search box.
  4. Select Vtiger CRM (SAML) from results panel and then add the app. Wait a few seconds while the app is added to your tenant.

Alternatively, you can also use the Enterprise App Configuration Wizard. In this wizard, you can add an application to your tenant, add users/groups to the app, assign roles, as well as walk through the SSO configuration as well. Learn more about Microsoft 365 wizards.

Configure and test Microsoft Entra SSO for Vtiger CRM (SAML)

Configure and test Microsoft Entra SSO with Vtiger CRM (SAML) 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 Vtiger CRM (SAML).

To configure and test Microsoft Entra SSO with Vtiger CRM (SAML), perform the following steps:

  1. Configure Microsoft Entra 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.
    2. Assign the Microsoft Entra test user - to enable B.Simon to use Microsoft Entra single sign-on.
  2. Configure Vtiger CRM (SAML) SSO - to configure the single sign-on settings on application side.
    1. Create Vtiger CRM (SAML) test user - to have a counterpart of B.Simon in Vtiger CRM (SAML) that is linked to the Microsoft Entra representation of user.
  3. Test SSO - to verify whether the configuration works.

Configure Microsoft Entra SSO

Follow these steps to enable Microsoft Entra SSO.

  1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.

  2. Browse to Identity > Applications > Enterprise applications > Vtiger CRM (SAML) application integration page, find the Manage section and select 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, click the pencil icon for Basic SAML Configuration to edit the settings.

    Edit Basic SAML Configuration

  5. On the Basic SAML Configuration page, perform the following steps:

    a. In the Identifier (Entity ID) text box, type a URL using the following pattern: https://<CUSTOMER_INSTANCE>.od1.vtiger.com/sso/saml?acs

    b. In the Sign on URL text box, type a URL using one of the following patterns:

    Sign on URL
    https://<CUSTOMER_INSTANCE>.od1.vtiger.com
    https://<CUSTOMER_INSTANCE>.od2.vtiger.com
    https://<CUSTOMER_INSTANCE>.od1.vtiger.ws

    Note

    These values are not real. Update these values with the actual Sign on URL and Identifier. Contact Vtiger CRM (SAML) Client support team to get these values. You can also refer to the patterns shown in the Basic SAML Configuration section.

  6. On the Set up Single Sign-On with SAML page, in the SAML Signing Certificate section, find Certificate (Base64) and select Download to download the certificate and save it on your computer.

    The Certificate download link

  7. On the Set up Vtiger CRM (SAML) section, copy the appropriate URL(s) based on your requirement.

    Copy configuration URLs

Create a Microsoft Entra test user

In this section, you'll create a test user called B.Simon.

  1. Sign in to the Microsoft Entra admin center as at least a User Administrator.
  2. Browse to Identity > Users > All users.
  3. Select New user > Create new user, at the top of the screen.
  4. In the User properties, follow these steps:
    1. In the Display name field, enter B.Simon.
    2. In the User principal name field, enter the username@companydomain.extension. For example, B.Simon@contoso.com.
    3. Select the Show password check box, and then write down the value that's displayed in the Password box.
    4. Select Review + create.
  5. Select Create.

Assign the Microsoft Entra test user

In this section, you'll enable B.Simon to use single sign-on by granting access to Vtiger CRM (SAML).

  1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.
  2. Browse to Identity > Applications > Enterprise applications > Vtiger CRM (SAML).
  3. In the app's overview page, select Users and groups.
  4. Select Add user/group, then select Users and groups in the Add Assignment dialog.
    1. In the Users and groups dialog, select B.Simon from the Users list, then click the Select button at the bottom of the screen.
    2. If you are expecting a role to be assigned to the users, you can select it from the Select a role dropdown. If no role has been set up for this app, you see "Default Access" role selected.
    3. In the Add Assignment dialog, click the Assign button.

Configure Vtiger CRM (SAML) SSO

To configure single sign-on on Vtiger CRM (SAML) side, you need to send the downloaded Certificate (Base64) and appropriate copied URLs from the application configuration to Vtiger CRM (SAML) support team. They set this setting to have the SAML SSO connection set properly on both sides.

Create Vtiger CRM (SAML) test user

In this section, a user called Britta Simon is created in Vtiger CRM (SAML). Vtiger CRM (SAML) supports just-in-time user provisioning, which is enabled by default. There is no action item for you in this section. If a user doesn't already exist in Vtiger CRM (SAML), a new one is created after authentication.

Test SSO

In this section, you test your Microsoft Entra single sign-on configuration with following options.

  • Click on Test this application, this will redirect to Vtiger CRM (SAML) Sign-on URL where you can initiate the login flow.

  • Go to Vtiger CRM (SAML) Sign-on URL directly and initiate the login flow from there.

  • You can use Microsoft My Apps. When you click the Vtiger CRM (SAML) tile in the My Apps, this will redirect to Vtiger CRM (SAML) Sign-on URL. For more information about the My Apps, see Introduction to the My Apps.

Next steps

Once you configure Vtiger CRM (SAML) 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.