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 for more information.
For more information, refer to Managing Datasets and Resources 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.
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.
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.
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.
| 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.
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 | Account | octopus:service-account |
| Octopus API Key | Credential | octopus:api-key |
| Octopus Account (Credential Vault) | Credential | octopus:vault-account |
| Octopus Certificate | Credential | octopus:certificate |
| Octopus Git Credential | Credential | octopus:git-credential |
| Octopus Feed Credential | Credential | octopus:feed-credential |
| Octopus Proxy Credential | 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 |
Documentation Feedback
Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.