Get default workflow permissions for an organization

GET

/orgs/{org}/actions/permissions/workflow

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.”

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

Responses

200

Response

Media typeapplication/json

object

default_workflow_permissions

required

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

string

Allowed values: read write

can_approve_pull_request_reviews

required

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

boolean

Examples

Exampledefault

Give read-only permission, and allow approving PRs.

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