OIDC

Endpoints to manage GitHub OIDC configuration using the REST API.

Get the customization template for an OIDC subject claim for an organization

get /orgs/{org}/actions/oidc/customization/sub

Gets the customization template for an OpenID Connect (OIDC) subject claim. You must authenticate using an access token with the read:org scope to use this endpoint. GitHub Apps must have the organization_administration:write permission to use this endpoint.

org

string

required

The organization name. The name is not case sensitive.

Response

ExamplesSchema

A JSON serialized template for OIDC subject claim customization

{
  "include_claim_keys": [
    "repo",
    "context"
  ]
}

Set the customization template for an OIDC subject claim for an organization

put /orgs/{org}/actions/oidc/customization/sub

Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. You must authenticate using an access token with the write:org scope to use this endpoint. GitHub Apps must have the admin:org permission to use this endpoint.

include_claim_keys

array[string]

required

Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

Request

{
  "include_claim_keys": [
    "repo",
    "context"
  ]
}

Response

ExamplesSchema

Empty response

null