The connector reads one Octopus Deploy instance. It syncs that instance’s
users and teams — both instance-wide teams and teams scoped to individual
spaces — along with each team’s membership. Users sync as enabled or
disabled based on their active state in Octopus, and service accounts are
labeled as such.The built-in Everyone team includes every user on the instance by
definition, so the connector reports each user as a member of it. Teams
mapped to external directory groups (Active Directory or Microsoft Entra
ID) carry those mappings as team attributes for visibility; membership
conferred through an external directory group resolves inside Octopus at
sign-in and is not expanded into individual memberships.
The API key’s owner needs permission to view users and teams across the
instance. Membership in the built-in Octopus Administrators or
Octopus Managers team covers this. A key created by a user without
those permissions cannot list other users and does not work with this
connector.
1
Sign in to your Octopus instance as a user with permission to view
users and teams, or use a service account with those permissions.
2
Open your avatar menu and go to Profile > My API Keys (for a
service account, open the account under Configuration > Users
and find its API Keys section). Click New API Key, give it a
purpose, and create it.
3
Copy the key when it is shown — Octopus displays it only once — and
note your instance’s base URL. For Octopus Cloud this is
https://<instance>.octopus.app; for self-hosted Octopus Server it is
your own address, including any virtual directory the server is
installed under.
