# SailPoint DeployHQ Connector Documentation

> DeployHQ Documentation

# Documentation

# Connecting SailPoint and DeployHQ

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 a generic Web Service URL as **DeployHQ Base URL**. For example, `https://example.deployhq.com`.
2. Enter **Username**.
3. Enter **API Key**.
4. Select **Save**.

## Review and Test

Perform a test to confirm the connection to SailPoint.

1. Go to **Review and Test**.
2. Confirm that the entries in each field are correct.

   If you note any mistakes, return to the section and make corrections.
3. Select **Test Connection**.

## SailPoint Application Onboarding

SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface.

For more information, refer to [Application Onboarding](<https://documentation.sailpoint.com/saas/help/ai/app_onboarding/index.html>) in the SailPoint SaaS documentation.

# Integrating SailPoint with DeployHQ

DeployHQ is a cloud-based deployment automation platform that helps engineering teams build, package, and deliver code from Git repositories (GitHub, GitLab, Bitbucket, and self-hosted Git) to servers, cloud storage, and S3-compatible targets over SSH, SFTP, and other protocols. This document provides instructions to configure a new direct connection to a DeployHQ source. 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 DeployHQ connector supports the following:

### Account Management

- Aggregate Users

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

- A DeployHQ user with **Account Administrator** rights. Account administrators have full visibility over all users and account-level permissions, which is required to aggregate the complete user list and the permission flags exposed in the account schema.
- The DeployHQ account URL (tenant base URL) in the form `https://{tenant}.deployhq.com`. This is the value that will be supplied to the connector as the base URL.
- For more information about the DeployHQ API, refer to the following resources:

  - [The DeployHQ API](<https://www.deployhq.com/support/api>)
  - [DeployHQ Users API](<https://www.deployhq.com/support/api/users-api>)

## Required Permissions

- It is recommended to create a dedicated DeployHQ user that will act as the integration service account, rather than reusing a personal user identity. This makes credential rotation and audit traceability easier.
- The service account must be granted **Account Administrator** privileges in DeployHQ. Only users with account administrator rights can list and inspect all users on the account through the API.
- Generate an API key for the service account from the DeployHQ user profile/security settings, and use HTTP Basic authentication with:

  - **Username** - The service account's login username/email
  - **Password** - The service account's API key (preferred) or password
- Non-administrator users can typically authenticate to the API but can only see themselves or limited team metadata; they cannot be used to drive full account aggregation.
- **Read access to all users on the DeployHQ account** is required so that account aggregation returns every user, not just the authenticated identity.

**Read access to account-level permission flags** is required so that attributes such as account\_administrator , can\_manage\_users , can\_manage\_billing , can\_create\_projects , can\_manage\_agents , all\_projects\_allowed , and activated are populated correctly.

**Note:** DeployHQ does not expose dedicated roles/groups/teams APIs through this connector, no entitlement aggregation is performed; the connector only needs read scope on the Users endpoint.

- For more information about API authentication and usage, refer to the following resources:

  - [DeployHQ Users API](<https://www.deployhq.com/support/api/users-api>)
  - [Using the DeployHQ API in scripts](<https://www.deployhq.com/support/scripting>)

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

# 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 DeployHQ 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 |
| --- | --- |
| identifier | Account |

### Default Account Attributes

The DeployHQ 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 |
| --- | --- |
| identifier | UUID-based unique identifier of the user |
| first\_name | The user's first name as recorded |
| last\_name | The user's last name as recorded |
| email\_address | The user's email address used to sign in and receive notifications |
| time\_zone | The user's preferred time zone |
| id | Numeric unique identifier of the user |
| account\_administrator | Boolean flag indicating whether the user has full administrator rights |
| activated | Boolean flag indicating whether the user account has been activated |
| can\_manage\_users | Boolean flag indicating whether the user can add, edit, or remove other users |
| can\_manage\_billing | Boolean flag indicating whether the user can view and manage billing details |
| can\_create\_projects | Boolean flag indicating whether the user is allowed to create new projects |
| can\_manage\_agents | Boolean flag indicating whether the user can manage deployment agents and servers |
| all\_projects\_allowed | Boolean flag indicating whether the user has access to projects |