actions

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

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

get/enterprises/{enterprise}/actions/permissions/workflow

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/enterprises/{enterprise}/actions/permissions/workflow
  • Auth: none declared

Path parameters

enterprisestring required

The slug version of the enterprise name.

Response

Success response

default_workflow_permissions'read' | 'write' required

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

can_approve_pull_request_reviewsboolean required

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

Changes

No recorded changes to this operation across all 83 revisions of this API.