OIDC в GitHub Actions

Используйте REST API для взаимодействия с JWT для утверждений субъекта OIDC в GitHub Actions.

Set the GitHub Actions OIDC custom issuer policy for an enterprise

Sets the GitHub Actions OpenID Connect (OIDC) custom issuer policy for an enterprise. You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

Параметры для "Set the GitHub Actions OIDC custom issuer policy for an enterprise"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`enterprise` string Обязательно The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Параметры запроса
Имя, Тип, Описание
`include_enterprise_slug` boolean Whether the enterprise customer requested a custom issuer URL.

Коды состояния HTTP-ответа для "Set the GitHub Actions OIDC custom issuer policy for an enterprise"

Код состояния	Описание
`204`	No Content

Примеры кода для "Set the GitHub Actions OIDC custom issuer policy for an enterprise"

put/enterprises/{enterprise}/actions/oidc/customization/issuer

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/actions/oidc/customization/issuer \
  -d '{"include_enterprise_slug":true}'

Response

Status: 204

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

Работа с 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.

Параметры для "Get the customization template for an OIDC subject claim for an organization"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`org` string Обязательно The organization name. The name is not case sensitive.

Коды состояния HTTP-ответа для "Get the customization template for an OIDC subject claim for an organization"

Код состояния	Описание
`200`	A JSON serialized template for OIDC subject claim customization

Примеры кода для "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>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/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

Работа с 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.

Параметры для "Set the customization template for an OIDC subject claim for an organization"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`org` string Обязательно The organization name. The name is not case sensitive.
Параметры запроса
Имя, Тип, Описание
`include_claim_keys` array of strings Обязательно Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

Коды состояния HTTP-ответа для "Set the customization template for an OIDC subject claim for an organization"

Код состояния	Описание
`201`	Empty response
`403`	Forbidden
`404`	Resource not found

Примеры кода для "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>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/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

Работа с 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.

Параметры для "Get the customization template for an OIDC subject claim for a repository"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner` string Обязательно The account owner of the repository. The name is not case sensitive.
`repo` string Обязательно The name of the repository. The name is not case sensitive.

Коды состояния HTTP-ответа для "Get the customization template for an OIDC subject claim for a repository"

Код состояния	Описание
`200`	Status response
`400`	Bad Request
`404`	Resource not found

Примеры кода для "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>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/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

Работа с 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.

Параметры для "Set the customization template for an OIDC subject claim for a repository"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner` string Обязательно The account owner of the repository. The name is not case sensitive.
`repo` string Обязательно The name of the repository. The name is not case sensitive.
Параметры запроса
Имя, Тип, Описание
`use_default` boolean Обязательно Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.
`include_claim_keys` array of strings Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

Коды состояния HTTP-ответа для "Set the customization template for an OIDC subject claim for a repository"

Код состояния	Описание
`201`	Empty response
`400`	Bad Request
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Примеры кода для "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>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/actions/oidc/customization/sub \
  -d '{"use_default":false,"include_claim_keys":["repo","context"]}'

Empty response

Status: 201