How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitHub Access API

The Access API from GitHub — 12 operation(s) for access.

GitHub Access API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Access. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 25 operations across 12 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against 2 base URLs: {protocol}://{hostname}/api/v3, {protocol}://{hostname}.

25 operations 12 paths 26 schemas 6 DELETE8 GET5 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://api.github.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

GitHub Access API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 25

Across 12 paths, the API surfaces 25 operations — 6 DELETE, 8 GET, 5 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Access 25
POST
/app/installations/{installation_id}/access_tokens
GitHub Create an Installation Access Token for an App
createAnInstallationAccessTokenForAnApp 1 param body → 201401403404422
POST
/applications/{client_id}/token/scoped
GitHub Createscoped Access Token
createscopedAccessToken 1 param body → 200401403404422
GET
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps
GitHub Get Apps with Access to the Protected Branch
getAppsWithAccessToTheProtectedBranch 3 params → 200404
POST
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps
GitHub Add App Access Restrictions
addAppAccessRestrictions 3 params body → 200422
PUT
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps
GitHub Set App Access Restrictions
setAppAccessRestrictions 3 params body → 200422
DELETE
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps
GitHub Remove App Access Restrictions
removeAppAccessRestrictions 3 params body → 200422
DELETE
/installation/token
GitHub Revoke an Installation Access Token
revokeAnInstallationAccessToken → 204
GET
/user/installations
GitHub List App Installations Accessible to the User Access Token
listAppInstallationsAccessibleToTheUserAccessToken 2 params → 200304401403
GET
/user/installations/{installation_id}/repositories
GitHub List Repositories Accessible to the User Access Token
listRepositoriesAccessibleToTheUserAccessToken 3 params → 200304403404
GET
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories
GitHub List Repository Access to Self-hosted Runner Group in an Organization
listRepositoryAccessToSelfhostedRunnerGroupInAnOrganization 4 params → 200
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories
GitHub Set Repository Access for Self-hosted Runner Group in an Organization
setRepositoryAccessForSelfhostedRunnerGroupInAnOrganization 2 params body → 204
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}
GitHub Add Repository Access to Self-hosted Runner Group in an Organization
addRepositoryAccessToSelfhostedRunnerGroupInAnOrganization 3 params → 204
DELETE
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}
GitHub Remove Repository Access to Self-hosted Runner Group in an Organization
removeRepositoryAccessToSelfhostedRunnerGroupInAnOrganization 3 params → 204
GET
/repos/{owner}/{repo}/actions/permissions/access
GitHub Get the Level of Access for Workflows Outside of the Repository
getTheLevelOfAccessForWorkflowsOutsideOfTheRepository 5 params → 200
PUT
/repos/{owner}/{repo}/actions/permissions/access
GitHub Set the Level of Access for Workflows Outside of the Repository
setTheLevelOfAccessForWorkflowsOutsideOfTheRepository 5 params body → 204
GET
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions
GitHub Get Access Restrictions
getAccessRestrictions 6 params → 200404
DELETE
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions
GitHub Delete Access Restrictions
deleteAccessRestrictions 6 params → 204
GET
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams
GitHub Get Teams with Access to the Protected Branch
getTeamsWithAccessToTheProtectedBranch 6 params → 200404
POST
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams
GitHub Add Team Access Restrictions
addTeamAccessRestrictions 6 params body → 200422
PUT
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams
GitHub Set Team Access Restrictions
setTeamAccessRestrictions 6 params body → 200422
DELETE
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams
GitHub Remove Team Access Restrictions
removeTeamAccessRestrictions 6 params body → 200422
GET
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users
GitHub Get Users with Access to the Protected Branch
getUsersWithAccessToTheProtectedBranch 6 params → 200404
POST
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users
GitHub Add User Access Restrictions
addUserAccessRestrictions 6 params body → 200422
PUT
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users
GitHub Set User Access Restrictions
setUserAccessRestrictions 6 params body → 200422
DELETE
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users
GitHub Remove User Access Restrictions
removeUserAccessRestrictions 6 params body → 200422

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are repository (95 properties), minimal-repository (87 properties), app-permissions (45 properties), simple-user (21 properties). Each schema is shown below with its type and property counts.

installation-token
object
Authentication token for a GitHub App installed on a user or org.
8 properties 2 required
simple-user
object
A GitHub user.
21 properties 18 required
repository
object
A repository on GitHub.
95 properties 73 required
validation-error
object
Validation Error
3 properties 2 required
basic-error
object
Basic Error
4 properties
nullable-scoped-installation
objectnull
7 properties 5 required
integration
object
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties 11 required
app-permissions
object
The permissions granted to the user access token.
45 properties
authorization
object
The authorization for an OAuth app, GitHub App, or a Personal Access Token.
15 properties 13 required
nullable-simple-user
objectnull
A GitHub user.
21 properties 18 required
nullable-license-simple
objectnull
License Simple
6 properties 5 required
installation
object
Installation
20 properties 17 required
enterprise
object
An enterprise on GitHub.
10 properties 8 required
code-of-conduct
object
Code Of Conduct
5 properties 4 required
minimal-repository
object
Minimal Repository
87 properties 46 required
security-and-analysis
objectnull
3 properties
actions-workflow-access-to-repository
object
1 property 1 required
integration_2
object
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties 11 required
simple-user_2
object
GitHub user.
21 properties 18 required
nullable-simple-user_2
object
GitHub user.
21 properties 18 required
validation-error_2
object
Validation Error
3 properties 2 required
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required
branch-restriction-policy
object
Branch Restriction Policy
7 properties 7 required
nullable-team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
team_2
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required
nullable-team-simple_2
objectnull
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-access-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
Where this information came from

This is an independent, third-party profile of GitHub Access API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.