Skip to content

Add documentation for new OIDC claims #9725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Add documentation for new OIDC claims #9725

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
219b790
Document new vcs-sha OIDC claim
meeech Nov 1, 2025
2b2b3aa
Document pipeline-id, org-id, and vcs-sha OIDC claims
meeech Nov 1, 2025
85dea68
Fix vcs-sha description to match vcs-* claim style
meeech Nov 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/guides/modules/permissions-authentication/pages/openid-connect-tokens.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,21 @@ The OpenID Connect ID tokens also contain some https://openid.net/specs/openid-c
| `oidc.circleci.com/project-id`
| The ID of the project in which the job is running. Its value is a string containing a UUID identifying the CircleCI project.

| `oidc.circleci.com/pipeline-id`
| The unique identifier for the pipeline that triggered this job. Its value is a string containing a UUID identifying the CircleCI pipeline.

| `oidc.circleci.com/org-id`
| The unique identifier for the organization. Its value is a string containing a UUID identifying the CircleCI organization.

| `oidc.circleci.com/vcs-origin`
| The URL of the repository that triggered the pipeline. Its value is a string similar to `github.com/organization-123/repo-1`. This is not present for pipelines triggered by custom webhooks.

| `oidc.circleci.com/vcs-ref`
| The reference to the change that triggered the pipeline. Its value is a string similar to `refs/heads/main`. This is not present for pipelines triggered by custom webhooks.

| `oidc.circleci.com/vcs-sha`
| The git commit SHA that triggered the pipeline. Its value is a string containing the full commit hash. This is not present for pipelines triggered by custom webhooks.

| `oidc.circleci.com/context-ids`
| An array of strings containing UUIDs that identify the context(s) used in the job. Currently, just one context is supported.

Expand Down