# SailPoint TeamCity Connector Documentation

> TeamCity Connector Documentation

# Documentation

# Connecting SailPoint and TeamCity

To connect SailPoint with TeamCity, perform the following tasks:

## Adding 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. Sign in to SailPoint.
2. Go to **Admin \> Connections \> Sources**.
3. Select **Create New**.
4. Search for the connector by entering the name in the search box, and then select **Actions**.
5. In the **Actions** dropdown list, select the setup method:

   - [**Express Setup**](<#configuring-a-source-using-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**](<#configuring-a-source-using-standard-setup>) - Provide detailed basic configuration to create the source. Once the source is created, continue with source setup.

### Configuring a Source Using Express Setup

Express Setup minimizes the initial configuration process so you can quickly connect the application and immediately begin aggregating user account and entitlement data.

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**
   >
   > The source name must be unique. You can change these settings later in the source configuration.
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** section.
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.

### Configuring a Source Using Standard Setup

Use Standard Setup to configure the connector for full feature support.

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. Continue to configure your connected source there.

## 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 unique name and description for the source.
2. In the **Source Owner** dropdown list, select the identity that owns this source.

   - To find a source owner, begin entering their name.
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, 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. Refer to [Connection Settings](<#connection-settings>) for more information.
5. (Optional) In the **Governance Group for Source Management** dropdown list, select a governance group to associate with this source. 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>).
6. (Optional) Select **Create Manual Work Items** to allow the connector to create manual work items for certain operations. You can also enable this option so the source supports additional source management features such as creating accounts and access profile management.

   > **Important**
   >
   > Once you enable this feature, you cannot disable it.

   For more information on manual work items in SailPoint, 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>).
7. Select **Save**.

## Connection Settings

Enter the information that the source uses to connect to and authenticate with TeamCity.

1. In **Base URL**, enter the URL of your TeamCity instance, such as `https://your-account.teamcity.com` or `https://teamcity.yourcompany.com`.
2. In **Username**, enter the username of the TeamCity service account.
3. In **Password**, enter the password of the TeamCity service account.
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.

# Dataset Management

Dataset Management lets you review the object types a source collects and control how the source aggregates those objects into SailPoint. Use Dataset Management to view and manage resource attributes, datasets and their resources, enable dataset aggregation schedules, perform manual aggregation, and view aggregation history.

> [!NOTE]
>
> Datasets are also available in SailPoint Agentic Fabric. Contact your Customer Success team and refer to [SailPoint Agentic Fabric](<https://documentation.sailpoint.com/saas/help/agentic_fabric/index.html>) for more information.

For more information, refer to [Managing Datasets and Resources](<https://documentation.sailpoint.com/saas/help/sources/datasets.html>) for datasets, resources, owner correlation, and aggregation.

## Datasets

A *dataset* is a named group of one or more related resources that the source aggregates together.

When aggregation runs for a dataset, the source collects all resources in that dataset from the managed system in one aggregation job. Activate or deactivate aggregation at the dataset level, not for individual resources.

> [!NOTE]
>
> Each resource belongs to exactly one dataset for that source. The source defines which resources belong to each dataset. You can enable aggregation and review associated resources, but you cannot create or delete datasets or move resources between them.

### Dataset Aggregation

Configure aggregation on the **Dataset Aggregations** tab for each dataset. Configure each dataset separately. During aggregation, your owner correlation rules are automatically applied to link machine identities to their human owners. For more information, refer to [Configuring Dataset Aggregations](<https://documentation.sailpoint.com/saas/help/sources/datasets.html#configuring-dataset-aggregations>).

## Resources

A resource defines an object type from the managed system. It specifies the kind of object, the attributes the source collects, and how the source identifies and displays each object. Resources form the building blocks of the data model.

In the UI, each resource appears under **Dataset Management** \> **Resources** with its schema. A resource does not run aggregation by itself. The dataset that owns the resource collects it during aggregation.

For more information, refer to [Managing Resources](<https://documentation.sailpoint.com/saas/help/sources/datasets.html#managing-resources>).

### Owner Correlation

Configure owner correlation on each resource to link aggregated objects to human owners. If you do not configure owner correlation, or if the mapping produces no match, an owner is not assigned. For more information, refer to [Configuring Owner Correlation](<https://documentation.sailpoint.com/saas/help/sources/datasets.html#configuring-owner-correlation>).

## Supported Datasets

Go to **Dataset Management \> Datasets** on your TeamCity source to view the datasets the connector aggregates. Select a dataset to review its associated resources and configure aggregation.

> [!NOTE]
>
> Configure aggregation for each dataset separately. For more information, refer to [Dataset Aggregation](<https://documentation.sailpoint.com/saas/help/sources/datasets.html#configuring-dataset-aggregations>).

| Dataset Name | Associated Resource | Dataset ID |
| --- | --- | --- |
| TeamCity Credentials | TeamCity Access Token and TeamCity SSH Key | `teamcity:credentials` |

## Supported Resources

The TeamCity connector registers 2 resources across the 1 dataset.

Resource schemas appear under **Dataset Management** \> **Resources**. The connector-specific attributes are read-only.

For more information, refer to [Managing Resources](<https://documentation.sailpoint.com/saas/help/sources/datasets.html#managing-resources>).

> [!NOTE]
>
> When you enable dataset aggregation for a selected dataset, all resources in that dataset are collected at once. Activate or deactivate aggregation at the dataset level, not for individual resources.

| Resource Name | Resource Type | Resource ID |
| --- | --- | --- |
| [TeamCity Access Token](<#teamcity-access-token-attributes>) | Credential | `teamcity:access-token` |
| [TeamCity SSH Key](<#teamcity-ssh-key-attributes>) | Credential | `teamcity:ssh-key` |

## Owner Correlation

Configure owner correlation by mapping the resource's `ownerUserId` attribute to the `id` attribute of an aggregated TeamCity account.

If TeamCity usernames match identity names in SailPoint, you can instead map `ownerUsername` to the identity `name` or `uid` attribute.

SSH keys are project-scoped credentials and do not have a direct human owner. To configure project-level ownership correlation, map the `projectId` attribute to an identity that owns the project.

## TeamCity Access Token Attributes

The **TeamCity Access Token** resource represents personal access tokens issued to TeamCity users. The identity attribute is `identity`, and the display attribute is `name`.

| Attribute Name | Description | Type | Multi-Valued |
| --- | --- | --- | --- |
| `identity` | Composite token identifier in the format `{userId}#{tokenName}`. | string | No |
| `name` | Name assigned to the token in TeamCity. | string | No |
| `ownerUserId` | Numeric ID of the user who owns the token. Used for owner correlation. | string | No |
| `ownerUsername` | Username of the user who owns the token. Can be used for owner correlation. | string | No |
| `creationTime` | Date and time the token was created. | string | No |
| `expirationTime` | Date and time the token expires. Empty when the token does not expire. | string | No |
| `permissionRestrictions` | Permission names applied as restrictions to the token. An empty list indicates that the token inherits all permissions from the owner user. | string | Yes |
| `scopedProjectId` | Project ID to which the token is scoped. Empty when the token inherits permissions from the owner user. | string | No |

## TeamCity SSH Key Attributes

The **TeamCity SSH Key** resource represents SSH keys uploaded to projects for version control authentication and build operations. The identity attribute is `identity`, and the display attribute is `name`. The connector does not aggregate inherited keys again in child projects.

| Attribute Name | Description | Type | Multi-Valued |
| --- | --- | --- | --- |
| `identity` | Composite key identifier in the format `{projectId}#{keyName}`. | string | No |
| `name` | Name of the SSH key file. | string | No |
| `encrypted` | Indicates whether the private key is encrypted with a passphrase. | string | No |
| `projectId` | ID of the TeamCity project where the key is directly defined. | string | No |
| `projectName` | Name of the TeamCity project where the key is directly defined. | string | No |

# Integrating SailPoint with TeamCity

TeamCity is a continuous integration and continuous delivery (CI/CD) platform from JetBrains. Use the TeamCity connector to aggregate users as accounts, groups and roles as entitlements, and access tokens and SSH keys as non-human identities.

The connector is read-only and does not provision access.

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

| Feature | Description |
| --- | --- |
| Test connection | Validates the TeamCity REST API URL and authenticates with the configured username and password. |
| Account aggregation | Aggregates TeamCity users as SailPoint accounts. |
| Account read | Reads a TeamCity user by ID. |
| Entitlement aggregation | Aggregates TeamCity groups and roles as entitlements. |
| Entitlement read | Reads a TeamCity group or role by its identifier. |
| Dataset aggregation | Aggregates TeamCity access tokens and SSH keys as credentials. |

### Non-Human Identity Discovery

- Aggregate TeamCity access tokens and SSH keys

Refer to Dataset Management for more information.

Refer to [Discovering Potential Non-Human Accounts](<https://documentation.sailpoint.com/saas/help/agentic_fabric/nhi/non_human_accounts.html#discovering-potential-non-human-accounts>) for more information.

## Supported Version

The connector targets the TeamCity REST API at `{baseUrl}/app/rest`.

- **TeamCity Cloud** - Hosted accounts, such as `https://your-account.teamcity.com`.

The connector is compatible with TeamCity 2021.1 and later, which supports the REST API v2 format used by this connector.

## Prerequisites

### Preparing TeamCity

Complete these tasks before you configure the TeamCity source.

1. Ensure your TeamCity instance is available to SailPoint over HTTPS.
2. Sign in to TeamCity as a system administrator.
3. Go to **Administration** \> **Users**.
4. Select **Create user account**.
5. Enter a username and strong password for a dedicated SailPoint service account.
6. Assign the **System Administrator** role to the service account at the project root level.
7. Store the username and password in your secrets tooling.

> [!IMPORTANT]
>
> The connector uses HTTP Basic authentication. The service account must be able to read users, groups, roles, access tokens, and SSH keys across the TeamCity instance.

## Required Permissions

An account with the **System Administrator** role satisfies all permissions required by this connector, including reading users, groups, roles, access tokens, and project SSH keys.

# 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 TeamCity connector uses the following default correlation and object configurations.

## Default Correlation Configuration

Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements.

You can customize the correlation configuration. Refer to [Assigning Source Accounts to Identities](<https://documentation.sailpoint.com/saas/help/accounts/correlation.html>) for more information.

When you first create the TeamCity source, the default correlation mapping is:

| Account Attribute | Operation | Identity Attribute |
| --- | --- | --- |
| email | Equals, ignoring case | Email |
| username | Equals, ignoring case | Username |

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

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

The account schema represents TeamCity users. The identity attribute is `id`, the display attribute is `username`, and the group attribute is `groups`.

| Attribute Name | Description |
| --- | --- |
| `id` | Unique numeric identifier of the user. |
| `username` | Username the user enters to sign in to TeamCity. |
| `name` | Display name of the user. |
| `email` | Email address of the user. |
| `lastLogin` | Date and time the user last signed in. |
| `hasPassword` | Whether the user has a password. The value is `true` or `false`. |
| `enabled2FA` | Whether two-factor authentication is enabled. The value is `true` or `false`. |
| `groups` | Keys of the groups the user belongs to. |
| `roles` | IDs of the roles assigned directly to the user. |

## 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 TeamCity connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups.

The group entitlement represents a TeamCity user group. The identity attribute is `key`, and the display attribute is `name`.

| Attribute Name | Description |
| --- | --- |
| `key` | Unique identifier of the group. |
| `name` | Display name of the group. |
| `description` | Description of the group. |
| `parentGroups` | Keys of the parent groups this group belongs to. These values define the group hierarchy. |
| `childGroups` | Keys of the child groups that belong to this group. |
| `roles` | IDs of the roles assigned directly to the group. |

### Default Role Attributes

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

The role entitlement represents a TeamCity permission template. The identity attribute is `roleId`, and the display attribute is `name`.

| Attribute Name | Description |
| --- | --- |
| `roleId` | Unique identifier of the role. |
| `name` | Display name of the role. |
| `permissions` | Names of the permissions granted by the role. |
| `includedRoles` | IDs of the roles included in this role. |

# Troubleshooting

If you encounter any of the following issues or errors, SailPoint recommends that you follow the guidance provided below to resolve the error before contacting SailPoint Support.

For issues or errors that are not addressed in this connector guide, refer to the following resources for troubleshooting information:

- [SailPoint Identity Services Documentation](<https://documentation.sailpoint.com/saas/help/index.html>)
- [SailPoint Support Knowledge Base](<https://support.sailpoint.com/csm?id=kb_view2&amp;kb_id=05ff44289f011200550bf7b6077fcfa3>)
- [SailPoint Developer Community](<https://developer.sailpoint.com/>)

## Debug Logs

For information about managing additional source settings, including debug logging and downloading connector logs, refer to [Managing Additional Settings](<https://documentation.sailpoint.com/saas/help/sources/managing_additional_settings.html>).