# SailPoint Octopus Deploy Connector Documentation

> Octopus Deploy Connector Documentation

# Documentation

# Connecting SailPoint and Octopus Deploy

To connect SailPoint with Octopus Deploy, 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 Octopus Deploy.

> [!NOTE]
>
> **Screenshot**
>
> [![Connection Settings page with the Octopus Server URL and API Key fields](<https://documentation.sailpoint.com/connectors/octopus_deploy/saas/help/img/connection_settings.png>)](<https://documentation.sailpoint.com/connectors/octopus_deploy/saas/help/img/connection_settings.png>)

1. In **Octopus Server URL**, enter the base URL of your Octopus Deploy instance, such as `https://your-instance.octopus.app` for Octopus Cloud or your self-hosted server URL. The connector appends `/api` to this URL.
2. In **API Key**, enter the API key for the dedicated service account you created in [Prerequisites](<https://documentation.sailpoint.com/connectors/octopus_deploy/saas/help/index.html#prerequisites>). The connector does not aggregate the key secret.
3. Select **Save**.

## Aggregation Settings

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

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

   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 Octopus Deploy 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 |
| --- | --- | --- | --- |
| Octopus Service Accounts | Octopus Service Account | `octopus:service-accounts` | Every 12 hours |
| Octopus API Keys | Octopus API Key | `octopus:api-keys` | Every 12 hours |
| Octopus Stored Accounts | Octopus Account (Credential Vault) | `octopus:vault-accounts` | Every 12 hours |
| Octopus Certificates | Octopus Certificate | `octopus:certificates` | Every 12 hours |
| Octopus Git Credentials | Octopus Git Credential | `octopus:git-credentials` | Every 12 hours |
| Octopus Feeds | Octopus Feed Credential | `octopus:feeds` | Every 12 hours |
| Octopus Proxies | Octopus Proxy Credential | `octopus:proxies` | Every 12 hours |

Space-scoped datasets aggregate objects from each space. If a transient or data error prevents the connector from reading one space, the connector skips that space and continues. Authentication and permission errors end the aggregation.

## 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 |
| --- | --- | --- |
| [Octopus Service Account](<#octopus-service-account-attributes>) | Account | `octopus:service-account` |
| [Octopus API Key](<#octopus-api-key-attributes>) | Credential | `octopus:api-key` |
| [Octopus Account (Credential Vault)](<#octopus-account-credential-vault-attributes>) | Credential | `octopus:vault-account` |
| [Octopus Certificate](<#octopus-certificate-attributes>) | Credential | `octopus:certificate` |
| [Octopus Git Credential](<#octopus-git-credential-attributes>) | Credential | `octopus:git-credential` |
| [Octopus Feed Credential](<#octopus-feed-credential-attributes>) | Credential | `octopus:feed-credential` |
| [Octopus Proxy Credential](<#octopus-proxy-credential-attributes>) | Credential | `octopus:proxy-credential` |

## Owner Correlation

The connector maps the `user_id` of an API key to the `Id` of an aggregated human account. API keys that belong to service accounts do not correlate to a human owner. Other Octopus Deploy resources do not provide an ownership field.

> [!NOTE]
>
> Boolean resource attributes are represented by the strings `true` and `false`. Account attributes such as `IsActive` and `IsService` use Boolean values.

## Octopus Service Account Attributes

Schema attributes for the **Octopus Service Account** resource (`octopus:service-account`). The identity attribute is `id`, and the display attribute is `name`.

| Attribute Name | Description | Type | Multi-Valued |
| --- | --- | --- | --- |
| `id` | Unique identifier for the service account in the source, such as `Users-21`. | string | No |
| `name` | Display name of the service account. | string | No |
| `username` | Sign-in name of the service account. | string | No |
| `email` | Email address of the service account, if set. | string | No |
| `is_active` | Indicates whether the service account is active. | string | No |
| `teams` | Teams the service account belongs to. | string | Yes |
| `owner` | Human accounts accountable for this service account. Octopus Deploy does not record an owner, so this is empty. | string | Yes |
| `created_at` | Date and time when the service account was created, in ISO-8601 UTC format. | string | No |

## Octopus API Key Attributes

Schema attributes for the **Octopus API Key** resource (`octopus:api-key`). The identity attribute is `id`, and the display attribute is `name`. The connector does not aggregate the key secret.

| Attribute Name | Description | Type | Multi-Valued |
| --- | --- | --- | --- |
| `id` | Unique identifier for the API key in the source. | string | No |
| `name` | Purpose recorded for the API key when it was created. | string | No |
| `owner` | Human accounts accountable for this API key, taken from the sign-in name of the account the key belongs to. Empty when that account cannot be resolved. | string | Yes |
| `user_id` | Account the API key belongs to. Used to correlate the key to its owning identity. | string | No |
| `created_at` | Date and time when the API key was created, in ISO-8601 UTC format. | string | No |
| `expires_at` | Date and time when the API key expires, in ISO-8601 UTC format. Empty when the key does not expire. | string | No |
| `last_used_at` | Date and time when the API key was last used, in ISO-8601 UTC format. Empty when Octopus Deploy does not report it. | string | No |

## Octopus Account (Credential Vault) Attributes

Schema attributes for the **Octopus Account (Credential Vault)** resource (`octopus:vault-account`). The identity attribute is `id`, and the display attribute is `name`. Octopus Deploy masks secret values.

| Attribute Name | Description | Type | Multi-Valued |
| --- | --- | --- | --- |
| `id` | Unique identifier for the stored account in the source. | string | No |
| `name` | Name of the stored account. | string | No |
| `description` | Description of the stored account, if provided. | string | No |
| `account_type` | Type of the stored account, such as `AmazonWebServicesAccount`, `AzureServicePrincipal`, `GoogleCloudAccount`, `SshKeyPair`, `UsernamePassword`, or `Token`. | string | No |
| `space_id` | Space that owns the stored account. | string | No |
| `environment_ids` | Environments the stored account may be used in. | string | Yes |
| `tenant_ids` | Tenants the stored account may be used for. | string | Yes |
| `tenanted_deployment_participation` | Whether the stored account may be used for tenanted deployments, untenanted deployments, or both. | string | No |
| `has_secret` | Indicates whether secret material is stored for this account. The connector does not collect the secret. | string | No |
| `owner` | Human accounts accountable for this credential. Octopus Deploy does not record an owner, so this is empty. | string | Yes |

## Octopus Certificate Attributes

Schema attributes for the **Octopus Certificate** resource (`octopus:certificate`). The identity attribute is `id`, and the display attribute is `name`. The connector does not aggregate private key material.

| Attribute Name | Description | Type | Multi-Valued |
| --- | --- | --- | --- |
| `id` | Unique identifier for the certificate in the source. | string | No |
| `name` | Name of the certificate. | string | No |
| `notes` | Notes recorded for the certificate, if provided. | string | No |
| `subject_common_name` | Common name of the certificate subject. | string | No |
| `issuer_common_name` | Common name of the authority that issued the certificate. | string | No |
| `thumbprint` | Certificate thumbprint. | string | No |
| `serial_number` | Serial number assigned by the issuing authority. | string | No |
| `not_before` | Date and time from which the certificate is valid, in ISO-8601 UTC format. | string | No |
| `not_after` | Date and time when the certificate expires, in ISO-8601 UTC format. | string | No |
| `has_private_key` | Indicates whether a private key is stored with the certificate. The connector does not collect the key. | string | No |
| `signature_algorithm_name` | Signature algorithm used to sign the certificate. | string | No |
| `space_id` | Space that owns the certificate. | string | No |
| `environment_ids` | Environments the certificate may be used in. | string | Yes |
| `tenant_ids` | Tenants the certificate may be used for. | string | Yes |
| `owner` | Human accounts accountable for this certificate. Octopus Deploy does not record an owner, so this is empty. | string | Yes |

## Octopus Git Credential Attributes

Schema attributes for the **Octopus Git Credential** resource (`octopus:git-credential`). The identity attribute is `id`, and the display attribute is `name`. The connector does not aggregate passwords or tokens.

| Attribute Name | Description | Type | Multi-Valued |
| --- | --- | --- | --- |
| `id` | Unique identifier for the Git credential in the source. | string | No |
| `name` | Name of the Git credential. | string | No |
| `description` | Description of the Git credential, if provided. | string | No |
| `space_id` | Space that owns the Git credential. | string | No |
| `auth_type` | Authentication type of the credential, such as `UsernamePassword`. | string | No |
| `username` | Git username the credential authenticates with. | string | No |
| `has_secret` | Indicates whether a password or token is stored for this credential. The connector does not collect the secret. | string | No |
| `repository_restrictions_enabled` | Indicates whether the credential may be used only with an approved list of repositories. | string | No |
| `allowed_repositories` | Repository URLs the credential may be used with when repository restrictions are enabled. | string | Yes |
| `owner` | Human accounts accountable for this credential. Octopus Deploy does not record an owner, so this is empty. | string | Yes |

## Octopus Feed Credential Attributes

Schema attributes for the **Octopus Feed Credential** resource (`octopus:feed-credential`). The identity attribute is `id`, and the display attribute is `name`. The connector does not aggregate the feed secret.

| Attribute Name | Description | Type | Multi-Valued |
| --- | --- | --- | --- |
| `id` | Unique identifier for the feed credential, derived from the identifier of its feed. | string | No |
| `name` | Display name for the feed credential, derived from the name of its feed. | string | No |
| `feed_id` | Feed this credential authenticates to. | string | No |
| `username` | Username used to authenticate to the feed. | string | No |
| `has_secret` | Indicates whether a secret is stored for the feed. The connector does not collect the secret. | string | No |
| `space_id` | Space that owns the feed. | string | No |

## Octopus Proxy Credential Attributes

Schema attributes for the **Octopus Proxy Credential** resource (`octopus:proxy-credential`). The identity attribute is `id`, and the display attribute is `name`. The connector does not aggregate the proxy secret.

| Attribute Name | Description | Type | Multi-Valued |
| --- | --- | --- | --- |
| `id` | Unique identifier for the proxy credential, derived from the identifier of its proxy. | string | No |
| `name` | Display name for the proxy credential, derived from the name of its proxy. | string | No |
| `proxy_id` | Proxy this credential authenticates to. | string | No |
| `username` | Username used to authenticate to the proxy. | string | No |
| `has_secret` | Indicates whether a secret is stored for the proxy. The connector does not collect the secret. | string | No |
| `space_id` | Space that owns the proxy. | string | No |

# Integrating SailPoint with Octopus Deploy

Octopus Deploy is a release management and deployment automation platform. Use the Octopus Deploy connector to aggregate human users as accounts, teams and user roles as entitlements, and the following machine identities:

- Service accounts
- API keys
- Stored accounts from the credential vault
- Certificates
- Git credentials
- Feed credentials
- Proxy 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 the Octopus Deploy server URL, API key, API availability, and permissions. |
| Account aggregation | Aggregates active and inactive human users as SailPoint accounts. Service accounts are excluded. |
| Entitlement aggregation | Aggregates Octopus Deploy teams and user roles as entitlements. |
| Dataset aggregation | Aggregates service accounts and credential metadata as machine identities. |

### Non-Human Identity Discovery

- Aggregate Octopus Deploy service accounts, API keys, stored accounts, certificates, Git credentials, feed credentials, and proxy credentials

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 Octopus Cloud and self-hosted Octopus Deploy instances that expose the Octopus Deploy REST API over HTTPS. The connector appends `/api` to the configured server URL.

Verify that the Octopus Deploy version exposes the endpoints required for the objects you want to aggregate.

## Prerequisites

### Preparing Octopus Deploy

Complete these tasks before you configure the Octopus Deploy source.

1. Ensure your Octopus Deploy instance is reachable from SailPoint over HTTPS.
2. Create a dedicated Octopus Deploy service account for the integration.
3. Grant the service account the read permissions described in [Required Permissions](<#required-permissions>).
4. Sign in to Octopus Deploy as an administrator.
5. Select your profile avatar and select **Profile**, or go to **Configuration** \> **Users** and open the dedicated service account.
6. On the **API Keys** page, select **New API Key**.
7. Enter a purpose for the key, set an expiration that meets your security policy, and select **Generate New**.
8. Copy the API key immediately and store it securely. Octopus Deploy displays the secret only once.

For more information, refer to [Getting Started with the Octopus REST API](<https://octopus.com/docs/octopus-rest-api/getting-started>) in the Octopus Deploy documentation.

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

## Required Permissions

Grant the dedicated service account read access to the objects you want to aggregate.

- To aggregate the full inventory across spaces, assign the **System Manager** role in each space.
- For least-privilege access, create a role that contains the equivalent view permissions for users, teams, user roles, spaces, accounts, API keys, certificates, Git credentials, feeds, and proxies.
- Grant the role in each space that the connector must aggregate.

> [!IMPORTANT]
>
> If a required permission is missing, Octopus Deploy returns HTTP 403. The connector error identifies the missing permission, such as `SpaceView`.

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

| Account Attribute | Operation | Identity Attribute |
| --- | --- | --- |
| EmailAddress | 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 Octopus Deploy 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 Octopus Deploy human users. The native object type is `User`, the identity attribute is `Id`, the display attribute is `Username`, and the group attribute is `TeamIds`.

Users with an `IsService` value of `true` are excluded from account aggregation and aggregated as machine identities.

| Attribute Name | Description |
| --- | --- |
| `Id` | Unique identifier for the user in the source, such as `Users-1`. |
| `Username` | Sign-in name of the user. |
| `DisplayName` | Display name of the user. |
| `EmailAddress` | Email address of the user. Used as the primary correlation value. |
| `IsActive` | Indicates whether the account is active. Inactive accounts are aggregated as disabled. |
| `IsService` | Indicates whether the account is a service account. Service accounts are aggregated as machine identities, so this value is false on human accounts. Empty when Octopus Deploy does not report the flag. |
| `Created` | Date and time when the user was created, in ISO-8601 UTC format. |
| `IdentityProviderName` | External identity providers the user authenticates with, such as Azure AD, Okta, or LDAP. Used to correlate the account to the corporate directory. |
| `TeamIds` | Teams the user belongs to. |
| `Roles` | User roles granted through the user's team role assignments. |

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

The team entitlement schema represents Octopus Deploy teams. The identity attribute is `Id`, and the display attribute is `Name`.

| Attribute Name | Description |
| --- | --- |
| `Id` | Unique identifier for the team in the source, such as `Teams-1`. |
| `Name` | Name of the team. |
| `Slug` | URL-friendly short name for the team. |
| `Description` | Description of the team, if provided. |
| `SpaceId` | Space that owns the team. Empty for teams that apply to the whole instance. |
| `ExternalSecurityGroups` | External identity provider groups federated into this team. |

### Default Role Attributes

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

The user role entitlement schema represents Octopus Deploy user roles. The identity attribute is `Id`, and the display attribute is `Name`.

| Attribute Name | Description |
| --- | --- |
| `Id` | Unique identifier for the user role in the source, such as `userroles-buildserver`. |
| `Name` | Name of the user role. |
| `Description` | Description of the user role, if provided. |
| `GrantedSpacePermissions` | Permissions the role grants within a space. |
| `GrantedSystemPermissions` | Permissions the role grants across the whole instance. |
| `SupportedRestrictions` | Dimensions the role can be restricted to, such as environments, projects, or tenants. |

# 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 Key** contains a valid key for the dedicated service account. Replace the key if it is expired, revoked, or entered incorrectly.

## Test connection or aggregation returns 403

**Resolution**: Grant the permission named in the error, such as `SpaceView`, in the affected space. Refer to [Required Permissions](<https://documentation.sailpoint.com/connectors/octopus_deploy/saas/help/index.html#required-permissions>).

## Test connection returns a connectivity or TLS error

**Resolution**: Confirm that **Octopus Server URL** is an absolute HTTPS URL with a valid host and no extra path. Confirm that the certificate chain is trusted and the instance is reachable from SailPoint.

## Account aggregation returns no accounts

**Resolution**: Confirm that the service account can read Octopus Deploy users. Account aggregation includes only users whose `IsService` value is `false`.

## Entitlement aggregation returns no teams or user roles

**Resolution**: Confirm that the service account can read teams, user roles, scoped user roles, and team membership in each space.

## A dataset returns fewer objects than expected

**Resolution**: Confirm that the service account can read the resource type in each space. A transient or data error can cause the connector to skip one space and continue aggregating the others.

## Aggregation is slow or intermittently times out

**Resolution**: The connector retries HTTP 429 and server errors with backoff. If the problem continues, lower **Page Size** and confirm that the Octopus Deploy instance is healthy.

## Dataset information appears stale

**Resolution**: Datasets aggregate every 12 hours by default. Start an on-demand aggregation from the dataset's **Dataset Aggregation** page or adjust its schedule.