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

PUT

/repos/{owner}/{repo}/actions/oidc/customization/sub

Sets the customization template and opt-in or opt-out flag for an OpenID Connect (OIDC) subject claim for a repository.
You must authenticate using an access token with the repo scope to use this
endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.github.com/repos///actions/oidc/customization/sub' \
--header 'Content-Type: application/json' \
--data-raw '{
    "include_claim_keys": [
        "repo",
        "context"
    ],
    "use_default": false
}'

Response Example

201 - default

null

Request

Path Params

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

Body Params application/json

Actions OIDC subject customization for a repository

include_claim_keys

array[string]

optional

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

use_default

boolean

required

Whether to use the default template or not. If true, the include_claim_keys field is ignored.

Examples

Responses

🟢201Empty response

application/json

Body

object {0}

🟠400400

🟠404404

🟠422422

Modified at 2023-08-15 02:59:24

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

Get GitHub Actions permissions for a repository