# SailPoint Employment Hero Connector Documentation

> Employment Hero Connector Documentation

# Documentation

# Connecting SailPoint and Employment Hero

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 Employment Hero HR API endpoint as **Base URL**. For example, `https://api.employmenthero.com`.
2. Enter the OAuth 2.0 token endpoint as **Token URL**. For example, `https://oauth.employmenthero.com/oauth2/token`.
3. Enter the **Client ID**.
4. Enter the **Client Secret**.
5. Enter the **Refresh Token**.
6. Enter the **Organisation ID**.
7. 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 Employment Hero

Employment Hero is an employment operating system that combines HR, payroll, and benefits. Organisations manage their people records - employees and independent contractors, under an Employment Hero organisation, and group them into teams. This document covers how to configure a new direct connection between SailPoint and Employment Hero for Quick Compliance. 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 Employment Hero connector supports the following:

### Account Management

- Aggregate Employees

### Entitlement Management

- Aggregate Entitlement (Groups - Employment Hero teams)

> [!NOTE]
>
> This connector is read-only. It supports test connection, account aggregation, and entitlement aggregation for Quick Compliance. Both employees and independent contractors are aggregated as accounts. The `independentContractor` attribute distinguishes them.

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

Employment Hero API access requires a Platinum, eOS Plus, or Unlimited plan, or a trial or partner sandbox. Confirm the plan before you start. Complete these steps in Employment Hero before you add the source in SailPoint.

### Register an Application

1. Sign in to the [Employment Hero Developer Portal](<https://developer.employmenthero.com/>).
2. Register an application for SailPoint.
3. Set a redirect URI you can access, for example your API client's callback URL.
4. Copy the Client ID and Client Secret.

On the **Scope** field in the Developer Portal, select only the read scopes this connector needs:

| Scope | Why SailPoint Needs It |
| --- | --- |
| `urn:mainapp:organisations:read` | Test connection and Organisation ID |
| `urn:mainapp:employees:read` | Account aggregation (employees and contractors) |
| Team / group read (listed in the portal as the teams scope, typically `urn:mainapp:teams:read` or similar) | Entitlement aggregation (Groups) |

### Get a Refresh Token

Employment Hero does not offer client credentials or a static API key. An administrator must complete an Authorization Code flow with PKCE (S256) once, outside SailPoint, using an API client such as Postman.

1. Authorize at the Employment Hero OAuth authorize endpoint and sign in as an Employment Hero administrator.
2. Exchange the returned authorization code at the Employment Hero OAuth token endpoint.
3. Copy the refresh token from the response.

The refresh token is what SailPoint stores. PKCE is only part of this one-time handshake; the connector does not use it afterwards.

### Find Your Organisation ID

Call `GET /api/v1/organisations` on the Employment Hero HR API with the access token from the refresh token step. Copy the `id` (a UUID) of the organisation you want to aggregate.

### Record These Values for SailPoint

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

> [!CAUTION]
>
> Keep the client secret and refresh token on the SailPoint source only. Do not store them in a browser or a shared document. Anyone with these values can read the people data in that Employment Hero organisation.

## Required Permissions

An Employment Hero administrator with access to the organisation you want to aggregate must complete the authorize step. The refresh token inherits that administrator's access. SailPoint exchanges the refresh token for a short-lived access token, then reads organisation, employee, and team data. Access tokens expire after 15 minutes, and the connector requests a new one automatically. No manual token refresh is needed. If the administrator's access is removed, or the refresh token is revoked in Employment Hero, aggregation fails and a new refresh token must be supplied. For more information about Employment Hero, refer to the following:

- [Employment Hero website](<https://employmenthero.com/>)
- [Employment Hero API references](<https://developer.employmenthero.com/api-references>)
- [Employment Hero Authentication](<https://developer.employmenthero.com/api-references/authentication>)
- [Employment Hero Partner guides](<https://developer.employmenthero.com/partner-guides>)

> [!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 Employment Hero 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 Employment Hero 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 of the employee |
| firstName | First name of the employee |
| lastName | Last name of the employee |
| knownAs | Preferred name of the employee |
| accountEmail | Email address the employee used to sign in |
| companyEmail | Company email address of the employee |
| jobTitle | Job title of the employee |
| code | Employee code assigned by the organization |
| independentContractor | Indicates whether the employee is engaged as an independent contractor |
| startDate | Date when the employee started with the organization |
| terminationDate | Date when the employee left the organization |
| location | Work location of the employee |
| country | Two-letter ISO code representing the country of the employee |
| employingEntity | Legal entity that employs the employee |
| primaryManager | Unique identifier of the employee's primary manager |
| externalId | Unique identifier of the employee in the linked payroll system |
| role | Role assigned to the employee, aggregated as entitlement |
| teams | Groups assigned to the employee, aggregated as entitlement |

## 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.

| Attribute Name | Description |
| --- | --- |
| name | Name of the group |
| id | Unique identifier of the group |
| status | Status of the group |