# SailPoint Teamwork Connector Documentation

> Teamwork Connector Documentation

# Documentation

# Connecting SailPoint and Teamwork

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 **Base URL** (host URL). For example, `https://<yourcompany>.teamwork.com/`, where `<yourcompany>` is your Teamwork instance name.
2. Enter your **API Token**. This must be entered in a Base64 format. You can use the following to provide your API Token in the correct format:

   1. Take your API Token (for example, something like `demo_api_token_123456`) and append a colon (:) at the end. This would look like `demo_api_token_123456:`
   2. Convert this string to Base 64 using one of these methods:

      - Use an online tool like [Base64 Encode and Decode - Online](<https://www.base64encode.org/>)
      - Use the following command line (Linux/Mac): `echo -n "demo_api_token_123456" | base64` This will provide output that should look like the following: `ZGVtb19hcGlfdG9rZW5fMTIzNDU2Og==`
   3. Paste the Base64 output into the **API Token** field.
3. 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 Teamwork

Teamwork is a project management and collaboration platform that enables teams to plan, track, and manage projects efficiently. It provides tools for task management, time tracking, reporting, and team collaboration. In the context of IAM (Identity and Access Management), Teamwork exposes REST APIs that allow management of users, companies (groups), and job roles.

This document provides instructions to configure a new direct connection between SailPoint and Teamwork. 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 Teamwork connector supports the following:

### Account Management

- Aggregate Accounts

### Entitlement Management

- Aggregate Groups
- 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

Ensure the following prerequisites are met before proceeding with the configuration:

- You must have an active Teamwork account with Administrator access.
- Ensure API access is enabled for the Teamwork instance.
- Take note of the base URL of your Teamwork instance. For example, `https://yourcompany.teamwork.com/`
- For authentication:

  - Generate an API token from your Teamwork account.
  - Teamwork supports Basic Authentication using an API Token.
  - Convert the API Token input to Base64 as explained in Connection Settings.

> [!IMPORTANT]
>
> **Resource Links**
>
> - [Getting Started with Teamwork.com API](<https://apidocs.teamwork.com/guides/teamwork/getting-started-with-the-teamwork-com-api>)
> - [Teamwork API Documentation](<https://apidocs.teamwork.com/docs/teamwork>)
> - [Teamwork Authentication Guide](<https://apidocs.teamwork.com/guides/teamwork/authentication#basic-authentication>)

# 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 Teamwork 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 | Description |
| --- | --- | --- |
| id | Account | Unique identifier for a Teamwork user |
| id | Group | Unique identifier for a company (group) in Teamwork |
| id | Role | Unique identifier for a job role in Teamwork |

### Default Account Attributes

The Teamwork 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 user account |
| firstName | User’s first name |
| lastName | User’s last name |
| title | User’s job title (if available) |
| email | Email address of the user |
| companyId | ID of the company the user belongs to |
| companyRoleId | Role ID assigned within the company |
| isAdmin | Boolean indicating if the user has admin privileges |
| isClientUser | Indicates if the account is a client user |
| isServiceAccount | Indicates if the account is a service account |
| type | Object type (always account for users) |
| deleted | Indicates if the account is deleted |
| avatarUrl | URL of the user’s profile avatar |
| lengthOfDay | Standard workday length in hours |
| workingHoursId | ID referencing assigned working hours |
| canAccessPortfolio | Indicates if user can access portfolios |
| canAddProjects | Indicates if user can create projects |
| canManagePortfolio | Indicates if user can manage portfolios |
| jobRoles | List of role IDs assigned to the user |
| isPlaceholderResource | Boolean indicating if user is a placeholder resource |
| timezone | Timezone of the user |
| lastLogin | Timestamp of the last login |
| createdAt | Account creation timestamp |
| updatedAt | Last updated timestamp |

## 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 Group Attributes

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

| Attribute Name | Description |
| --- | --- |
| id | Unique identifier of the company (group) |
| name | Company name |
| logoUrl | Company logo URL |
| createdAt | Timestamp when the company was created |
| updatedAt | Timestamp when the company was last updated |
| addressOne | Address line one |
| addressTwo | Address line two |
| city | City |
| state | State |
| zip | ZIP code |
| countryCode | Country code |
| emailOne | Primary company email |
| emailTwo | Secondary company email |
| emailThree | Additional company email |
| website | Company website URL |
| phone | Company phone number |
| fax | Company fax number |
| canSeePrivate | Boolean indicating if the company can see private items |
| isOwner | Indicates if the company is the owner |
| companyNameUrl | URL-friendly company identifier |
| accounts | Number of associated accounts |
| collaborators | Number of collaborators |
| contacts | Number of contacts |
| clients | Number of clients |
| status | Company status (e.g., active) |
| currency | Currency object associated with the company |

### Default Role Attributes

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

| Attribute Name | Description |
| --- | --- |
| id | Unique identifier of the role |
| name | Name of the role |
| description | Role description |
| createdAt | Timestamp when the role was created |
| updatedAt | Timestamp when the role was last updated |