HCP Terraform
Runs authenticate as the workspace and phase they ran in.
Runs authenticate as the workspace and phase they ran in.
Identity proof
The token has to come from https://app.terraform.io, 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 |
|---|---|---|---|
| Organization | acme | no | |
| Workspace | api-production | no | |
| Project | Default Project | yes | |
| Run phase | apply | yes | A workspace that needs both is two trusts. One of Plan, Apply. |
| Host | https://app.terraform.io | yes | Terraform Enterprise installs use their own URL, and must be reachable from the internet. |
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://app.terraform.io |
| Claim compared | sub |
| Subject | organization:acme:project:Default Project:workspace:api-production:run_phase:apply |
| Identity name | tfc-acme-api-production |
We name the identity for you, so the form never asks for one.
Console snippet
# In an agent hook or a local-exec: an HCP-managed run executes no shell.
# Workspace variable: TFC_WORKLOAD_IDENTITY_AUDIENCE = YOUR_WORKSPACE_ID
# The token is a run-wide environment variable; there is no narrower path.
T="$TFC_WORKLOAD_IDENTITY_TOKEN"
C=$(T="$T" jq -n '{token:env.T}' | curl -sS "https://penv.cloud/api/v1/auth/oidc" \
-H 'content-type: application/json' --data-binary @- | 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
- HCP Terraform documentation: the subject is the value most often set wrong