Skip to content

GitHub: OIDC schemas

3 GitHub schemas with complete fields and constraints.

← OIDC operations · All schemas

Create an OIDC custom property inclusion for an enterprise — request body — body

FieldTypePresenceDescription and constraints
$objectRootInput for creating an OIDC custom property inclusion
custom_property_namestringRequired within parentThe name of the custom property to include in the OIDC token

Create an OIDC custom property inclusion for an enterprise — response body

FieldTypePresenceDescription and constraints
$objectRootAn OIDC custom property inclusion for repository properties
custom_property_namestringRequired within parentThe name of the custom property that is included in the OIDC token
inclusion_sourcestringRequired within parentWhether the inclusion was defined at the organization or enterprise level
Known values: organization, enterprise

Get the customization template for an OIDC subject claim for an organization — response body

FieldTypePresenceDescription and constraints
$objectRootActions OIDC Subject customization
include_claim_keysarrayRequired within parentArray of unique strings. Each claim key can only contain alphanumeric characters and underscores.
include_claim_keys[]stringEach item
use_immutable_subjectbooleanOptionalWhether 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.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.