apps
Overview
Name | apps |
Type | Resource |
Id | github.apps.apps |
Fields
Name | Datatype | Description |
---|---|---|
id | integer | The ID of the installation. |
access_tokens_url | string | |
account | object | A GitHub user. |
app_id | integer | |
app_slug | string | |
contact_email | string | |
created_at | string | |
events | array | |
has_multiple_single_files | boolean | |
html_url | string | |
permissions | object | The permissions granted to the user access token. |
repositories_url | string | |
repository_selection | string | Describe whether all repositories have been selected or there's a selection involved |
single_file_name | string | |
single_file_paths | array | |
suspended_at | string | |
suspended_by | object | A GitHub user. |
target_id | integer | The ID of the user or organization this token is being scoped to. |
target_type | string | |
updated_at | string |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get_installation | SELECT | installation_id | Enables an authenticated GitHub App to find an installation's information using the installation id. You must use a JWT to access this endpoint. |
get_org_installation | SELECT | org | Enables an authenticated GitHub App to find the organization's installation information. You must use a JWT to access this endpoint. |
get_repo_installation | SELECT | owner, repo | Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. You must use a JWT to access this endpoint. |
get_user_installation | SELECT | username | Enables an authenticated GitHub App to find the user’s installation information. You must use a JWT to access this endpoint. |
list_installations | SELECT | You must use a JWT to access this endpoint. The permissions the installation has are included under the permissions key. | |
create_from_manifest | INSERT | code | Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you receive a temporary code used to retrieve the GitHub App's id , pem (private key), and webhook_secret . |
create_installation_access_token | INSERT | installation_id | Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized , and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids , the response does not contain the repositories key.You must use a JWT to access this endpoint. |
delete_installation | DELETE | installation_id | Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "Suspend an app installation" endpoint. You must use a JWT to access this endpoint. |
scope_token | EXEC | client_id, data__access_token | Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND . |
suspend_installation | EXEC | installation_id | Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. You must use a JWT to access this endpoint. |
unsuspend_installation | EXEC | installation_id | Removes a GitHub App installation suspension. You must use a JWT to access this endpoint. |