OIDC в GitHub Actions
Use the REST API to interact with JWTs for OIDC subject claims in GitHub Actions.
О GitHub Actions OIDC
С помощью REST API можно запрашивать и управлять шаблоном настройки для утверждения субъекта OpenID Подключение (OIDC). Дополнительные сведения см. в разделе «AUTOTITLE».
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"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Имя., Тип, Description |
---|
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"
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
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"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
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"
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
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"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
org string Обязательное полеThe organization name. The name is not case sensitive. |
Имя., Тип, Description |
---|
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"
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
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"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
owner string Обязательное полеThe account owner of the repository. The name is not case sensitive. |
repo string Обязательное полеThe name of the repository without the |
Коды состояния 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"
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
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"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
owner string Обязательное полеThe account owner of the repository. The name is not case sensitive. |
repo string Обязательное полеThe name of the repository without the |
Имя., Тип, Description |
---|
use_default boolean Обязательное полеWhether to use the default template or not. If |
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"
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