# SailPoint FreeAgent Connector Documentation

> FreeAgent Connector Documentation

# Documentation

# Connecting SailPoint and FreeAgent

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

1. In SailPoint, create a **FreeAgent** source (Express Setup / Quick Compliance).
2. Complete **Connection Settings** and save.
3. Select **Test Connection**.
4. Run **Account Aggregation**.

## 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 FreeAgent API host URL as **Base URL**. Use `https://api.freeagent.com`.
2. Enter the OAuth token endpoint as **Token URL**. Use `https://api.freeagent.com/v2/token_endpoint`.
3. Enter **Client ID**.
4. Enter **Client Secret**.
5. Enter **Refresh Token**.
6. 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 FreeAgent

FreeAgent is a cloud-based accounting software platform designed for small businesses, freelancers, and accountants. It helps organizations manage invoicing, expenses, payroll, and financial reporting. It lets organizations track user identity and account-related attributes and connects to other tools via its REST API using **OAuth 2.0** (refresh token to access token). All calls are HTTPS. This document provides instructions to configure a new direct connection to a FreeAgent 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 FreeAgent connector supports the following:

### Account Management

- Aggregate Users

> [!NOTE]
>
> User role is captured as part of account aggregation (embedded within the user record via the `role` attribute), so a separate entitlement aggregation is not required.

> [!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 you configure the FreeAgent connector, ensure the following requirements are met:

1. Sign in to [FreeAgent](<https://freeagent.com>) and the [FreeAgent Developer Dashboard](<https://dev.freeagent.com/>).
2. On the FreeAgent Developer Dashboard, go to **Create new app**, select **Create App**, and copy the **OAuth identifier** and **OAuth secret**.
3. Generate the **Refresh Token** using [Google OAuth 2.0 Playground](<https://developers.google.com/oauthplayground>):

   - Open [Google OAuth 2.0 Playground](<https://developers.google.com/oauthplayground>).
   - Select the **gear** icon. Select **Use your own OAuth credentials**. Enter the Client ID and Client Secret from the app you created.
   - Set OAuth endpoints to **Custom**:

     - Authorization: `https://api.freeagent.com/v2/approve_app`
     - Token: `https://api.freeagent.com/v2/token_endpoint`
   - In Step 1, enter any dummy scope (for example `api`) and select **Authorize APIs**. This redirects to the FreeAgent sign-in screen. Sign in and authorize the app.
   - Back in Playground, select **Exchange authorization code for tokens**.
   - Copy the **Refresh Token** from this response.
4. Copy and securely store the following details, which are required during connector configuration:

   - **Base URL**
   - **Token URL**
   - **Client ID**
   - **Client Secret**
   - **Refresh Token**

> [!NOTE]
>
> - The FreeAgent API uses OAuth 2.0 for authentication. The Access Token obtained via the OAuth flow is passed as a Bearer token on each API request: `Authorization: Bearer {{ your_access_token }}`.
> - All API requests must be made over HTTPS; unencrypted HTTP calls are not supported and will fail.
> - SailPoint uses the Refresh Token to obtain new Access Tokens automatically as they expire, so only the Refresh Token (along with the Client ID/Secret and Token URL) needs to be configured in SailPoint - the Access Token generated in **Google OAuth 2.0 Playground** is only used to complete the initial authorization and does not need to be stored in SailPoint.
> - Tokens should be stored securely and treated like a password.

For more detailed information on FreeAgent API authentication, refer to the [FreeAgent API documentation](<https://dev.freeagent.com/docs>).

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

## Required Permissions

FreeAgent uses role-based access at the account level. Available roles include the following:

### Staff Roles

- **Owner** - Full access to all company financial data, settings, and user management.
- **Director** - Broad access similar to Owner, typically without full billing or ownership control.
- **Partner** - Access similar to Director, used in partnership-structured businesses.
- **Company Secretary** - Administrative access focused on statutory and compliance tasks.
- **Employee** - Restricted access, typically limited to expenses, timeslips, and personal data.
- **Shareholder** - Restricted access, typically limited to viewing dividend or shareholding-related information.

### Advisor Roles

- **Accountant** - Granted to external accountants or advisors for managing client books.

# 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 FreeAgent 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 |
| --- | --- |
| url | Account(User) |

### Default Account Attributes

The FreeAgent 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 |
| --- | --- |
| url | Unique identifier (API URL) for the user within FreeAgent |
| first\_name | First name of the user |
| last\_name | Last name of the user |
| email | Email address of the user |
| hidden | Stores boolean true or false, whether the user account is hidden (for example, deactivated) |
| role | Role of the user within the FreeAgent account (for example, Owner, Director, Employee), used as an entitlement value |
| permission\_level | Numeric permission level assigned to the user, indicating the scope of access |
| opening\_mileage | Opening mileage value recorded for the user, used for mileage expense tracking |
| created\_at | Timestamp indicating when the user record was created |
| updated\_at | Timestamp indicating when the user record was last updated |

> [!NOTE]
>
> User role is modeled as an account entitlement on the role attribute. A separate entitlement schema is not used.