GitHub Enterprise Server
Workflows on your own GitHub server authenticate with the repository and ref they ran from.
Workflows on your own GitHub server authenticate with the repository and ref they ran from.
Identity proof
The token has to come from https://github.acme.com/_services/token, 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 |
|---|---|---|---|
| Server URL | https://github.acme.com | no | Must be reachable from the internet for us to read its signing keys. |
| Repository | acme/api | no | Owner and repository. |
| Branch | main | no | Only workflows on this branch authenticate. |
| Ref type | branch | yes | One of Branch, Tag. |
| Subject | branch | yes | A job that names an environment gets that in its subject instead of the ref. One of Branch or tag, Environment. |
| Environment | production | yes |
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://github.acme.com/_services/token |
| Claim compared | sub |
| Subject | repo:acme/api:ref:refs/heads/main |
| Identity name | ghes-acme-api-main |
We name the identity for you, so the form never asks for one.
Console snippet
permissions:
id-token: write # without this, no token is issued at all
# We refuse pull_request_target runs: trigger this job on push or pull_request.
steps:
- run: |
T=$(curl -sS \
-H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" \
"$ACTIONS_ID_TOKEN_REQUEST_URL&audience=YOUR_WORKSPACE_ID" | jq -r .value)
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
- GitHub Enterprise Server documentation: the subject is the value most often set wrong