GitHub Actions OIDC

Verwende die REST-API zum Interagieren mit JWTs für OIDC-Antragstelleransprüche in GitHub Actions.

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

Funktioniert mit GitHub Apps

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.

Parameter für „Get the customization template for an OIDC subject claim for an organization“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.

HTTP-Antwortstatuscodes für „Get the customization template for an OIDC subject claim for an organization“

Statuscode	BESCHREIBUNG
`200`	A JSON serialized template for OIDC subject claim customization

Codebeispiele für „Get the customization template for an OIDC subject claim for an organization“

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/actions/oidc/customization/sub

A JSON serialized template for OIDC subject claim customization

Status: 200

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

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

Funktioniert mit GitHub Apps

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.

Parameter für „Set the customization template for an OIDC subject claim for an organization“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
Textparameter
Name, type, BESCHREIBUNG
`include_claim_keys` array of strings Erforderlich Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

HTTP-Antwortstatuscodes für „Set the customization template for an OIDC subject claim for an organization“

Statuscode	BESCHREIBUNG
`201`	Empty response
`403`	Forbidden
`404`	Resource not found

Codebeispiele für „Set the customization template for an OIDC subject claim for an organization“

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

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/actions/oidc/customization/sub \
  -d '{"include_claim_keys":["repo","context"]}'

Empty response

Status: 201

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

Funktioniert mit GitHub Apps

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

Parameter für „Get the customization template for an OIDC subject claim for a repository“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository. The name is not case sensitive.

HTTP-Antwortstatuscodes für „Get the customization template for an OIDC subject claim for a repository“

Statuscode	BESCHREIBUNG
`200`	Status response
`400`	Bad Request
`404`	Resource not found

Codebeispiele für „Get the customization template for an OIDC subject claim for a repository“

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/oidc/customization/sub

Status response

Status: 200

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

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

Funktioniert mit GitHub Apps

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.

Parameter für „Set the customization template for an OIDC subject claim for a repository“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository. The name is not case sensitive.
Textparameter
Name, type, BESCHREIBUNG
`use_default` boolean Erforderlich Whether to use the default template or not.

HTTP-Antwortstatuscodes für „Set the customization template for an OIDC subject claim for a repository“

Statuscode	BESCHREIBUNG
`201`	Empty response
`400`	Bad Request
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Codebeispiele für „Set the customization template for an OIDC subject claim for a repository“

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

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/oidc/customization/sub \
  -d '{"use_default":true}'

Empty response

Status: 201