GitHub · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitHub v3 REST Oidc API

3 actions 3 updates phrasing extends openapi/github-oidc-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for GitHub's API. It is a proposal applied on top of the contract, not a document GitHub publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/orgs/{org}/actions/oidc/customization/sub'].get
$.paths['/orgs/{org}/actions/oidc/customization/sub'].put

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GitHub v3 REST Oidc API
  version: 1.0.0
extends: openapi/github-oidc-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/orgs/{org}/actions/oidc/customization/sub'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an org's OIDC subject claim template
      effect: read
      questions:
      - 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?
      instructions:
      - text: Show the OIDC subject claim customization template for the {org} organization.
        slots:
          org: path.org
      - text: Check which claim keys {org} currently includes in its OIDC sub claim.
        slots:
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/oidc/customization/sub'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an org's OIDC subject claim template
      effect: write
      questions:
      - 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?
      instructions:
      - text: Set the OIDC subject claim template for {org} to include the claim keys {include_claim_keys}.
        slots:
          org: path.org
          include_claim_keys: requestBody.include_claim_keys
      - text: Update the {org} organization's OIDC sub claim customization to use {include_claim_keys}.
        slots:
          org: path.org
          include_claim_keys: requestBody.include_claim_keys
      method: generated
      generated: '2026-09-24'