# SailPoint Buildkite Connector Documentation

> Buildkite Connector Documentation

# Documentation

# Connecting SailPoint and Buildkite

To connect SailPoint with Buildkite, 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

This section contains the information that the source uses to connect to and authenticate with the Buildkite managed system.

> [!NOTE]
>
> **Screenshot**
>
> [![Connection Settings page with the Organization Slug and API Access Token fields](<https://documentation.sailpoint.com/connectors/buildkite/saas/help/img/connection_settings.png>)](<https://documentation.sailpoint.com/connectors/buildkite/saas/help/img/connection_settings.png>)

1. In **Organization Slug**, enter the slug of the Buildkite organization to aggregate. The slug is the organization identifier that appears in your Buildkite URL, such as `acme-inc` in `https://buildkite.com/acme-inc`. The connector scopes every request to this organization.
2. In **API Access Token**, enter the read-only API access token that you created in [Prerequisites](<https://documentation.sailpoint.com/connectors/buildkite/saas/help/index.html#prerequisites>). The token owner must belong to the organization you entered in **Organization Slug**.
3. Select **Save**.

> [!IMPORTANT]
>
> Both fields are required. If the token owner does not belong to the organization named in **Organization Slug**, test connection fails.

## Aggregation Settings

> [!NOTE]
>
> **Screenshot**
>
> [![Aggregation Settings page with the Page Size field](<https://documentation.sailpoint.com/connectors/buildkite/saas/help/img/aggregation_settings.png>)](<https://documentation.sailpoint.com/connectors/buildkite/saas/help/img/aggregation_settings.png>)

1. In the **Page Size** field, enter the number of records to aggregate in a single page when iterating over large datasets. You can set a value from `1` to `100`. The default is `100`.

   Buildkite applies rate limits per user and organization. Leave **Page Size** at `100` unless aggregation times out. A lower value increases the number of API requests.
2. Select **Save**.

The **Page Size** value applies to account, entitlement, and dataset aggregation.

## 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 Buildkite 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 | Default Schedule |
| --- | --- | --- | --- |
| Buildkite Agent Tokens | Buildkite Agent Token | `buildkite:agent-tokens` | 1:30 AM and 1:30 PM UTC |
| Buildkite Secrets | Buildkite Secret | `buildkite:secrets` | 3:00 AM and 3:00 PM UTC |
| Buildkite Package Registries | Buildkite Registry Token | `buildkite:registries` | 9:00 AM and 9:00 PM UTC |

The connector staggers the schedules to reduce simultaneous demand on shared Buildkite rate limits. Manually started or long-running aggregations can overlap.

## Supported Resources

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 |
| --- | --- | --- |
| [Buildkite Agent Token](<#buildkite-agent-token-attributes>) | Credential | `buildkite:agent-token` |
| [Buildkite Secret](<#buildkite-secret-attributes>) | Credential | `buildkite:secret` |
| [Buildkite Registry Token](<#buildkite-registry-token-attributes>) | Credential | `buildkite:registry-token` |

## Owner Correlation

The connector maps each resource's `created_by_id` attribute to the `id` of an aggregated Buildkite account. When Buildkite does not return creator information, the credential is aggregated without an owner.

## Buildkite Agent Token Attributes

Schema attributes for the **Buildkite Agent Token** resource (`buildkite:agent-token`). The identity attribute is `id`, and the display attribute is `name`.

| Attribute Name | Description | Type | Multi-Valued |
| --- | --- | --- | --- |
| `allowed_ip_addresses` | CIDR allowlist. Empty when access is unrestricted. | string | Yes |
| `cluster_id` | ID of the cluster this token registers agents into. | string | No |
| `cluster_name` | Display name of the cluster this token registers agents into. | string | No |
| `created_at` | Date and time the token was created. | string | No |
| `created_by_id` | UUID of the user who created the token. Used for owner correlation. | string | No |
| `expired` | Whether the token has expired. The value is true or false. | string | No |
| `expires_at` | Date and time the token expires. Empty when the token does not expire. | string | No |
| `id` | Agent token UUID. | string | No |
| `name` | Token description. Buildkite agent tokens have no name field. | string | No |
| `owner` | Display name of the user who created the token. | string | Yes |

## Buildkite Secret Attributes

Schema attributes for the **Buildkite Secret** resource (`buildkite:secret`). The identity attribute is `id`, and the display attribute is `name`.

| Attribute Name | Description | Type | Multi-Valued |
| --- | --- | --- | --- |
| `cluster_id` | ID of the cluster this secret belongs to. | string | No |
| `cluster_name` | Display name of the cluster this secret belongs to. | string | No |
| `created_at` | Date and time the secret was created. | string | No |
| `created_by_id` | UUID of the user who created the secret. Used for owner correlation. | string | No |
| `description` | Description of the secret. | string | No |
| `id` | Secret UUID. | string | No |
| `last_read_at` | Date and time a build last read this secret. Empty if no build has read it. | string | No |
| `name` | Environment variable name a build uses to read this secret. | string | No |
| `never_read` | Whether a build has never read this secret. The value is true or false. | string | No |
| `owner` | Display names of the users who created and last updated the secret. | string | Yes |
| `policy` | YAML access policy that names which pipelines may read this secret. | string | No |
| `updated_at` | Date and time the secret was last updated. | string | No |
| `updated_by_id` | UUID of the user who last updated the secret. This is not used for owner correlation. | string | No |

## Buildkite Registry Token Attributes

Schema attributes for the **Buildkite Registry Token** resource (`buildkite:registry-token`). The identity attribute is `id`, and the display attribute is `name`.

| Attribute Name | Description | Type | Multi-Valued |
| --- | --- | --- | --- |
| `created_at` | Date and time the token was created. | string | No |
| `created_by_id` | UUID of the user who created the token. Used for owner correlation. | string | No |
| `id` | Registry token UUID. | string | No |
| `name` | Token description. Buildkite registry tokens have no name field. | string | No |
| `owner` | Display name of the user who created the token. | string | Yes |
| `registry_id` | ID of the registry this token can read. | string | No |
| `registry_slug` | Slug of the registry this token can read. | string | No |

> [!NOTE]
>
> Buildkite registry tokens do not include an expiration date.

# Integrating SailPoint with Buildkite

Buildkite is a continuous integration and continuous delivery (CI/CD) platform. Use the Buildkite connector to aggregate organization members as accounts, organization roles and teams as entitlements, and the following non-human identities:

- Cluster-scoped agent tokens
- Cluster-scoped secrets
- Package registry read tokens

The connector is read-only. It does not provision access or retrieve secret values, agent token values, registry token values, or build logs.

> [!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 organization slug, API access token, required scopes, Buildkite API availability, organization membership, and access to organization members and clusters. |
| Account aggregation | Aggregates Buildkite organization members as SailPoint accounts. |
| Entitlement aggregation | Aggregates Buildkite organization roles and teams as entitlements. |
| Dataset aggregation | Aggregates agent tokens, cluster secrets, and package registry read tokens as credentials. |

### Non-Human Identity Discovery

- Aggregate Buildkite agent tokens, cluster secrets, and package registry read tokens

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 supports the Buildkite REST API v2 at `https://api.buildkite.com/v2`.

## Prerequisites

### Preparing Buildkite

Complete these tasks before you configure the Buildkite source.

1. Ensure your Buildkite organization has API access enabled.
2. Sign in to Buildkite with a user who belongs to the organization and can view its teams.
3. Go to **Personal Settings** \> **API Access Tokens** and select **New API Access Token**.
4. Enable REST API access and grant the required read scopes. Refer to [Required Permissions](<#required-permissions>).
5. Create the token and copy it immediately. Store it in your secrets tooling.
6. Copy the organization slug from your Buildkite URL, such as `acme-inc` in `https://buildkite.com/acme-inc`.

> [!IMPORTANT]
>
> Each source aggregates one Buildkite organization. The token owner must belong to the organization whose slug you enter in [Connection Settings](<https://documentation.sailpoint.com/connectors/buildkite/saas/help/connecting.html#connection-settings>). To aggregate more organizations, create a source for each one.

For more information, refer to [Managing API Access Tokens](<https://buildkite.com/docs/apis/managing-api-tokens>) in the Buildkite documentation.

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

## Required Permissions

Grant the API access token the following read scopes:

| Scope | API Scope | Description |
| --- | --- | --- |
| Organizations | `read_organizations` | Verifies organization details and lists organization members. |
| Teams | `read_teams` | Lists teams and team members. |
| Clusters | `read_clusters` | Lists clusters and reaches their agent tokens and secrets. |
| Secrets | `read_secrets_details` | Lists metadata for cluster-scoped secrets. Buildkite does not return secret values. |
| Package registries | `read_registries` | Lists package registries and their read tokens. |

Test connection reports missing required scopes by name.

# 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 Buildkite 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 Buildkite source, the default correlation mapping is:

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

Buildkite organization members have no username, so email is the default correlation key.

## 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 Buildkite 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 Buildkite organization members. The identity attribute is `id`, the display attribute is `name`, and the group attribute is `teams`.

| Attribute Name | Description |
| --- | --- |
| `id` | Buildkite organization member UUID. |
| `name` | Member display name. Buildkite organization members have no username, so this is not a sign-in name. |
| `email` | Member email address. This is the correlation key. |
| `sso_mode` | Organization SSO enforcement mode for this member, such as `required`. Returned only when the token belongs to an organization admin. |
| `role` | Organization-level role. The value is `admin` or `member`. |
| `teams` | Slugs of the teams the member belongs to. |
| `team_roles` | Role on each team, formatted as `team-slug:role`. Role is `member` or `maintainer`. If Buildkite reports no role, only the team slug is returned. |

## 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 Buildkite 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 Buildkite organization-level role. The identity attribute is `id`, and the display attribute is `name`.

| Attribute Name | Description |
| --- | --- |
| `id` | Role identifier. The value is `admin` or `member`. |
| `name` | Name of the role. |
| `description` | Description of the access the role grants at the organization level. |

### Default Team Attributes

The team entitlement represents a Buildkite organization team. The identity attribute is `slug`, and the display attribute is `name`.

| Attribute Name | Description |
| --- | --- |
| `id` | Team UUID. |
| `slug` | URL-safe team identifier. |
| `name` | Display name of the team. |
| `description` | Description of the team. Empty when Buildkite provides no description. |
| `privacy` | Team visibility. The value is `visible` or `secret`. |
| `default` | Whether new organization members join this team automatically. |
| `default_member_role` | Role assigned when a member joins. The value is `member` or `maintainer`. |
| `members_can_create_pipelines` | Whether team members may create pipelines. |
| `members_can_create_suites` | Whether team members may create test suites. |
| `members_can_create_registries` | Whether team members may create package registries. |
| `members_can_destroy_registries` | Whether team members may delete package registries. |
| `members_can_destroy_packages` | Whether team members may delete packages from a registry. |
| `created_at` | Date and time the team was created. |
| `created_by_name` | Display name of the user who created the team. Empty when Buildkite created the team. |

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

## Test connection returns 401

**Resolution**: Confirm that **API Access Token** contains a valid token with REST API access enabled. Replace the token if it is expired, revoked, or entered incorrectly.

## Test connection returns 404 for the organization

**Resolution**: Confirm that **Organization Slug** matches the slug in your Buildkite URL, such as `acme-inc` in `https://buildkite.com/acme-inc`. Enter the slug, not the display name of the organization. Confirm that the token owner belongs to that organization.

## Test connection reports missing scopes

**Resolution**: Edit or replace the token and grant each scope named in the error. Refer to [Required Permissions](<https://documentation.sailpoint.com/connectors/buildkite/saas/help/index.html#required-permissions>).

## Test connection cannot list organization members

**Resolution**: Confirm that the token owner belongs to the organization and can view its teams. Some Buildkite plans restrict team permissions.

## Account aggregation returns no members

**Resolution**: Run test connection and confirm that the configured token has `read_organizations` and permission to list organization members. Confirm that the organization contains members.

## Entitlement aggregation returns no teams

**Resolution**: Confirm that the token has `read_teams`. If Buildkite reports a plan limitation, update the organization plan to enable team permissions.

## Agent token or secret aggregation returns no records

**Resolution**: Confirm that the organization contains clusters and that the token has `read_clusters`. Secret aggregation also requires `read_secrets_details`.

## Registry token aggregation returns no records

**Resolution**: Confirm that the token has `read_registries` and that package registries are enabled for the Buildkite organization.

## Aggregation returns 429 or runs slowly

**Resolution**: Buildkite applies shared rate limits per user and organization. Avoid overlapping manual and scheduled aggregations. Leave **Page Size** at `100` unless aggregation times out.