Overview
Torii integrates with Octopus Deploy and syncs:
- Users and licenses
- You can constantly stay updated with application information from our Integrations Page >> Integration Capabilities button >> Integration Capabilities table.
Requirements
Accounts & Permissions
- An Octopus Deploy user or service account that can view users.
Required keys
To connect this integration, we require the following:
- Octopus Server URL - your Octopus Cloud address (for example, https://your-instance.octopus.app) or your self-hosted server address.
- API Key
How to Generate the Required Values
Step 1: Create an API key
- Log into the Octopus Web Portal, click your profile image and select My Profile.
- Click My API Keys.
- Click New API key and state the purpose of the key.
- Choose the level of Access to grant - read-only is sufficient for Torii.
- Optionally set an expiry date (see Q&A below).
- Click Generate new.
- Copy the new API key.
Important
After you generate an API key it cannot be retrieved from the Octopus Web Portal again - Octopus stores only a one-way hash. Save it somewhere secure before leaving the page.
Step 2: Note your Octopus Server URL
- Octopus Cloud: your instance address, for example https://your-instance.octopus.app
- Self-hosted: the address you use to reach the Octopus Web Portal.
How to Connect the Integration
- Go to the Integrations page in Torii.
- Search for Octopus Deploy and click Connect.
- Enter your Octopus Server URL and API Key.
- Click Connect.
Q&A
Q: Are service accounts synced?
A: No. Octopus service accounts are machine identities used for automation, so they are excluded and only real users are synced. The API key you connect with may still belong to a service account - that affects authentication only, not which users are synced.
Q: Does the API key expire?
A: Yes. By default, Octopus API keys are valid for 180 days from creation, and you can choose a different expiry when generating one. When the key expires the integration can no longer sync and will need to be reconnected with a new key.
For any further questions, please contact Torii Support.