# SailPoint Alegra Connector Documentation

> Alegra Connector Documentation

# Documentation

# Connecting SailPoint and Alegra

To connect SailPoint to the source, perform the following tasks:

## Adding and Configuring the Source in SailPoint

To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs.

1. Go to **Admin \> Connections \> Sources**.
2. Select **Create New**.
3. Search for a source type and select **Actions**.
4. In the **Actions** dropdown, select the setup method:

   - **Express Setup** - Quickly create a read-only connection to your target system by providing minimal configurations and authentication. On completion, aggregation is automatically started.

     > **Note**
     >
     > Express Setup supports Credential Providers. For information on supported credential providers and configuration, refer to [Credential Providers](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>). For more information, contact your SailPoint Customer Service Manager.
   - **Standard Setup** - Provide detailed basic configuration to create the source. Once the source is created, continue with source setup.

### Express Setup

1. Review the directions and select **Start Express Setup**.
2. Review the pre-populated source name, source owner, and description. To update, select **Edit**.

   > **Note**
   >
   > Source name must be unique.
3. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider.

   > **Note**
   >
   > To add a Credential Provider in SailPoint, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>).
4. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** page.
5. Select **Finish**. After a successful test connection, the system creates your source and prompts you to run an aggregation.

   - If you want to aggregate now, select **Aggregate**.

     - To see the latest account aggregation history, go to **Account Management \> Account Aggregation**.
     - To see the list of aggregated source accounts, go to **Account Management \> Accounts**.
   - If you want to aggregate later, select **Exit**. This returns you to the **Sources** page. Your new source is listed, but contains no accounts or aggregation history yet.

### Standard Setup

Configure more detailed settings relative to Express Setup.

1. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters.
2. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters.
3. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](<https://documentation.sailpoint.com/saas/help/sources/index.html#assigning-a-source-owner>).
4. (Optional) Select a governance group to grant its members [source](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#source-sub-admin-user-level>) or [role](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#role-sub-admin-user-level>) sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html>).
5. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](<https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html>).
6. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Here, continue to configure your connected source.

## Base Configuration

Provide the base configuration parameters. Information you entered in the Create New Source dialog is automatically entered into the fields in the Base Configuration page. You can edit this information if necessary.

1. Enter a descriptive **Source Name** for the connection.
2. Enter the **Source Description** that provides details necessary to distinguish it from similar connection sources.
3. In **Source Owner**, begin typing the name of the source owner.
4. (Optional) Select the appropriate **Governance Group for Source Management** from the dropdown list. For more information about governance groups, refer to [Associating Governance Groups with a Source](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html#associating-a-governance-group-with-a-source>).
5. Select **Create Manual Work Items** to enable the source to support additional source management features such as creating accounts and access profile management.

   > **Important**
   >
   > Once you enable this feature, it can't be disabled.

   For more information on manual work items, refer to [Work Items](<https://developer.sailpoint.com/docs/api/work-items>). For more information on SailPoint features, refer to [SailPoint Identity Services](<https://documentation.sailpoint.com/saas/help/index.html>).
6. Select **Save**.

## Connection Settings

Configure a secured, direct connection to the source.

1. Enter the Alegra API base endpoint shown under Manual Integration as **Base URL**. For example, `https://api.alegra.com/api/v1`.
2. Enter the USER value as **Username (Email)**. For example, `user@example.com`.
3. Enter the TOKEN value as **Password (Token)**. This is not the Alegra login password.
4. Select **Save**.

## Review and Test

Perform a test to confirm the connection to SailPoint.

1. Go to **Review and Test**.
2. Confirm that the entries in each field are correct.

   If you note any mistakes, return to the section and make corrections.
3. Select **Test Connection**.

## SailPoint Application Onboarding

SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface.

For more information, refer to [Application Onboarding](<https://documentation.sailpoint.com/saas/help/ai/app_onboarding/index.html>) in the SailPoint SaaS documentation.

# Integrating SailPoint with Alegra

Alegra is a cloud accounting and business management platform used to manage contacts, invoices, products, users, and related financial operations. This document provides the instructions required to configure a new direct connection between SailPoint and Alegra for Quick Compliance use cases. 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 Alegra connector supports the following:

### Account Management

- Aggregate Users

### Entitlement Management

- Aggregate Roles

> [!NOTE]
>
> This connector is read-only. It supports account aggregation for Quick Compliance. Provisioning, de-provisioning, and write operations are not supported in this release. Role values are collected during account aggregation.

> [!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

Before configuring the Alegra connector, ensure you have Basic authentication credentials for an Alegra user whose role can access users in Alegra.

1. Sign in to the [Alegra application](<https://app.alegra.com>).
2. In the left sidebar, select **Integrations**.
3. Select **Manual Integration** for the Alegra REST API.
4. Under **Access credentials**, copy the **USER** (email) and **TOKEN** values. You can also copy the **Base URL** shown on the same page.
5. Confirm the Alegra user associated with these credentials is assigned a role that can access the user directory. The default **Administrator** role provides full access to all sections of Alegra, including the ability to add or remove users.
6. Record the following values for SailPoint configuration:

   - **Base URL**
   - **Username** (USER email from Access credentials)
   - **Password** (TOKEN from Access credentials)

> [!NOTE]
>
> The Password field is the Alegra API **TOKEN** from **Integrations \> Manual Integration \> Access credentials**, not the user's login password. Store it securely.

## Required Permissions

### Role-Based Access

This connector uses Basic authentication. The permissions available to SailPoint are the permissions granted by the **role** of the Alegra user configured in the connection settings.

In Alegra, roles are managed under role configuration and include permissions across Alegra Accounting and General Settings. For example, the default **Administrator** role is described as having full access to all sections of Alegra and the ability to add or remove users.

> [!NOTE]
>
> Alegra role permissions do not include a dedicated "view users" or "read users" permission. User-related role permissions focus on create, edit, and delete actions for users and roles. For this read-only connector, configure an Alegra user whose role can access the organization user list in practice, such as **Administrator**. You do not need to enable or document individual create, edit, or delete user permissions for aggregation.

**Recommendation:** Use an Alegra user with the **Administrator** role, or another role that can access users in Alegra. Accounting module permissions such as invoices, payments, reports, and inventory are not required for this connector.

## Key Implementation Notes

- Uses **Basic authentication** with the Alegra **USER** and **TOKEN** from **Integrations \> Manual Integration \> Access credentials**.
- Credentials inherit the Alegra user's **role**. Use **Administrator**, or another role that can access the user list; Alegra has no dedicated read-users permission.
- Accounts use **Id** as the identity attribute, **Email** as the display and correlation attribute, and aggregate **Role** entitlements.
- This read-only release is intended for Quick Compliance; detailed Alegra module permissions are not aggregated.

## References

For more information, refer to the following resources:

- [Alegra API general information](<https://developer.alegra.com/docs/información-general>)
- [Alegra API users reference](<https://developer.alegra.com/reference/get_users>)

> [!NOTE]
>
> The linked document is not maintained by SailPoint and is subject to change without notice.

# Schema Reference

The application schema is used to configure the objects returned from a connector.

> [!NOTE]
>
> - The **Account Schema** tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as **Entitlement** or **Multi-Valued**. Refer to [Managing Source Account Schemas](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) for more information.
> - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified.

The Alegra connector uses the following default correlation and object configurations.

## Default Account Schema

Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location.

The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) for more information.

### Default Account ID

SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as *account IDs*.

> [!CAUTION]
>
> Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts.
>
> To resolve issues caused by changing account IDs, reconfigure them to their default values.

The following table lists the default account IDs for this connector:

| Account ID | Schema Object Type |
| --- | --- |
| Id | Account |

### Default Account Attributes

The Alegra connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.

| Attribute Name | Description |
| --- | --- |
| Id | Unique identifier for the user account, used as the account identity attribute |
| Global ID | Global identifier for the user account |
| Email | Email address of the user, used as the account display attribute |
| Role | Security role assigned to the user, such as admin or user, aggregated as a Role entitlement |
| Position | Job position of the user in the organization |
| Username | Username for the account |
| First Name | First name of the user |
| Last Name | Last name of the user |
| Phone | Phone number for the user |
| Phone Code | Country calling code for the user phone number |
| Status | Current status of the user account, typical values are active and inactive |
| Company Name | Name of the organization associated with the user |
| Registry Date | Date the user was registered |
| UUID | Additional unique reference for the user |
| Has Invitation Key | Indicates whether the user still has a pending invitation to accept |

> [!NOTE]
>
> `Id` is used as the account identity attribute because Alegra retrieves an individual user with this value. Global ID and UUID are also collected, but they are not used to look up a single user. `Email` is the account display attribute.

## Account Correlation

Accounts are correlated to identities by matching the identity `email` attribute to the account `Email` attribute.

| Identity Attribute | Operation | Account Attribute |
| --- | --- | --- |
| email | EQ | Email |

## Default Entitlement Attributes

Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements](<https://documentation.sailpoint.com/saas/help/access/entitlements.html>) for more information.

> [!CAUTION]
>
> Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations.

This connector aggregates Role as the entitlement type associated with accounts.

| Attribute Name | Description |
| --- | --- |
| Role | Security role assigned to the Alegra user, such as admin or user. Aggregated with the account. |

> [!NOTE]
>
> Role entitlements are collected with each account during account aggregation.