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