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 for more information.
The schema attributes that are not present by default 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 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 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 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.

Account Attributes Correlation Configuration Entitlement Attributes Group Attributes Octopus Deploy Role Attributes SaaS Schema Reference

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.