Sample - GitHub REST API
PUT/repos/{owner}/{repo}/actions/oidc/customization/sub

Set the customization template for an OIDC subject claim for a repository

Sets the customization template and opt-in or opt-out flag for an OpenID Connect (OIDC) subject claim for a repository.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters · 3 body fields
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
use_defaultbooleanrequired
Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.
include_claim_keysarray<string>optional
Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.
use_immutable_subjectbooleanoptional
Whether to opt in to the immutable OIDC subject claim format for this repository. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim.

4 status codes
201Empty response
400Bad Request
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Validation failed, or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<string>optional

Error handling

A 400 is returned: Bad Request. A 404 is returned: Resource not found. A 422 is returned: Validation failed, or the endpoint has been spammed.