Octopus Deploy
Deployments authenticate as the space, project and environment they run in.
Deployments authenticate as the space, project and environment they run in.
Identity proof
The token has to come from https://acme.octopus.app, and its sub claim has to match the workload you named. We compare that claim byte for byte, with no wildcards.
Every token also has to name your workspace as its audience. Ask for this audience and no other. A token requested for two audiences fails every exchange.
Console fields
| Field | Example | Advanced | What it pins |
|---|---|---|---|
| Octopus URL | https://acme.octopus.app | no | Your Octopus Cloud address, or the Server Uri under Configuration → Nodes. Must be reachable from the internet. |
| Project slug | web-api | no | From the project's URL, not its display name. |
| Environment slug | production | no | The slug on the environment's settings page, not its Environments-N id. Tenanted deployments and custom subject keys carry a different subject. |
| Space slug | default | yes | The space's slug, not its Spaces-N id. The Default space is default. |
A field marked advanced carries a default and stays behind the disclosure until you open it.
The console also asks which project and environment this identity reaches and which role it gets, with the credential lifetime behind Advanced.
Trust
Built from the example answers above:
| What | Value |
|---|---|
| Issuer | https://acme.octopus.app |
| Claim compared | sub |
| Subject | space:default:project:web-api:environment:production |
| Identity name | octopus-web-api-production |
We name the identity for you, so the form never asks for one.
Console snippet
# Octopus: add a Generic OIDC account with Audience YOUR_WORKSPACE_ID.
# Ask for this audience and no other. A token requested for two audiences fails every exchange.
# Add a project variable PenvCloud of type Generic OIDC Account, then in a Run a Script step:
T=$(get_octopusvariable "PenvCloud.OpenIdConnect.Jwt")
C=$(curl -sS "https://penv.cloud/api/v1/auth/oidc" \
-H 'content-type: application/json' \
-d "{\"token\":\"$T\"}" | jq -r .credential)
PENV_TOKEN="$C" penv pullThe snippet finishes with penv pull, which writes a file. We recommend penv run for a process; penv pull is for a host that needs a file on disk. Connect your CI has the wrapped step.
Related
- Machine identity
- Connect a Platform in the console
- Octopus Deploy documentation: the subject is the value most often set wrong