repos_for_org_variable

Creates, updates, deletes, gets or lists a repos_for_org_variable resource.

Overview

Name	repos_for_org_variable
Type	Resource
Id	github.actions.repos_for_org_variable

Fields

The following fields are returned by SELECT queries:

list_selected_repos_for_org_variable

Response

Name	Datatype	Description
id	integer (int64)
name	string	(example: Hello-World)
node_id	string	(example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
full_name	string	(example: octocat/Hello-World)
role_name	string	(example: admin)
allow_forking	boolean
archive_url	string	(example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
archived	boolean
assignees_url	string	(example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
blobs_url	string	(example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
branches_url	string	(example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
clone_url	string
code_of_conduct	object	Code Of Conduct (title: Code Of Conduct)
collaborators_url	string	(example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
comments_url	string	(example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
commits_url	string	(example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
compare_url	string	(example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
contents_url	string	(example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
contributors_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/contributors)
created_at	string (date-time)	(example: 2011-01-26T19:01:12Z)
custom_properties	object	The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
default_branch	string
delete_branch_on_merge	boolean
deployments_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/deployments)
description	string	(example: This your first repo!)
disabled	boolean
downloads_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/downloads)
events_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/events)
fork	boolean
forks	integer
forks_count	integer
forks_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/forks)
git_commits_url	string	(example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
git_refs_url	string	(example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
git_tags_url	string	(example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
git_url	string
has_discussions	boolean
has_downloads	boolean
has_issues	boolean
has_pages	boolean
has_projects	boolean
has_pull_requests	boolean
has_wiki	boolean
homepage	string
hooks_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/hooks)
html_url	string (uri)	(example: https://github.com/octocat/Hello-World)
is_template	boolean
issue_comment_url	string	(example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
issue_events_url	string	(example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
issues_url	string	(example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
keys_url	string	(example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
labels_url	string	(example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
language	string
languages_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/languages)
license	object
merges_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/merges)
milestones_url	string	(example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
mirror_url	string
network_count	integer
notifications_url	string	(example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
open_issues	integer
open_issues_count	integer
owner	object	A GitHub user. (title: Simple User)
permissions	object
private	boolean
pull_request_creation_policy	string	The policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only)
pulls_url	string	(example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
pushed_at	string (date-time)	(example: 2011-01-26T19:06:43Z)
releases_url	string	(example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
security_and_analysis	object
size	integer	The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
ssh_url	string
stargazers_count	integer
stargazers_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/stargazers)
statuses_url	string	(example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
subscribers_count	integer
subscribers_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/subscribers)
subscription_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/subscription)
svn_url	string
tags_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/tags)
teams_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/teams)
temp_clone_token	string
topics	array
trees_url	string	(example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
updated_at	string (date-time)	(example: 2011-01-26T19:14:43Z)
url	string (uri)	(example: https://api.github.com/repos/octocat/Hello-World)
visibility	string
watchers	integer
watchers_count	integer
web_commit_signoff_required	boolean

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_selected_repos_for_org_variable	select	org, name	page, per_page	Lists all repositories that can access an organization variable that is available to selected repositories. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
add_selected_repo_to_org_variable	insert	org, name, repository_id		Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
set_selected_repos_for_org_variable	replace	org, name, selected_repository_ids		Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
remove_selected_repo_from_org_variable	delete	org, name, repository_id		Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

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
name	string	The name of the variable.
org	string	The organization name. The name is not case sensitive.
repository_id	integer
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

SELECT examples

list_selected_repos_for_org_variable

Lists all repositories that can access an organization variable
that is available to selected repositories.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

SELECT
id,
name,
node_id,
full_name,
role_name,
allow_forking,
archive_url,
archived,
assignees_url,
blobs_url,
branches_url,
clone_url,
code_of_conduct,
collaborators_url,
comments_url,
commits_url,
compare_url,
contents_url,
contributors_url,
created_at,
custom_properties,
default_branch,
delete_branch_on_merge,
deployments_url,
description,
disabled,
downloads_url,
events_url,
fork,
forks,
forks_count,
forks_url,
git_commits_url,
git_refs_url,
git_tags_url,
git_url,
has_discussions,
has_downloads,
has_issues,
has_pages,
has_projects,
has_pull_requests,
has_wiki,
homepage,
hooks_url,
html_url,
is_template,
issue_comment_url,
issue_events_url,
issues_url,
keys_url,
labels_url,
language,
languages_url,
license,
merges_url,
milestones_url,
mirror_url,
network_count,
notifications_url,
open_issues,
open_issues_count,
owner,
permissions,
private,
pull_request_creation_policy,
pulls_url,
pushed_at,
releases_url,
security_and_analysis,
size,
ssh_url,
stargazers_count,
stargazers_url,
statuses_url,
subscribers_count,
subscribers_url,
subscription_url,
svn_url,
tags_url,
teams_url,
temp_clone_token,
topics,
trees_url,
updated_at,
url,
visibility,
watchers,
watchers_count,
web_commit_signoff_required
FROM github.actions.repos_for_org_variable
WHERE org = '{{ org }}' -- required
AND name = '{{ name }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

INSERT examples

add_selected_repo_to_org_variable

Adds a repository to an organization variable that is available to selected repositories.
Organization variables that are available to selected repositories have their visibility field set to selected.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

INSERT INTO github.actions.repos_for_org_variable (
org,
name,
repository_id
)
SELECT 
'{{ org }}',
'{{ name }}',
'{{ repository_id }}'
;

Manifest

# Description fields are for documentation purposes
- name: repos_for_org_variable
props:
  - name: org
    value: "{{ org }}"
    description: Required parameter for the repos_for_org_variable resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the repos_for_org_variable resource.
  - name: repository_id
    value: {{ repository_id }}
    description: Required parameter for the repos_for_org_variable resource.

REPLACE examples

set_selected_repos_for_org_variable

Replaces all repositories for an organization variable that is available
to selected repositories. Organization variables that are available to selected
repositories have their visibility field set to selected.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

REPLACE github.actions.repos_for_org_variable
SET 
selected_repository_ids = '{{ selected_repository_ids }}'
WHERE 
org = '{{ org }}' --required
AND name = '{{ name }}' --required
AND selected_repository_ids = '{{ selected_repository_ids }}' --required;

DELETE examples

remove_selected_repo_from_org_variable

Removes a repository from an organization variable that is
available to selected repositories. Organization variables that are available to
selected repositories have their visibility field set to selected.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

DELETE FROM github.actions.repos_for_org_variable
WHERE org = '{{ org }}' --required
AND name = '{{ name }}' --required
AND repository_id = '{{ repository_id }}' --required
;