oidc

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

Changed on

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.

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

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/orgs/{org}/actions/oidc/customization/sub
  • Auth: none declared

Path parameters

orgstring required

The organization name. The name is not case sensitive.

Response

A JSON serialized template for OIDC subject claim customization

include_claim_keysstring[] required

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

use_immutable_subjectboolean

Whether to opt in to the immutable OIDC subject claim format for the organization. When true, new OIDC tokens will use a stable, repository-ID-based sub claim instead of the name-based format.

Changes