Back to GithubList app installations accessible to the user access token
Lists 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.
Input
type: object
properties:
parameters:
type: object
properties:
per_page:
type: integer
default: 30
description: The number of results per page (max 100).
page:
type: integer
default: 1
description: Page number of the results to fetch.
title: Parameters
Output
type: object
properties:
total_count:
type: integer
installations:
type: array
items:
type: object
title: Installation
properties:
id:
description: The ID of the installation.
type: integer
example: 1
account:
type: object
title: Simple User
properties:
name:
type: string
email:
nullable: true
type: string
login:
type: string
example: octocat
id:
type: integer
node_id:
type: string
avatar_url:
type: string
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
description:
description: A short description of the enterprise.
type: string
nullable: true
website_url:
description: The enterprise's website URL.
type: string
nullable: true
format: uri
slug:
description: The slug url identifier for the enterprise.
type: string
example: octo-business
created_at:
type: string
nullable: true
format: date-time
example: '2019-01-26T19:01:12.000Z'
updated_at:
type: string
nullable: true
format: date-time
example: '2019-01-26T19:14:43.000Z'
repository_selection:
description: >-
Describe whether all repositories have been selected or there's a
selection involved
type: string
enum:
- all
- selected
access_tokens_url:
type: string
format: uri
example: https://api.github.com/installations/1/access_tokens
repositories_url:
type: string
format: uri
example: https://api.github.com/installation/repositories
html_url:
type: string
format: uri
example: https://github.com/organizations/github/settings/installations/1
app_id:
type: integer
example: 1
target_id:
description: The ID of the user or organization this token is being scoped to.
type: integer
target_type:
type: string
example: Organization
permissions:
type: object
title: App Permissions
properties:
actions:
type: string
description: >-
The level of permission to grant the access token for GitHub
Actions workflows, workflow runs, and artifacts.
enum:
- read
- write
administration:
type: string
description: >-
The level of permission to grant the access token for repository
creation, deletion, settings, teams, and collaborators creation.
enum:
- read
- write
checks:
type: string
description: >-
The level of permission to grant the access token for checks on
code.
enum:
- read
- write
contents:
type: string
deployments:
type: string
environments:
type: string
description: >-
The level of permission to grant the access token for managing
repository environments.
enum:
- read
- write
issues:
type: string
metadata:
type: string
description: >-
The level of permission to grant the access token to search
repositories, list collaborators, and access repository
metadata.
enum:
- read
- write
packages:
type: string
description: >-
The level of permission to grant the access token for packages
published to GitHub Packages.
enum:
- read
- write
pages:
type: string
description: >-
The level of permission to grant the access token to retrieve
Pages statuses, configuration, and builds, as well as create new
builds.
enum:
- read
- write
pull_requests:
type: string
description: >-
The level of permission to grant the access token for pull
requests and related comments, assignees, labels, milestones,
and merges.
enum:
- read
- write
repository_hooks:
type: string
description: >-
The level of permission to grant the access token to manage the
post-receive hooks for a repository.
enum:
- read
- write
repository_projects:
type: string
description: >-
The level of permission to grant the access token to manage
repository projects, columns, and cards.
enum:
- read
- write
- admin
secret_scanning_alerts:
type: string
description: >-
The level of permission to grant the access token to view and
manage secret scanning alerts.
enum:
- read
- write
secrets:
type: string
description: >-
The level of permission to grant the access token to manage
repository secrets.
enum:
- read
- write
security_events:
type: string
description: >-
The level of permission to grant the access token to view and
manage security events like code scanning alerts.
enum:
- read
- write
single_file:
type: string
statuses:
type: string
description: >-
The level of permission to grant the access token for commit
statuses.
enum:
- read
- write
vulnerability_alerts:
type: string
description: >-
The level of permission to grant the access token to manage
Dependabot alerts.
enum:
- read
- write
workflows:
type: string
description: >-
The level of permission to grant the access token to update
GitHub Actions workflow files.
enum:
- write
members:
type: string
description: >-
The level of permission to grant the access token for
organization teams and members.
enum:
- read
- write
organization_administration:
type: string
description: >-
The level of permission to grant the access token to manage
access to an organization.
enum:
- read
- write
organization_custom_roles:
type: string
description: >-
The level of permission to grant the access token for custom
repository roles management. This property is in beta and is
subject to change.
enum:
- read
- write
organization_announcement_banners:
type: string
description: >-
The level of permission to grant the access token to view and
manage announcement banners for an organization.
enum:
- read
- write
organization_hooks:
type: string
description: >-
The level of permission to grant the access token to manage the
post-receive hooks for an organization.
enum:
- read
- write
organization_personal_access_tokens:
type: string
description: >-
The level of permission to grant the access token for viewing
and managing fine-grained personal access token requests to an
organization.
enum:
- read
- write
organization_personal_access_token_requests:
type: string
description: >-
The level of permission to grant the access token for viewing
and managing fine-grained personal access tokens that have been
approved by an organization.
enum:
- read
- write
organization_plan:
type: string
description: >-
The level of permission to grant the access token for viewing an
organization's plan.
enum:
- read
organization_projects:
type: string
description: >-
The level of permission to grant the access token to manage
organization projects and projects beta (where available).
enum:
- read
- write
- admin
organization_packages:
type: string
description: >-
The level of permission to grant the access token for
organization packages published to GitHub Packages.
enum:
- read
- write
organization_secrets:
type: string
description: >-
The level of permission to grant the access token to manage
organization secrets.
enum:
- read
- write
organization_self_hosted_runners:
type: string
description: >-
The level of permission to grant the access token to view and
manage GitHub Actions self-hosted runners available to an
organization.
enum:
- read
- write
organization_user_blocking:
type: string
description: >-
The level of permission to grant the access token to view and
manage users blocked by the organization.
enum:
- read
- write
team_discussions:
type: string
description: >-
The level of permission to grant the access token to manage team
discussions and related comments.
enum:
- read
- write
events:
type: array
items:
type: string
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
single_file_name:
type: string
example: config.yaml
nullable: true
has_multiple_single_files:
type: boolean
example: true
single_file_paths:
type: array
items:
type: string
app_slug:
type: string
example: github-actions
suspended_by:
type: object
title: Simple User
properties:
name:
nullable: true
type: string
email:
nullable: true
type: string
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
suspended_at:
type: string
format: date-time
nullable: true
contact_email:
type: string
example: '"
[email protected]"'
nullable: true