Skip to main content

default_workflow_permissions

Overview

Namedefault_workflow_permissions
TypeResource
Idgithub.actions.default_workflow_permissions

Fields

NameDatatypeDescription
can_approve_pull_request_reviewsbooleanWhether GitHub Actions can approve pull requests. Enabling this can be a security risk.
default_workflow_permissionsstringThe default workflow permissions granted to the GITHUB_TOKEN when running workflows.

Methods

NameAccessible byRequired ParamsDescription
get_github_actions_default_workflow_permissions_organizationSELECTorgGets 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_github_actions_default_workflow_permissions_repositorySELECTowner, repoGets 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.
set_github_actions_default_workflow_permissions_organizationEXECorgSets 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_github_actions_default_workflow_permissions_repositoryEXECowner, repoSets 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.