Skip to main content
이제 REST API의 버전이 지정됩니다. 자세한 내용은 "API 버전 관리 정보"를 참조하세요.

GitHub Actions 사용 권한

Use the REST API to interact with permissions for GitHub Actions.

About permissions for GitHub Actions

You can use the REST API to set permissions for the enterprises, organizations and repositories that are allowed to run GitHub Actions, and the actions and reusable workflows that are allowed to run. For more information, see "Usage limits, billing, and administration."

Get GitHub Actions permissions for an enterprise

Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows 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"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
enterprise string 필수

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

"Get GitHub Actions permissions for an enterprise"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"Get GitHub Actions permissions for an enterprise"에 대한 코드 샘플

get/enterprises/{enterprise}/actions/permissions
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/enterprises/ENTERPRISE/actions/permissions

Response

Status: 200
{ "enabled_organizations": "all", "allowed_actions": "selected", "selected_actions_url": "https://api.github.com/enterprises/2/actions/permissions/selected-actions" }

Set GitHub Actions permissions for an enterprise

Sets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows 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"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
enterprise string 필수

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

본문 매개 변수
입력, Type, 설명
enabled_organizations string 필수

The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.

다음 중 하나일 수 있습니다.: all, none, selected

allowed_actions string

The permissions policy that controls the actions and reusable workflows that are allowed to run.

다음 중 하나일 수 있습니다.: all, local_only, selected

"Set GitHub Actions permissions for an enterprise"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

"Set GitHub Actions permissions for an enterprise"에 대한 코드 샘플

put/enterprises/{enterprise}/actions/permissions
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/permissions \ -d '{"enabled_organizations":"all","allowed_actions":"selected"}'

Response

Status: 204

List 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"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
enterprise string 필수

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

쿼리 매개 변수
입력, Type, 설명
per_page integer

The number of results per page (max 100).

기본값: 30

page integer

Page number of the results to fetch.

기본값: 1

"List selected organizations enabled for GitHub Actions in an enterprise"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"List selected organizations enabled for GitHub Actions in an enterprise"에 대한 코드 샘플

get/enterprises/{enterprise}/actions/permissions/organizations
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/enterprises/ENTERPRISE/actions/permissions/organizations

Response

Status: 200
{ "total_count": 1, "organizations": [ { "login": "octocat", "id": 161335, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "url": "https://api.github.com/orgs/octo-org", "repos_url": "https://api.github.com/orgs/octo-org/repos", "events_url": "https://api.github.com/orgs/octo-org/events", "hooks_url": "https://api.github.com/orgs/octo-org/hooks", "issues_url": "https://api.github.com/orgs/octo-org/issues", "members_url": "https://api.github.com/orgs/octo-org/members{/member}", "public_members_url": "https://api.github.com/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"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
enterprise string 필수

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

본문 매개 변수
입력, Type, 설명
selected_organization_ids array of integers 필수

List of organization IDs to enable for GitHub Actions.

"Set selected organizations enabled for GitHub Actions in an enterprise"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

"Set selected organizations enabled for GitHub Actions in an enterprise"에 대한 코드 샘플

put/enterprises/{enterprise}/actions/permissions/organizations
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/permissions/organizations \ -d '{"selected_organization_ids":[32,91]}'

Response

Status: 204

Enable 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"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
enterprise string 필수

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

org_id integer 필수

The unique identifier of the organization.

"Enable a selected organization for GitHub Actions in an enterprise"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

"Enable a selected organization for GitHub Actions in an enterprise"에 대한 코드 샘플

put/enterprises/{enterprise}/actions/permissions/organizations/{org_id}
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/permissions/organizations/ORG_ID

Response

Status: 204

Disable 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"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
enterprise string 필수

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

org_id integer 필수

The unique identifier of the organization.

"Disable a selected organization for GitHub Actions in an enterprise"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

"Disable a selected organization for GitHub Actions in an enterprise"에 대한 코드 샘플

delete/enterprises/{enterprise}/actions/permissions/organizations/{org_id}
curl -L \ -X DELETE \ -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/permissions/organizations/ORG_ID

Response

Status: 204

Get allowed actions and reusable workflows for an enterprise

Gets the selected actions and reusable workflows 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 and reusable workflows for an enterprise"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
enterprise string 필수

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

"Get allowed actions and reusable workflows for an enterprise"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"Get allowed actions and reusable workflows for an enterprise"에 대한 코드 샘플

get/enterprises/{enterprise}/actions/permissions/selected-actions
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/enterprises/ENTERPRISE/actions/permissions/selected-actions

Response

Status: 200
{ "github_owned_allowed": true, "verified_allowed": false, "patterns_allowed": [ "monalisa/octocat@*", "docker/*" ] }

Set allowed actions and reusable workflows for an enterprise

Sets the actions and reusable workflows 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 and reusable workflows for an enterprise"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
enterprise string 필수

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

본문 매개 변수
입력, Type, 설명
github_owned_allowed boolean

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

verified_allowed boolean

Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

patterns_allowed array of strings

Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.

"Set allowed actions and reusable workflows for an enterprise"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

"Set allowed actions and reusable workflows for an enterprise"에 대한 코드 샘플

put/enterprises/{enterprise}/actions/permissions/selected-actions
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/permissions/selected-actions \ -d '{"github_owned_allowed":true,"verified_allowed":false,"patterns_allowed":["monalisa/octocat@*","docker/*"]}'

Response

Status: 204

Get default workflow permissions for an enterprise

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, as well as whether GitHub Actions can submit approving pull request reviews. For more information, see "Enforcing a policy for workflow permissions in your enterprise."

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

"Get default workflow permissions for an enterprise"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
enterprise string 필수

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

"Get default workflow permissions for an enterprise"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

Success response

"Get default workflow permissions for an enterprise"에 대한 코드 샘플

get/enterprises/{enterprise}/actions/permissions/workflow
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/enterprises/ENTERPRISE/actions/permissions/workflow

Give read-only permission, and allow approving PRs.

Status: 200
{ "default_workflow_permissions": "read", "can_approve_pull_request_reviews": true }

Set default workflow permissions for an enterprise

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets whether GitHub Actions can submit approving pull request reviews. For more information, see "Enforcing a policy for workflow permissions in your enterprise."

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

"Set default workflow permissions for an enterprise"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
enterprise string 필수

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

본문 매개 변수
입력, Type, 설명
default_workflow_permissions string

The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

다음 중 하나일 수 있습니다.: read, write

can_approve_pull_request_reviews boolean

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

"Set default workflow permissions for an enterprise"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

Success response

"Set default workflow permissions for an enterprise"에 대한 코드 샘플

put/enterprises/{enterprise}/actions/permissions/workflow
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/permissions/workflow \ -d '{"default_workflow_permissions":"read","can_approve_pull_request_reviews":true}'

Success response

Status: 204

Get GitHub Actions permissions for an organization

Works with GitHub Apps

Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows 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"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
org string 필수

The organization name. The name is not case sensitive.

"Get GitHub Actions permissions for an organization"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"Get GitHub Actions permissions for an organization"에 대한 코드 샘플

get/orgs/{org}/actions/permissions
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/permissions

Response

Status: 200
{ "enabled_repositories": "all", "allowed_actions": "selected", "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" }

Set GitHub Actions permissions for an organization

Works with GitHub Apps

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"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
org string 필수

The organization name. The name is not case sensitive.

본문 매개 변수
입력, Type, 설명
enabled_repositories string 필수

The policy that controls the repositories in the organization that are allowed to run GitHub Actions.

다음 중 하나일 수 있습니다.: all, none, selected

allowed_actions string

The permissions policy that controls the actions and reusable workflows that are allowed to run.

다음 중 하나일 수 있습니다.: all, local_only, selected

"Set GitHub Actions permissions for an organization"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

"Set GitHub Actions permissions for an organization"에 대한 코드 샘플

put/orgs/{org}/actions/permissions
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/permissions \ -d '{"enabled_repositories":"all","allowed_actions":"selected"}'

Response

Status: 204

List selected repositories enabled for GitHub Actions in an organization

Works with GitHub Apps

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"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
org string 필수

The organization name. The name is not case sensitive.

쿼리 매개 변수
입력, Type, 설명
per_page integer

The number of results per page (max 100).

기본값: 30

page integer

Page number of the results to fetch.

기본값: 1

"List selected repositories enabled for GitHub Actions in an organization"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"List selected repositories enabled for GitHub Actions in an organization"에 대한 코드 샘플

get/orgs/{org}/actions/permissions/repositories
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/permissions/repositories

Response

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://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/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://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/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://api.github.com/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://api.github.com/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

Works with GitHub Apps

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"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
org string 필수

The organization name. The name is not case sensitive.

본문 매개 변수
입력, Type, 설명
selected_repository_ids array of integers 필수

List of repository IDs to enable for GitHub Actions.

"Set selected repositories enabled for GitHub Actions in an organization"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

"Set selected repositories enabled for GitHub Actions in an organization"에 대한 코드 샘플

put/orgs/{org}/actions/permissions/repositories
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/permissions/repositories \ -d '{"selected_repository_ids":[32,42]}'

Response

Status: 204

Enable a selected repository for GitHub Actions in an organization

Works with GitHub Apps

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"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
org string 필수

The organization name. The name is not case sensitive.

repository_id integer 필수

The unique identifier of the repository.

"Enable a selected repository for GitHub Actions in an organization"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

"Enable a selected repository for GitHub Actions in an organization"에 대한 코드 샘플

put/orgs/{org}/actions/permissions/repositories/{repository_id}
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/permissions/repositories/REPOSITORY_ID

Response

Status: 204

Disable a selected repository for GitHub Actions in an organization

Works with GitHub Apps

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"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
org string 필수

The organization name. The name is not case sensitive.

repository_id integer 필수

The unique identifier of the repository.

"Disable a selected repository for GitHub Actions in an organization"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

"Disable a selected repository for GitHub Actions in an organization"에 대한 코드 샘플

delete/orgs/{org}/actions/permissions/repositories/{repository_id}
curl -L \ -X DELETE \ -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/permissions/repositories/REPOSITORY_ID

Response

Status: 204

Get allowed actions and reusable workflows for an organization

Works with GitHub Apps

Gets the selected actions and reusable workflows 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 and reusable workflows for an organization"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
org string 필수

The organization name. The name is not case sensitive.

"Get allowed actions and reusable workflows for an organization"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"Get allowed actions and reusable workflows for an organization"에 대한 코드 샘플

get/orgs/{org}/actions/permissions/selected-actions
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/permissions/selected-actions

Response

Status: 200
{ "github_owned_allowed": true, "verified_allowed": false, "patterns_allowed": [ "monalisa/octocat@*", "docker/*" ] }

Set allowed actions for an organization

Works with GitHub Apps

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"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
org string 필수

The organization name. The name is not case sensitive.

본문 매개 변수
입력, Type, 설명
github_owned_allowed boolean

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

verified_allowed boolean

Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

patterns_allowed array of strings

Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.

"Set allowed actions for an organization"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

"Set allowed actions for an organization"에 대한 코드 샘플

put/orgs/{org}/actions/permissions/selected-actions
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/permissions/selected-actions \ -d '{"github_owned_allowed":true,"verified_allowed":false,"patterns_allowed":["monalisa/octocat@*","docker/*"]}'

Response

Status: 204

Get default workflow permissions for an organization

Works with GitHub Apps

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, as well as whether GitHub Actions can submit approving pull request reviews. For more information, see "Setting the permissions of the GITHUB_TOKEN for your 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 default workflow permissions for an organization"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
org string 필수

The organization name. The name is not case sensitive.

"Get default workflow permissions for an organization"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"Get default workflow permissions for an organization"에 대한 코드 샘플

get/orgs/{org}/actions/permissions/workflow
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/permissions/workflow

Give read-only permission, and allow approving PRs.

Status: 200
{ "default_workflow_permissions": "read", "can_approve_pull_request_reviews": true }

Set default workflow permissions for an organization

Works with GitHub Apps

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, and sets if GitHub Actions can submit approving pull request reviews. For more information, see "Setting the permissions of the GITHUB_TOKEN for your 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 default workflow permissions for an organization"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
org string 필수

The organization name. The name is not case sensitive.

본문 매개 변수
입력, Type, 설명
default_workflow_permissions string

The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

다음 중 하나일 수 있습니다.: read, write

can_approve_pull_request_reviews boolean

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

"Set default workflow permissions for an organization"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

Success response

409

Conflict response when changing a setting is prevented by the owning enterprise

"Set default workflow permissions for an organization"에 대한 코드 샘플

put/orgs/{org}/actions/permissions/workflow
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/permissions/workflow \ -d '{"default_workflow_permissions":"read","can_approve_pull_request_reviews":true}'

Success response

Status: 204

Get GitHub Actions permissions for a repository

Works with GitHub Apps

Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows 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"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
owner string 필수

The account owner of the repository. The name is not case sensitive.

repo string 필수

The name of the repository without the .git extension. The name is not case sensitive.

"Get GitHub Actions permissions for a repository"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"Get GitHub Actions permissions for a repository"에 대한 코드 샘플

get/repos/{owner}/{repo}/actions/permissions
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/permissions

Response

Status: 200
{ "enabled": true, "allowed_actions": "selected", "selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions" }

Set GitHub Actions permissions for a repository

Works with GitHub Apps

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"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
owner string 필수

The account owner of the repository. The name is not case sensitive.

repo string 필수

The name of the repository without the .git extension. The name is not case sensitive.

본문 매개 변수
입력, Type, 설명
enabled boolean 필수

Whether GitHub Actions is enabled on the repository.

allowed_actions string

The permissions policy that controls the actions and reusable workflows that are allowed to run.

다음 중 하나일 수 있습니다.: all, local_only, selected

"Set GitHub Actions permissions for a repository"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

"Set GitHub Actions permissions for a repository"에 대한 코드 샘플

put/repos/{owner}/{repo}/actions/permissions
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/permissions \ -d '{"enabled":true,"allowed_actions":"selected"}'

Response

Status: 204

Get the level of access for workflows outside of the repository

Works with GitHub Apps

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to internal and private repositories. For more information, see "Allowing access to components in a private repository" and "Allowing access to components in an internal repository."

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the repository administration permission to use this endpoint.

"Get the level of access for workflows outside of the repository"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
owner string 필수

The account owner of the repository. The name is not case sensitive.

repo string 필수

The name of the repository without the .git extension. The name is not case sensitive.

"Get the level of access for workflows outside of the repository"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"Get the level of access for workflows outside of the repository"에 대한 코드 샘플

get/repos/{owner}/{repo}/actions/permissions/access
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/permissions/access

Response

Status: 200
{ "access_level": "organization" }

Set the level of access for workflows outside of the repository

Works with GitHub Apps

Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to internal and private repositories. For more information, see "Allowing access to components in a private repository" and "Allowing access to components in an internal repository."

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the repository administration permission to use this endpoint.

"Set the level of access for workflows outside of the repository"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
owner string 필수

The account owner of the repository. The name is not case sensitive.

repo string 필수

The name of the repository without the .git extension. The name is not case sensitive.

본문 매개 변수
입력, Type, 설명
access_level string 필수

Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the repository.

none means the access is only possible from workflows in this repository. user level access allows sharing across user owned private repos only. organization level access allows sharing across the organization. enterprise level access allows sharing across the enterprise.

다음 중 하나일 수 있습니다.: none, user, organization, enterprise

"Set the level of access for workflows outside of the repository"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

"Set the level of access for workflows outside of the repository"에 대한 코드 샘플

put/repos/{owner}/{repo}/actions/permissions/access
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/permissions/access \ -d '{"access_level":"organization"}'

Response

Status: 204

Get allowed actions and reusable workflows for a repository

Works with GitHub Apps

Gets the settings for selected actions and reusable workflows 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 and reusable workflows for a repository"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
owner string 필수

The account owner of the repository. The name is not case sensitive.

repo string 필수

The name of the repository without the .git extension. The name is not case sensitive.

"Get allowed actions and reusable workflows for a repository"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"Get allowed actions and reusable workflows for a repository"에 대한 코드 샘플

get/repos/{owner}/{repo}/actions/permissions/selected-actions
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/permissions/selected-actions

Response

Status: 200
{ "github_owned_allowed": true, "verified_allowed": false, "patterns_allowed": [ "monalisa/octocat@*", "docker/*" ] }

Set allowed actions for a repository

Works with GitHub Apps

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 and reusable workflows 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"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
owner string 필수

The account owner of the repository. The name is not case sensitive.

repo string 필수

The name of the repository without the .git extension. The name is not case sensitive.

본문 매개 변수
입력, Type, 설명
github_owned_allowed boolean

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

verified_allowed boolean

Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

patterns_allowed array of strings

Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.

"Set allowed actions for a repository"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

"Set allowed actions for a repository"에 대한 코드 샘플

put/repos/{owner}/{repo}/actions/permissions/selected-actions
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/permissions/selected-actions \ -d '{"github_owned_allowed":true,"verified_allowed":false,"patterns_allowed":["monalisa/octocat@*","docker/*"]}'

Response

Status: 204

Get default workflow permissions for a repository

Works with GitHub Apps

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, as well as if GitHub Actions can submit approving pull request reviews. For more information, see "Setting the permissions of the GITHUB_TOKEN for your repository."

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the repository administration permission to use this API.

"Get default workflow permissions for a repository"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
owner string 필수

The account owner of the repository. The name is not case sensitive.

repo string 필수

The name of the repository without the .git extension. The name is not case sensitive.

"Get default workflow permissions for a repository"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"Get default workflow permissions for a repository"에 대한 코드 샘플

get/repos/{owner}/{repo}/actions/permissions/workflow
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/permissions/workflow

Give read-only permission, and allow approving PRs.

Status: 200
{ "default_workflow_permissions": "read", "can_approve_pull_request_reviews": true }

Set default workflow permissions for a repository

Works with GitHub Apps

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions can submit approving pull request reviews. For more information, see "Setting the permissions of the GITHUB_TOKEN for your repository."

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the repository administration permission to use this API.

"Set default workflow permissions for a repository"에 대한 매개 변수

머리글
입력, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
입력, Type, 설명
owner string 필수

The account owner of the repository. The name is not case sensitive.

repo string 필수

The name of the repository without the .git extension. The name is not case sensitive.

본문 매개 변수
입력, Type, 설명
default_workflow_permissions string

The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

다음 중 하나일 수 있습니다.: read, write

can_approve_pull_request_reviews boolean

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

"Set default workflow permissions for a repository"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

Success response

409

Conflict response when changing a setting is prevented by the owning organization or enterprise

"Set default workflow permissions for a repository"에 대한 코드 샘플

put/repos/{owner}/{repo}/actions/permissions/workflow
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/permissions/workflow \ -d '{"default_workflow_permissions":"read","can_approve_pull_request_reviews":true}'

Success response

Status: 204