Конечные точки REST API для OIDC GITHub Actions
Используйте REST API для взаимодействия с JWTs для утверждений субъекта OIDC в GitHub Actions.
О GitHub Actions OIDC
Rest API можно использовать для запроса шаблона настройки для утверждения субъекта OpenID Connect (OIDC) и управления им. Дополнительные сведения см. в разделе Сведения об усилении защиты с помощью OpenID Connect.
Get the customization template for an OIDC subject claim for an organization
Gets the customization template for an OpenID Connect (OIDC) subject claim.
OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Подробные маркеры доступа для "Get the customization template for an OIDC subject claim for an organization
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Administration" organization permissions (read)
Параметры для "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" \
http(s)://HOSTNAME/api/v3/orgs/ORG/actions/oidc/customization/subA 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.
OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Подробные маркеры доступа для "Set the customization template for an OIDC subject claim for an organization
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Administration" organization permissions (write)
Параметры для "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" \
http(s)://HOSTNAME/api/v3/orgs/ORG/actions/oidc/customization/sub \
-d '{"include_claim_keys":["repo","context"]}'Empty response
Status: 201Get the customization template for an OIDC subject claim for a repository
Gets the customization template for an OpenID Connect (OIDC) subject claim.
OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Подробные маркеры доступа для "Get the customization template for an OIDC subject claim for a repository
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Actions" repository permissions (read)
Эту конечную точку можно использовать без проверки подлинности или указанных выше разрешений, если запрашиваются только общедоступные ресурсы.
Параметры для "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" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/oidc/customization/subStatus 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Подробные маркеры доступа для "Set the customization template for an OIDC subject claim for a repository
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Actions" repository permissions (write)
Параметры для "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" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/oidc/customization/sub \
-d '{"use_default":false,"include_claim_keys":["repo","context"]}'Empty response
Status: 201