GitHub

GitHub Oidc API

The Oidc API from GitHub — 1 operation(s) for oidc.

Documentation GitHub OpenAPI

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /orgs/{org}/actions/oidc/customization/sub Get an org's OIDC subject claim template · GitHub Get the Customization Template for an OIDC Subject Claim for an… #

Ask an LLM

“Which claim keys make up the OIDC subject claim for my organization's Actions tokens?”

“How is the OpenID Connect subject claim currently customized for our GitHub org?”

Tell an agent

Show the OIDC subject claim customization template for the {org} organization.

Check which claim keys {org} currently includes in its OIDC sub claim.

PUT /orgs/{org}/actions/oidc/customization/sub Set an org's OIDC subject claim template · GitHub Set the Customization Template for an OIDC Subject Claim for an… #

Ask an LLM

“Can I change which claims go into the OIDC subject claim for my org's workflows?”

“How do I customize the OpenID Connect sub claim so cloud trust policies can match on repo and environment?”

Tell an agent

Set the OIDC subject claim template for {org} to include the claim keys {include_claim_keys}.

Update the {org} organization's OIDC sub claim customization to use {include_claim_keys}.

Documentation

https://docs.github.com/en/rest/apps

https://docs.github.com/en/rest/codes-of-conduct/codes-of-conduct

https://docs.github.com/en/rest/emojis

https://docs.github.com/en/rest/gitignore

https://docs.github.com/en/rest/apps/installations

https://docs.github.com/en/rest/enterprise-admin

https://docs.github.com/en/rest/activity/events

https://docs.github.com/en/rest/orgs

https://docs.github.com/en/rest/rate-limit

https://docs.github.com/en/enterprise-cloud@latest/rest/scim

https://docs.github.com/en/rest/using-the-rest-api/getting-started-with-the-rest-api

https://docs.github.com/en/rest/teams

https://docs.github.com/en/rest/meta/meta

https://docs.github.com/en/rest/actions

https://docs.github.com/en/rest/branches

https://docs.github.com/en/rest/code-scanning

https://docs.github.com/en/rest/collaborators

https://docs.github.com/en/rest/dependabot

https://docs.github.com/en/rest/webhooks

https://docs.github.com/en/rest/pulls

https://docs.github.com/en/rest/git/tags

https://docs.github.com/en/rest/repos/autolinks

https://docs.github.com/en/rest/collaborators/invitations

Specifications

https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/openapi/github-oidc-api-openapi.yml

https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/asyncapi/github-webhooks-asyncapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-oidc-custom-sub-schema.json

https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-empty-object-schema.json

Other Resources

https://docs.github.com/en/webhooks/webhook-events-and-payloads

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/github-oidc-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: 1.1.4
  title: GitHub v3 REST Oidc API
  description: GitHub's v3 REST API.
  license:
    name: MIT
    url: https://spdx.org/licenses/MIT
  termsOfService: https://docs.github.com/articles/github-terms-of-service
  contact:
    name: Support
    url: https://support.github.com/contact?tags=dotcom-rest-api
  x-github-plan: ghes
  x-github-release: 3.9
servers:
- url: '{protocol}://{hostname}/api/v3'
  variables:
    hostname:
      description: Self-hosted Enterprise Server hostname
      default: HOSTNAME
    protocol:
      description: Self-hosted Enterprise Server protocol
      default: http
tags:
- name: OIDC
paths:
  /orgs/{org}/actions/oidc/customization/sub:
    get:
      summary: GitHub Get the Customization Template for an OIDC Subject Claim for an…
      description: 'Gets the customization template for an OpenID Connect (OIDC) subject claim.


        OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.'
      tags:
      - OIDC
      operationId: oidc/get-oidc-custom-sub-template-for-org
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      responses:
        '200':
          description: A JSON serialized template for OIDC subject claim customization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oidc-custom-sub'
              examples:
                default:
                  $ref: '#/components/examples/oidc-custom-sub'
      x-github:
        enabledForGitHubApps: true
        category: actions
        subcategory: oidc
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      summary: GitHub Set the Customization Template for an OIDC Subject Claim for an…
      description: 'Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.


        OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.'
      tags:
      - OIDC
      operationId: oidc/update-oidc-custom-sub-template-for-org
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/oidc-custom-sub'
            examples:
              default:
                $ref: '#/components/examples/oidc-custom-sub'
      responses:
        '201':
          description: Empty response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/empty-object'
              examples:
                default:
                  value: null
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
      x-github:
        enabledForGitHubApps: true
        previews: []
        category: actions
        subcategory: oidc
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    not_found:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/basic-error'
    forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/basic-error'
  schemas:
    basic-error:
      title: Basic Error
      description: Basic Error
      type: object
      properties:
        message:
          type: string
          example: Example body text
        documentation_url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        status:
          type: string
          example: open
    oidc-custom-sub:
      title: Actions OIDC Subject customization
      description: Actions OIDC Subject customization
      type: object
      properties:
        include_claim_keys:
          description: Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.
          type: array
          items:
            type: string
      required:
      - include_claim_keys
    empty-object:
      title: Empty Object
      description: An object without any properties.
      type: object
      properties: {}
      additionalProperties: false
  examples:
    oidc-custom-sub:
      value:
        include_claim_keys:
        - repo
        - context
  parameters:
    org:
      name: org
      description: The organization name. The name is not case sensitive.
      in: path
      required: true
      schema:
        type: string
externalDocs:
  description: GitHub Enterprise Developer Docs
  url: https://docs.github.com/enterprise-server@3.9/rest/