Поддержка этой версии GitHub Enterprise была прекращена 2023-03-15. Исправления выпускаться не будут даже при критических проблемах безопасности. Для повышения производительности, укрепления безопасности и новых функций установите последнюю версию GitHub Enterprise. Чтобы получить справку по обновлению, обратитесь в службу поддержки GitHub Enterprise.
Разрешения GitHub Actions
Используйте REST API для взаимодействия с разрешениями для GitHub Actions.
Сведения о разрешениях для GitHub Actions
С помощью REST API можно задать разрешения для предприятий, организаций и репозиториев, которым разрешено выполнять GitHub Actions, а также действий, которые разрешены к выполнению. Дополнительные сведения см. в разделе Ограничения использования, выставление счетов и администрирование.
Get GitHub Actions permissions for an enterprise
Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Параметры для "Get GitHub Actions permissions for an enterprise"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
enterprisestringОбязательноThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Коды состояния HTTP-ответа для "Get GitHub Actions permissions for an enterprise"
| Код состояния | Описание |
|---|---|
200 | OK |
Примеры кода для "Get GitHub Actions permissions for an enterprise"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/permissionsResponse
Status: 200{
"enabled_organizations": "all",
"allowed_actions": "selected",
"selected_actions_url": "https://HOSTNAME/enterprises/2/actions/permissions/selected-actions"
}Set GitHub Actions permissions for an enterprise
Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Параметры для "Set GitHub Actions permissions for an enterprise"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
enterprisestringОбязательноThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
| Параметры запроса |
| Имя, Тип, Описание |
enabled_organizationsstringОбязательноThe policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Может быть одним из: |
allowed_actionsstringThe permissions policy that controls the actions that are allowed to run. Может быть одним из: |
Коды состояния HTTP-ответа для "Set GitHub Actions permissions for an enterprise"
| Код состояния | Описание |
|---|---|
204 | No Content |
Примеры кода для "Set GitHub Actions permissions for an enterprise"
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/permissions \
-d '{"enabled_organizations":"all","allowed_actions":"selected"}'Response
Status: 204List selected organizations enabled for GitHub Actions in an enterprise
Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see "Set GitHub Actions permissions for an enterprise."
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Параметры для "List selected organizations enabled for GitHub Actions in an enterprise"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
enterprisestringОбязательноThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
| Параметры запроса |
| Имя, Тип, Описание |
per_pageintegerThe number of results per page (max 100). Значение по умолчанию: |
pageintegerPage number of the results to fetch. Значение по умолчанию: |
Коды состояния HTTP-ответа для "List selected organizations enabled for GitHub Actions in an enterprise"
| Код состояния | Описание |
|---|---|
200 | OK |
Примеры кода для "List selected organizations enabled for GitHub Actions in an enterprise"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/permissions/organizationsResponse
Status: 200{
"total_count": 1,
"organizations": [
{
"login": "octocat",
"id": 161335,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"url": "https://HOSTNAME/orgs/octo-org",
"repos_url": "https://HOSTNAME/orgs/octo-org/repos",
"events_url": "https://HOSTNAME/orgs/octo-org/events",
"hooks_url": "https://HOSTNAME/orgs/octo-org/hooks",
"issues_url": "https://HOSTNAME/orgs/octo-org/issues",
"members_url": "https://HOSTNAME/orgs/octo-org/members{/member}",
"public_members_url": "https://HOSTNAME/orgs/octo-org/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization"
}
]
}Set selected organizations enabled for GitHub Actions in an enterprise
Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see "Set GitHub Actions permissions for an enterprise."
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Параметры для "Set selected organizations enabled for GitHub Actions in an enterprise"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
enterprisestringОбязательноThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
| Параметры запроса |
| Имя, Тип, Описание |
selected_organization_idsarray of integersОбязательноList of organization IDs to enable for GitHub Actions. |
Коды состояния HTTP-ответа для "Set selected organizations enabled for GitHub Actions in an enterprise"
| Код состояния | Описание |
|---|---|
204 | No Content |
Примеры кода для "Set selected organizations enabled for GitHub Actions in an enterprise"
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/permissions/organizations \
-d '{"selected_organization_ids":[32,91]}'Response
Status: 204Enable a selected organization for GitHub Actions in an enterprise
Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see "Set GitHub Actions permissions for an enterprise."
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Параметры для "Enable a selected organization for GitHub Actions in an enterprise"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
enterprisestringОбязательноThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
org_idintegerОбязательноThe unique identifier of the organization. |
Коды состояния HTTP-ответа для "Enable a selected organization for GitHub Actions in an enterprise"
| Код состояния | Описание |
|---|---|
204 | No Content |
Примеры кода для "Enable a selected organization for GitHub Actions in an enterprise"
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/permissions/organizations/ORG_IDResponse
Status: 204Disable a selected organization for GitHub Actions in an enterprise
Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see "Set GitHub Actions permissions for an enterprise."
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Параметры для "Disable a selected organization for GitHub Actions in an enterprise"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
enterprisestringОбязательноThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
org_idintegerОбязательноThe unique identifier of the organization. |
Коды состояния HTTP-ответа для "Disable a selected organization for GitHub Actions in an enterprise"
| Код состояния | Описание |
|---|---|
204 | No Content |
Примеры кода для "Disable a selected organization for GitHub Actions in an enterprise"
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/permissions/organizations/ORG_IDResponse
Status: 204Get allowed actions for an enterprise
Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for an enterprise."
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Параметры для "Get allowed actions for an enterprise"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
enterprisestringОбязательноThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Коды состояния HTTP-ответа для "Get allowed actions for an enterprise"
| Код состояния | Описание |
|---|---|
200 | OK |
Примеры кода для "Get allowed actions for an enterprise"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/permissions/selected-actionsResponse
Status: 200{
"github_owned_allowed": true,
"verified_allowed": false,
"patterns_allowed": [
"monalisa/octocat@*",
"docker/*"
]
}Set allowed actions for an enterprise
Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for an enterprise."
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Параметры для "Set allowed actions for an enterprise"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
enterprisestringОбязательноThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
| Параметры запроса |
| Имя, Тип, Описание |
github_owned_allowedbooleanОбязательноWhether GitHub-owned actions are allowed. For example, this includes the actions in the |
patterns_allowedarray of stringsОбязательноSpecifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, |
Коды состояния HTTP-ответа для "Set allowed actions for an enterprise"
| Код состояния | Описание |
|---|---|
204 | No Content |
Примеры кода для "Set allowed actions for an enterprise"
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/permissions/selected-actions \
-d '{"github_owned_allowed":true,"verified_allowed":false,"patterns_allowed":["monalisa/octocat@*","docker/*"]}'Response
Status: 204Get GitHub Actions permissions for an organization
Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
Параметры для "Get GitHub Actions permissions for an organization"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
orgstringОбязательноThe organization name. The name is not case sensitive. |
Коды состояния HTTP-ответа для "Get GitHub Actions permissions for an organization"
| Код состояния | Описание |
|---|---|
200 | OK |
Примеры кода для "Get GitHub Actions permissions for an organization"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/orgs/ORG/actions/permissionsResponse
Status: 200{
"enabled_repositories": "all",
"allowed_actions": "selected",
"selected_actions_url": "https://HOSTNAME/organizations/42/actions/permissions/selected-actions"
}Set GitHub Actions permissions for an organization
Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.
If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions, then you cannot override them for the organization.
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
Параметры для "Set GitHub Actions permissions for an organization"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
orgstringОбязательноThe organization name. The name is not case sensitive. |
| Параметры запроса |
| Имя, Тип, Описание |
enabled_repositoriesstringОбязательноThe policy that controls the repositories in the organization that are allowed to run GitHub Actions. Может быть одним из: |
allowed_actionsstringThe permissions policy that controls the actions that are allowed to run. Может быть одним из: |
Коды состояния HTTP-ответа для "Set GitHub Actions permissions for an organization"
| Код состояния | Описание |
|---|---|
204 | No Content |
Примеры кода для "Set GitHub Actions permissions for an organization"
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/orgs/ORG/actions/permissions \
-d '{"enabled_repositories":"all","allowed_actions":"selected"}'Response
Status: 204List selected repositories enabled for GitHub Actions in an organization
Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
Параметры для "List selected repositories enabled for GitHub Actions in an organization"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
orgstringОбязательноThe organization name. The name is not case sensitive. |
| Параметры запроса |
| Имя, Тип, Описание |
per_pageintegerThe number of results per page (max 100). Значение по умолчанию: |
pageintegerPage number of the results to fetch. Значение по умолчанию: |
Коды состояния HTTP-ответа для "List selected repositories enabled for GitHub Actions in an organization"
| Код состояния | Описание |
|---|---|
200 | OK |
Примеры кода для "List selected repositories enabled for GitHub Actions in an organization"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/orgs/ORG/actions/permissions/repositoriesResponse
Status: 200{
"total_count": 1,
"repositories": [
{
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://HOSTNAME/repos/octocat/Hello-World",
"archive_url": "https://HOSTNAME/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://HOSTNAME/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://HOSTNAME/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://HOSTNAME/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://HOSTNAME/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://HOSTNAME/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://HOSTNAME/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://HOSTNAME/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://HOSTNAME/repos/octocat/Hello-World/contributors",
"deployments_url": "https://HOSTNAME/repos/octocat/Hello-World/deployments",
"downloads_url": "https://HOSTNAME/repos/octocat/Hello-World/downloads",
"events_url": "https://HOSTNAME/repos/octocat/Hello-World/events",
"forks_url": "https://HOSTNAME/repos/octocat/Hello-World/forks",
"git_commits_url": "https://HOSTNAME/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://HOSTNAME/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://HOSTNAME/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://HOSTNAME/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://HOSTNAME/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://HOSTNAME/repos/octocat/Hello-World/languages",
"merges_url": "https://HOSTNAME/repos/octocat/Hello-World/merges",
"milestones_url": "https://HOSTNAME/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://HOSTNAME/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://HOSTNAME/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://HOSTNAME/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://HOSTNAME/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://HOSTNAME/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://HOSTNAME/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://HOSTNAME/repos/octocat/Hello-World/subscription",
"tags_url": "https://HOSTNAME/repos/octocat/Hello-World/tags",
"teams_url": "https://HOSTNAME/repos/octocat/Hello-World/teams",
"trees_url": "https://HOSTNAME/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://HOSTNAME/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": null,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"is_template": true,
"topics": [
"octocat",
"atom",
"electron",
"api"
],
"has_issues": true,
"has_projects": true,
"has_wiki": true,
"has_pages": false,
"has_downloads": true,
"archived": false,
"disabled": false,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {
"admin": false,
"push": false,
"pull": true
},
"allow_rebase_merge": true,
"template_repository": null,
"temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
"allow_squash_merge": true,
"allow_auto_merge": false,
"delete_branch_on_merge": true,
"allow_merge_commit": true,
"subscribers_count": 42,
"network_count": 0,
"license": {
"key": "mit",
"name": "MIT License",
"url": "https://HOSTNAME/licenses/mit",
"spdx_id": "MIT",
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://github.com/licenses/mit"
},
"forks": 1,
"open_issues": 1,
"watchers": 1
}
]
}Set selected repositories enabled for GitHub Actions in an organization
Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
Параметры для "Set selected repositories enabled for GitHub Actions in an organization"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
orgstringОбязательноThe organization name. The name is not case sensitive. |
| Параметры запроса |
| Имя, Тип, Описание |
selected_repository_idsarray of integersОбязательноList of repository IDs to enable for GitHub Actions. |
Коды состояния HTTP-ответа для "Set selected repositories enabled for GitHub Actions in an organization"
| Код состояния | Описание |
|---|---|
204 | No Content |
Примеры кода для "Set selected repositories enabled for GitHub Actions in an organization"
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/orgs/ORG/actions/permissions/repositories \
-d '{"selected_repository_ids":[32,42]}'Response
Status: 204Enable a selected repository for GitHub Actions in an organization
Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
Параметры для "Enable a selected repository for GitHub Actions in an organization"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
orgstringОбязательноThe organization name. The name is not case sensitive. |
repository_idintegerОбязательноThe unique identifier of the repository. |
Коды состояния HTTP-ответа для "Enable a selected repository for GitHub Actions in an organization"
| Код состояния | Описание |
|---|---|
204 | No Content |
Примеры кода для "Enable a selected repository for GitHub Actions in an organization"
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/orgs/ORG/actions/permissions/repositories/REPOSITORY_IDResponse
Status: 204Disable a selected repository for GitHub Actions in an organization
Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
Параметры для "Disable a selected repository for GitHub Actions in an organization"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
orgstringОбязательноThe organization name. The name is not case sensitive. |
repository_idintegerОбязательноThe unique identifier of the repository. |
Коды состояния HTTP-ответа для "Disable a selected repository for GitHub Actions in an organization"
| Код состояния | Описание |
|---|---|
204 | No Content |
Примеры кода для "Disable a selected repository for GitHub Actions in an organization"
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/orgs/ORG/actions/permissions/repositories/REPOSITORY_IDResponse
Status: 204Get allowed actions for an organization
Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization.""
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
Параметры для "Get allowed actions for an organization"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
orgstringОбязательноThe organization name. The name is not case sensitive. |
Коды состояния HTTP-ответа для "Get allowed actions for an organization"
| Код состояния | Описание |
|---|---|
200 | OK |
Примеры кода для "Get allowed actions for an organization"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/orgs/ORG/actions/permissions/selected-actionsResponse
Status: 200{
"github_owned_allowed": true,
"verified_allowed": false,
"patterns_allowed": [
"monalisa/octocat@*",
"docker/*"
]
}Set allowed actions for an organization
Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."
If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.
To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
Параметры для "Set allowed actions for an organization"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
orgstringОбязательноThe organization name. The name is not case sensitive. |
| Параметры запроса |
| Имя, Тип, Описание |
github_owned_allowedbooleanОбязательноWhether GitHub-owned actions are allowed. For example, this includes the actions in the |
patterns_allowedarray of stringsОбязательноSpecifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, |
Коды состояния HTTP-ответа для "Set allowed actions for an organization"
| Код состояния | Описание |
|---|---|
204 | No Content |
Примеры кода для "Set allowed actions for an organization"
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/orgs/ORG/actions/permissions/selected-actions \
-d '{"github_owned_allowed":true,"verified_allowed":false,"patterns_allowed":["monalisa/octocat@*","docker/*"]}'Response
Status: 204Get GitHub Actions permissions for a repository
Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.
You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
Параметры для "Get GitHub Actions permissions for a repository"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
ownerstringОбязательноThe account owner of the repository. The name is not case sensitive. |
repostringОбязательноThe name of the repository. The name is not case sensitive. |
Коды состояния HTTP-ответа для "Get GitHub Actions permissions for a repository"
| Код состояния | Описание |
|---|---|
200 | OK |
Примеры кода для "Get GitHub Actions permissions for a repository"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/permissionsResponse
Status: 200{
"enabled": true,
"allowed_actions": "selected",
"selected_actions_url": "https://HOSTNAME/repositories/42/actions/permissions/selected-actions"
}Set GitHub Actions permissions for a repository
Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.
If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.
You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
Параметры для "Set GitHub Actions permissions for a repository"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
ownerstringОбязательноThe account owner of the repository. The name is not case sensitive. |
repostringОбязательноThe name of the repository. The name is not case sensitive. |
| Параметры запроса |
| Имя, Тип, Описание |
enabledbooleanОбязательноWhether GitHub Actions is enabled on the repository. |
allowed_actionsstringThe permissions policy that controls the actions that are allowed to run. Может быть одним из: |
Коды состояния HTTP-ответа для "Set GitHub Actions permissions for a repository"
| Код состояния | Описание |
|---|---|
204 | No Content |
Примеры кода для "Set GitHub Actions permissions for a repository"
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/permissions \
-d '{"enabled":true,"allowed_actions":"selected"}'Response
Status: 204Get allowed actions for a repository
Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for a repository."
You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
Параметры для "Get allowed actions for a repository"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
ownerstringОбязательноThe account owner of the repository. The name is not case sensitive. |
repostringОбязательноThe name of the repository. The name is not case sensitive. |
Коды состояния HTTP-ответа для "Get allowed actions for a repository"
| Код состояния | Описание |
|---|---|
200 | OK |
Примеры кода для "Get allowed actions for a repository"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/permissions/selected-actionsResponse
Status: 200{
"github_owned_allowed": true,
"verified_allowed": false,
"patterns_allowed": [
"monalisa/octocat@*",
"docker/*"
]
}Set allowed actions for a repository
Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for a repository."
If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.
To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.
You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
Параметры для "Set allowed actions for a repository"
| Заголовки |
|---|
| Имя, Тип, Описание |
acceptstringSetting to |
| Параметры пути |
| Имя, Тип, Описание |
ownerstringОбязательноThe account owner of the repository. The name is not case sensitive. |
repostringОбязательноThe name of the repository. The name is not case sensitive. |
| Параметры запроса |
| Имя, Тип, Описание |
github_owned_allowedbooleanОбязательноWhether GitHub-owned actions are allowed. For example, this includes the actions in the |
patterns_allowedarray of stringsОбязательноSpecifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, |
Коды состояния HTTP-ответа для "Set allowed actions for a repository"
| Код состояния | Описание |
|---|---|
204 | No Content |
Примеры кода для "Set allowed actions for a repository"
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/permissions/selected-actions \
-d '{"github_owned_allowed":true,"verified_allowed":false,"patterns_allowed":["monalisa/octocat@*","docker/*"]}'Response
Status: 204