# SailPoint Recruitee Connector Documentation

> Recruitee Connector Documentation

# Documentation

# Connecting SailPoint and Recruitee

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 Recruitee ATS API base endpoint as **Base URL**. For example, `https://api.recruitee.com/c`.
2. Enter the personal API token as **API Token**.
3. Enter your Recruitee Company ID as **Company Id**.
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 Recruitee

Recruitee (Tellent Recruitee) is a cloud-based applicant tracking system (ATS) used by organizations to publish job offers, collect and manage candidates through hiring pipelines, and coordinate the work of internal team members across jobs, departments, and locations. Recruitee exposes two public APIs - the **Careers Site API** (candidate-facing, job listings and applications) and the **ATS API** (admin-facing, scoped per company). The SailPoint Recruitee connector integrates with the **ATS API** only. This document provides the instructions required to configure a new direct connection between SailPoint and Recruitee. 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 Recruitee connector supports the following:

### Account Management

- Aggregate Account (Admins - Recruitee members)

### Entitlement Management

- Aggregate Roles

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

1. Sign in to Recruitee with a user whose hiring role permits viewing team members and hiring roles (see **Required Permissions** below). The API token inherits exactly the permissions of the user who generates it.
2. Go to **Settings \> Apps and plugins \> API tokens \> Personal API tokens**.
3. Select **\+ New token** (also labeled **Add new token**) in the top-right corner and provide a token label for easier distinguishing, then select **Save**.
4. If prompted, re-enter your account password to verify your identity. Recruitee requires re-authentication every 3 minutes during this flow.
5. Select **Show token** and copy the generated **API Token**. Only the token owner can view it - not even an account administrator can see another user's tokens.
6. Note your **Company ID**, which is displayed on the same Personal API tokens page.
7. Copy and securely store the following details, which are required during connector configuration:

   - **Base URL**
   - **API Token**
   - **Company Id**

> [!NOTE]
>
> - Recruitee API tokens are **personal, and issued per user and per company** - not company-wide. A token created while signed in to company A cannot be used for company B, and it grants exactly the same scope of actions the generating user has in the web or mobile application. It is not possible to raise or lower the access level of a token, or to disable token generation for a role.
> - Because the token is personal, **removing that user from your company restricts their tokens' access to your company**, and any integration built on their token stops working due to lack of authorization. Use a dedicated service/role-based account rather than a named individual wherever possible.
> - Tokens **do not expire** unless revoked. Revoked tokens cannot be regenerated - a new token must be created and reconfigured in the source. After revocation, every authenticated request returns `401 Unauthorized`.
> - A rate limit of **1,000 requests per minute** applies **per API token**.

For more detailed information on obtaining an API token, refer to the official Recruitee documentation: [Recruitee API getting started](<https://docs.recruitee.com/reference/getting-started>).

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

## Required Permissions

### Typical Roles That Can Generate Tokens

Recruitee ships six default **hiring roles**, managed under **Settings \> General \> Hiring roles**, and additional custom roles can be created by duplicating an existing role or starting from scratch. Because an API token carries exactly the permission scope of the user who created it, the effective connector permissions are the hiring-role permissions of that user.

- **Administrator** - Recommended. Administrators have access to all candidates, jobs, and settings, and can fully manage the company's account and members, including inviting and deleting other administrators. This role is not editable in Recruitee. An Administrator token satisfies the read access the connector requires for team members and hiring roles.
- **Custom roles** - Users with the **Company \> Manage team members and roles** permission can create roles and assign permissions.

# 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 Recruitee 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 Recruitee connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.

| Attribute Name | Recruitee API field | Description |
| --- | --- | --- |
| id | id | Unique identifier of the Recruitee admin (team member) record. Used as the account identity attribute. Recruitee returns this value as a number in documented admin objects; the connector schema declares it as a string. |
| email | email | Email address of the team member. |
| first\_name | first\_name | Given (first) name of the team member. Used as the account display attribute. |
| last\_name | last\_name | Family (last) name of the team member. |
| time\_zone | timezone | Time zone of the team member (for example, Europe/Warsaw). **Renamed by the connector:** the Recruitee field timezone is mapped to the schema attribute time\_zone. |
| role\_id | role\_id | Identifier of the hiring role assigned to the team member. This is the managed entitlement attribute, linked to the role entitlement schema. |
| role\_name | role\_name | Name of the hiring role assigned to the team member, carried on the account as a descriptive (non-entitlement) attribute. |

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

### Default Role Attributes

The Recruitee connector supports roles. The following attributes must be configured on the managed system and in the SailPoint source schema to manage roles.

| Attribute Name | Recruitee API field | Description |
| --- | --- | --- |
| role\_id | id | Unique identifier of the hiring role in Recruitee. Used as the entitlement identity attribute. Renamed by the connector from id. |
| role\_name | name | Display name of the hiring role. Used as the entitlement display attribute. **Renamed by the connector** from name. |
| abilities | abilities | Permissions granted by the hiring role. Declared as a string in the connector schema. |