allowed_actions
Overview
Name | allowed_actions |
Type | Resource |
Id | github.actions.allowed_actions |
Fields
Name | Datatype | Description |
---|---|---|
verified_allowed | boolean | Whether actions in GitHub Marketplace from verified creators are allowed. Set to true to allow all GitHub Marketplace actions by verified creators. |
github_owned_allowed | boolean | Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization. |
patterns_allowed | array | Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@* , monalisa/octocat@v2 , monalisa/* ." |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get_allowed_actions_organization | SELECT | org | 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_repository | SELECT | owner, repo | 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. |
set_allowed_actions_organization | EXEC | org | 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_repository | EXEC | owner, repo | 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. |