Skip to main content

user_installations

Overview

Nameuser_installations
TypeResource
Idgithub.apps.user_installations

Fields

NameDatatypeDescription
idintegerThe ID of the installation.
html_urlstring
contact_emailstring
repository_selectionstringDescribe whether all repositories have been selected or there's a selection involved
single_file_pathsarray
has_multiple_single_filesboolean
app_slugstring
single_file_namestring
repositories_urlstring
account``
eventsarray
suspended_byobjectSimple User
target_typestring
created_atstring
access_tokens_urlstring
permissionsobjectThe permissions granted to the user-to-server access token.
suspended_atstring
app_idinteger
target_idintegerThe ID of the user or organization this token is being scoped to.
updated_atstring

Methods

NameAccessible byRequired ParamsDescription
get_user_installationSELECTusernameEnables an authenticated GitHub App to find the user’s installation information.

You must use a JWT to access this endpoint.
list_installations_for_authenticated_userSELECTLists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

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.