# SailPoint Spacelift Connector Documentation

> Spacelift Connector Documentation

# Documentation

# Connecting SailPoint and Spacelift

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

To configure connection settings, complete the following:

> [!NOTE]
>
> **Screenshot**
>
> [![Spacelift connection settings with Base URL, API Key ID, and API Key Secret.](<https://documentation.sailpoint.com/connectors/spacelift/saas/help/img/connection_settings.png>)](<https://documentation.sailpoint.com/connectors/spacelift/saas/help/img/connection_settings.png>)

1. Enter the fully qualified **Base URL** of your Spacelift account. SailPoint recommends using HTTPS for a secured connection.

   For example: `https://your-account.app.spacelift.io`
2. Enter the **API Key ID**. Use the 26-character ULID from the `api_key_id` value in the downloaded Spacelift API key file. For more information, refer to [Prerequisites](<https://documentation.sailpoint.com/connectors/spacelift/saas/help/index.html#creating-the-api-key-id-and-secret>).
3. Enter the **API Key Secret**. Use the `api_key_secret` value from the downloaded Spacelift API key file. SailPoint stores the encrypted value and exchanges it for a JSON Web Token (JWT) at runtime.
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 Spacelift 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 | Dataset ID | Associated Resource |
| --- | --- | --- |
| Spacelift Credentials | `spacelift:credentials` | Spacelift API Key |

## Supported Resources

The Spacelift Credentials dataset includes one resource.

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 |
| --- | --- | --- |
| [Spacelift API Key](<#spacelift-api-key-attributes>) | Credential | `spacelift:api-key` |

## Spacelift API Key Attributes

Identity attribute: `Id`

Display attribute: `Name`

| Attribute Name | Description |
| --- | --- |
| `Id` | Unique identifier of the API key. For OIDC keys, this value is prefixed. For example, `oidc::spacelift::XXXXXXXXXXXXXXXXXXXXXXX`. |
| `Admin` | Indicates if the API key has administrative access. |
| `Created At` | Timestamp indicating when the API key was created. |
| `Creator` | Identity of the creator of the API key. |
| `Deleted` | Indicates if the API key is deleted. |
| `Expires At` | Timestamp indicating when the API key expires. This field is absent when the key does not expire. |
| `Last Used At` | Timestamp indicating when the API key was last used. This field is absent when the key has never been used. |
| `Name` | Name of the API key. |
| `Issuer` | OIDC issuer URL. |
| `Client Id` | OIDC client ID (audience). |
| `Subject Expression` | Regular expression against which the system matches the subject of the OIDC token. |
| `Claim Mapping` | OIDC claim mapping formatted as `name:value` entries. This field remains empty for secret-based keys. |
| `Team Count` | Number of teams associated with the API key. |
| `Teams` | Teams associated with the API key. Teams provide the key with a virtual group membership. |
| `Space Count` | Number of spaces associated with the API key. |
| `Access Rules` | List of permissions given explicitly to user, formatted as `space:spaceAccessLevel.` |
| `Is Machine User` | Indicates if the API key represents a machine user. |
| `Type` | Type of the API key, either `SECRET` or `OIDC`. |
| `Description` | Description of the API key. |
| `Roles` | IDs of roles bound to this API key, retrieved from `apiKeyRoleBindings.role.id`. |

# Integrating SailPoint with Spacelift

Spacelift is a continuous integration and continuous delivery (CI/CD) and infrastructure orchestration platform. It supports Terraform, OpenTofu, Pulumi, CloudFormation, and Kubernetes automation workflows. The Spacelift connector uses a single GraphQL endpoint to aggregate Spacelift objects into SailPoint for governance and certifications.

The connector supports:

- Spacelift managed users as accounts
- Spacelift roles as entitlements
- Spacelift API keys as non-human identities (Credentials)

> [!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 reachability of the Spacelift GraphQL endpoint and exchanges the configured API Key ID and API Key Secret for a JSON Web Token (JWT). |
| Account aggregation | Aggregates Spacelift managed users as SailPoint accounts. |
| Account read | Reads a single Spacelift managed user. |
| Entitlement aggregation | Aggregates Spacelift roles as entitlements. |
| Dataset aggregation | Aggregates Spacelift API keys as non-human identities. |

### Non-Human Identity Discovery

- Aggregate Spacelift API 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

- Spacelift SaaS (Cloud)

## Prerequisites

Before you configure the Spacelift source, you need the following:

- A Spacelift account that SailPoint can reach over HTTPS
- Spacelift admin access to create API keys
- A dedicated secret-based Spacelift API key for the integration

## Creating the API Key ID and Secret

The connector uses a secret-based API key. Spacelift supports secret-based and OpenID Connect (OIDC)-based API keys. The connector exchanges the secret-based API Key ID and API Key Secret for a JSON Web Token (JWT).

1. Sign in to your Spacelift account.
2. In the lower-right menu, select your account name, and then select **Organization settings**.
3. In the **Access** section, select **API keys**, and then select **Create API key**.
4. Enter a key name in **Name**. For example: `SailPoint`.
5. For **Type**, select **Secret**.
6. Select **Admin** so the key can read organization-level objects. For more information, refer to [Required Permissions](<#required-permissions>).
7. For **Space**, select the **root** space with the **admin** access level so the key inherits access to every space.
8. (Optional) Set an expiration date. After the key expires, update the source with a new key.
9. Select **Create**. Spacelift generates and downloads a configuration file.
10. Open the downloaded file and copy the `api_key_id` and `api_key_secret` values.
11. Store both values in your secrets tooling. Spacelift does not store the secret, and you cannot retrieve or recreate it later.

The `api_key_id` value is the 26-character ULID of the key. Enter it in **API Key ID**. Enter the `api_key_secret` value in **API Key Secret**.

For vendor steps and screenshots, refer to the Secret-based API keys section of the [Spacelift GraphQL API documentation](<https://docs.spacelift.io/integrations/api>).

## Required Permissions

The connector sends queries to `https://<account>.app.spacelift.io/graphql`. These queries read organization-level objects.

Configure the API key as an **Admin** key with **space admin** access to the **root** space.

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

Spacelift exposes two email sources. The `Email` attribute originates from SCIM metadata and is present only for SCIM-provisioned users. If the `Email` attribute is empty, the system falls back to the `Invitation Email` attribute.

Configure your account correlation settings using the following mappings:

| Account Attribute | Operation | Identity Attribute |
| --- | --- | --- |
| `Email` | Equals, ignoring case | email |
| `Invitation 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 Spacelift connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.

SailPoint marks accounts as disabled when the Spacelift `Status` is `INACTIVE`.

| Attribute Name | Description |
| --- | --- |
| `Id` | Globally unique, immutable ID of the managed user. This is a stable identity attribute. |
| `Username` | Username from the account's identity provider. This is the display attribute. |
| `Invitation Email` | Email address used to invite the user to the account. This field can be empty. |
| `Space Count` | Number of spaces to which the user has explicit permissions. |
| `Access Rules` | List of permissions given explicitly to user, formatted as `space:spaceAccessLevel.` |
| `Group Count` | Number of identity provider groups the user belonged to during their last login. |
| `Latest Groups` | Identity provider groups the user belonged to during their last login. |
| `Created At` | Timestamp indicating when the latest invitation was issued. |
| `Sent At` | Timestamp indicating when the latest invitation was sent. This field can be empty for unsent invitations. |
| `Last Login Time` | Timestamp indicating when the user last authenticated. |
| `Login Method` | Identity provider used to authenticate the user. |
| `Status` | User's status. This attribute drives the account's enabled or disabled state. |
| `Role` | Built-in role indicating whether the user is an administrator or a standard user. |
| `Slack Member ID` | ID of the Slack user granted the same permissions as this managed user through the Slack integration. |
| `Roles` | Roles bound to this user, retrieved from `userRoleBindings.roleID`. This is a role entitlement. |
| `Scim Group Memberships` | Names of the groups the user is a member of via SCIM provisioning. |
| `External Id` | External ID assigned by the SCIM identity provider. |
| `Given Name` | First name retrieved from the SCIM identity provider. |
| `Family Name` | Last name retrieved from the SCIM identity provider. |
| `Formatted Name` | Formatted full name retrieved from the SCIM identity provider. |
| `Display Name` | Display name retrieved from the SCIM identity provider. |
| `Provisioned At` | Timestamp indicating when the user was provisioned via SCIM. |
| `Email` | Email address retrieved from the SCIM identity provider. |

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

Spacelift roles are permission templates that Spacelift binds to users, groups, and API keys. The identity attribute is `Id`, and the display attribute is `Name`.

| Attribute Name | Description |
| --- | --- |
| `Id` | Unique identifier of the role. |
| `Name` | Human-readable name of the role. |
| `Slug` | URL-friendly unique identifier of the role. |
| `Is System` | Indicates whether the role is a built-in system role. |
| `Description` | Human-readable description of the role. |
| `Actions` | Actions in Spacelift that a holder of this role can perform. These represent the actual permission grants. |

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