org_self_hosted_runners_permissions
Creates, updates, deletes, gets or lists an org_self_hosted_runners_permissions resource.
Overview
| Name | org_self_hosted_runners_permissions |
| Type | Resource |
| Id | github.actions.org_self_hosted_runners_permissions |
Fields
The following fields are returned by SELECT queries:
- get_self_hosted_runners_permissions_organization
Response
| Name | Datatype | Description |
|---|---|---|
enabled_repositories | string | The policy that controls whether self-hosted runners can be used by repositories in the organization (all, selected, none) |
selected_repositories_url | string | The URL to the endpoint for managing selected repositories for self-hosted runners in the organization |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_self_hosted_runners_permissions_organization | select | org | Gets the settings for self-hosted runners for an organization. OAuth app tokens and personal access tokens (classic) need the admin:org scope or the "Actions policies" fine-grained permission to use this endpoint. | |
set_self_hosted_runners_permissions_organization | replace | org, enabled_repositories | Sets the settings for self-hosted runners for an organization. OAuth app tokens and personal access tokens (classic) need the admin:org scope or the "Actions policies" fine-grained permission to use this endpoint. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
org | string | The organization name. The name is not case sensitive. |
SELECT examples
- get_self_hosted_runners_permissions_organization
Gets the settings for self-hosted runners for an organization.
OAuth app tokens and personal access tokens (classic) need the admin:org scope or the "Actions policies" fine-grained permission to use this endpoint.
SELECT
enabled_repositories,
selected_repositories_url
FROM github.actions.org_self_hosted_runners_permissions
WHERE org = '{{ org }}' -- required
;
REPLACE examples
- set_self_hosted_runners_permissions_organization
Sets the settings for self-hosted runners for an organization.
OAuth app tokens and personal access tokens (classic) need the admin:org scope or the "Actions policies" fine-grained permission to use this endpoint.
REPLACE github.actions.org_self_hosted_runners_permissions
SET
enabled_repositories = '{{ enabled_repositories }}'
WHERE
org = '{{ org }}' --required
AND enabled_repositories = '{{ enabled_repositories }}' --required;