app_installations

Creates, updates, deletes, gets or lists an app_installations resource.

Overview

Name	app_installations
Type	Resource
Id	github.orgs.app_installations

Fields

The following fields are returned by SELECT queries:

list_app_installations

Response

Name	Datatype	Description
id	integer	The ID of the installation.
app_id	integer
client_id	string	(example: Iv1.ab1112223334445c)
target_id	integer	The ID of the user or organization this token is being scoped to.
single_file_name	string	(example: config.yaml)
access_tokens_url	string (uri)	(example: https://api.github.com/app/installations/1/access_tokens)
account	object	A GitHub user. (title: Simple User)
app_slug	string	(example: github-actions)
contact_email	string	(example: "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com")
created_at	string (date-time)
events	array
has_multiple_single_files	boolean
html_url	string (uri)	(example: https://github.com/organizations/github/settings/installations/1)
permissions	object	The permissions granted to the user access token. (title: App Permissions)
repositories_url	string (uri)	(example: https://api.github.com/installation/repositories)
repository_selection	string	Describe whether all repositories have been selected or there's a selection involved (all, selected)
single_file_paths	array
suspended_at	string (date-time)
suspended_by	object	A GitHub user. (title: Simple User)
target_type	string	(example: Organization)
updated_at	string (date-time)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_app_installations	select	org	per_page, page	Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. The authenticated user must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens (classic) need the admin:read scope 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.
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_app_installations

Lists all GitHub Apps in an organization. The installation count includes
all GitHub Apps installed on repositories in the organization.

The authenticated user must be an organization owner to use this endpoint.

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

SELECT
id,
app_id,
client_id,
target_id,
single_file_name,
access_tokens_url,
account,
app_slug,
contact_email,
created_at,
events,
has_multiple_single_files,
html_url,
permissions,
repositories_url,
repository_selection,
single_file_paths,
suspended_at,
suspended_by,
target_type,
updated_at
FROM github.orgs.app_installations
WHERE org = '{{ org }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;