# Integrating SailPoint with EspoCRM

EspoCRM is a free, open-source Customer Relationship Management (CRM) platform designed for small and medium-sized businesses. It helps companies manage and analyze their relationships with customers, partners, and other contacts through a simple, web-based interface. This document provides instructions to configure a new direct connection to an Espo CRM source. For a reference to the terminology specific to SailPoint products, refer to [Source and Connector Definitions](<https://documentation.sailpoint.com/saas/help/sources/index.html#source-and-connector-definitions>).

> [!NOTE]
>
> To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes](<https://community.sailpoint.com/release-notes/saas>) page.

## Supported Features

The Espo CRM connector supports the following:

### Account Management

- Aggregate active Users

### Entitlement Management (Teams)

- Aggregate Teams

## Supported Managed Systems

- Espo CRM

> [!IMPORTANT]
>
> Quick Compliance connectors have the following manual aggregation limits within a 24-hour period:
>
> - **Organization Admins**: Limited to 3 manual account or entitlement aggregations per day per source. This limit is cumulative across all admins in the organization.
> - **Regular Users**: Limited to 1 manual account or entitlement aggregation per day per source.
>
> These limits ensure that individual compliance statuses are kept up to date while maintaining continuous compliance monitoring. If you need to run additional aggregations beyond these limits, contact SailPoint Support.

## Prerequisites

Ensure the following prerequisites are met before proceeding with the configuration

- Access to a running EspoCRM instance (version 5.7 or later recommended).
- An administrator account with permissions to configure API users and roles.
- A dedicated API user created in EspoCRM (do not use a regular user account).
- An API key generated for the API user.

Generate API Credentials

1. Sign in to EspoCRM as an administrator.
2. Go to **Administration \> API Users**.
3. Click **Create API User**.
4. Select the authentication method (API Key or HMAC).
5. Assign a role to the user. See Required permissions for details.
6. Copy the generated API key.

   > **Note**
   >
   > By default, users have minimal access. You must assign roles to grant specific access levels.

## Required Permissions

To aggregate users and other data, the API user must have a role assigned with specific access rights. By default, API users have no permissions until a role is applied.

1. Go to **Administration \> Roles**.
2. Create a new role (for example, “SailPoint Integration Role”) or edit an existing role.
3. In the **Access** grid, configure the following permissions:

   - **User scope**

     - Read: Set to **All** (required to aggregate all user accounts)
     - Create and Edit: Set to **Yes** (required only if you intend to provision or update users)
   - **Team scope**

     - Read: Set to **All** (required to aggregate teams and departments)
   - **Roles scope** (optional but recommended)

     - Read: Set to **All** (required to manage user roles through the connector)
4. Save the role.
5. Assign the role to your API user.

   > **Resource Links**
   >
   > [Roles - EspoCRM Documentation](<https://docs.espocrm.com/administration/roles-management/>) | [Usage Tutorial - EspoCRM Documentation](<https://docs.espocrm.com/development/api-tutorial/>)

   > **Note**
   >
   > The linked document is not maintained by SailPoint and is subject to change without notice.
