installations
Creates, updates, deletes, gets or lists an installations resource.
Overview
| Name | installations |
| Type | Resource |
| Id | github.apps.installations |
Fields
The following fields are returned by SELECT queries:
- list_installations_for_authenticated_user
You can find the permissions for the installation under the permissions key.
| Name | Datatype | Description |
|---|---|---|
installations | array | |
total_count | integer |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_installations_for_authenticated_user | select | per_page, page | Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. You can find the permissions for the installation under the permissions key. | |
revoke_installation_access_token | delete | Revokes the installation token you're using to authenticate as an installation and access this endpoint. Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "Create an installation access token for an app" 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 |
|---|---|---|
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_installations_for_authenticated_user
Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.
The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
You can find the permissions for the installation under the permissions key.
SELECT
installations,
total_count
FROM github.apps.installations
WHERE per_page = '{{ per_page }}'
AND page = '{{ page }}'
;
DELETE examples
- revoke_installation_access_token
Revokes the installation token you're using to authenticate as an installation and access this endpoint.
Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "Create an installation access token for an app" endpoint.
DELETE FROM github.apps.installations
;