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 Enterprise API

The Enterprise API from GitHub — 8 operation(s) for enterprise.

GitHub Enterprise 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 Enterprise. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 20 operations across 8 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}.

20 operations 8 paths 26 schemas 3 DELETE8 GET2 PATCH4 POST3 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 Enterprise API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 20

Across 8 paths, the API surfaces 20 operations — 3 DELETE, 8 GET, 2 PATCH, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Enterprise 20
GET
/meta
GitHub Get Github Enterprise Server Meta Information
getGithubEnterpriseServerMetaInformation → 200304
GET
/repos/{owner}/{repo}/pages
GitHub Get Github Enterprise Server Pages Site
getGithubEnterpriseServerPagesSite 5 params → 200404
POST
/repos/{owner}/{repo}/pages
GitHub Create Github Enterprise Server Pages Site
createGithubEnterpriseServerPagesSite 5 params body → 201409422
PUT
/repos/{owner}/{repo}/pages
GitHub Update Information About Github Enterprise Server Pages Site
updateInformationAboutGithubEnterpriseServerPagesSite 5 params body → 204400409422
DELETE
/repos/{owner}/{repo}/pages
GitHub Delete Github Enterprise Server Pages Site
deleteGithubEnterpriseServerPagesSite 5 params → 204404409422
GET
/repos/{owner}/{repo}/pages/builds
GitHub List Github Enterprise Server Pages Builds
listGithubEnterpriseServerPagesBuilds 7 params → 200
POST
/repos/{owner}/{repo}/pages/builds
GitHub Request Github Enterprise Server Pages Build
requestGithubEnterpriseServerPagesBuild 5 params → 201
GET
/repos/{owner}/{repo}/pages/builds/{build_id}
GitHub Get Github Enterprise Server Pages Build
getGithubEnterpriseServerPagesBuild 6 params → 200
GET
/scim/v2/Groups
GitHub List Provisioned Scim Groups for an Enterprise
listProvisionedScimGroupsForAnEnterprise 4 params → 200400401403429500
POST
/scim/v2/Groups
GitHub Provision Scim Enterprise Group
provisionScimEnterpriseGroup body → 201400401403409429500
GET
/scim/v2/Groups/{scim_group_id}
GitHub Get Scim Provisioning Information for an Enterprise Group
getScimProvisioningInformationForAnEnterpriseGroup 2 params → 200400401403404429500
PUT
/scim/v2/Groups/{scim_group_id}
GitHub Set Scim Information for Provisioned Enterprise Group
setScimInformationForProvisionedEnterpriseGroup 1 param body → 200400401403404409429500
PATCH
/scim/v2/Groups/{scim_group_id}
GitHub Update an Attribute for Scim Enterprise Group
updateAnAttributeForScimEnterpriseGroup 1 param body → 200204400401403404409429
DELETE
/scim/v2/Groups/{scim_group_id}
GitHub Delete Scim Group from an Enterprise
deleteScimGroupFromAnEnterprise 1 param → 204400401403404429500
GET
/scim/v2/Users
GitHub List Scim Provisioned Identities for an Enterprise
listScimProvisionedIdentitiesForAnEnterprise 3 params → 200400401403429500
POST
/scim/v2/Users
GitHub Provision Scim Enterprise User
provisionScimEnterpriseUser body → 201400401403409429500
GET
/scim/v2/Users/{scim_user_id}
GitHub Get Scim Provisioning Information for an Enterprise User
getScimProvisioningInformationForAnEnterpriseUser 1 param → 200400401403404429500
PUT
/scim/v2/Users/{scim_user_id}
GitHub Set Scim Information for Provisioned Enterprise User
setScimInformationForProvisionedEnterpriseUser 1 param body → 200400401403404409429500
PATCH
/scim/v2/Users/{scim_user_id}
GitHub Update an Attribute for Scim Enterprise User
updateAnAttributeForScimEnterpriseUser 1 param body → 200400401403404409429500
DELETE
/scim/v2/Users/{scim_user_id}
GitHub Delete Scim User from an Enterprise
deleteScimUserFromAnEnterprise 1 param → 204400401403404429500

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are nullable-simple-user (21 properties), page (12 properties), page-build (8 properties), user (8 properties). Each schema is shown below with its type and property counts.

api-overview
object
Api Overview
5 properties 1 required
scim-error
object
Scim Error
6 properties
pages-source-hash
object
2 properties 2 required
validation-error
object
Validation Error
3 properties 2 required
basic-error
object
Basic Error
4 properties
page
object
The configuration for GitHub Pages for a repository.
12 properties 5 required
pages-https-certificate
object
4 properties 3 required
page-build-status
object
Page Build Status
2 properties 2 required
page-build
object
Page Build
8 properties 8 required
nullable-simple-user
object
GitHub user.
21 properties 18 required
user-emails-response
array
The emails for the user.
user-role
array
The roles assigned to the user.
scim-error_2
object
Scim Error
6 properties
scim-enterprise-user-list
object
5 properties 5 required
user-response
object
8 properties 3 required
scim-enterprise-group-list
object
5 properties 5 required
user-name
object
4 properties 2 required
scim-enterprise-user-response
scim-enterprise-group-response
user-name-response
object
4 properties
patch-schema
object
2 properties 2 required
user
object
8 properties 6 required
group
object
4 properties 4 required
group-response
object
4 properties 1 required
user-emails
array
The emails for the user.
meta
object
The metadata associated with the creation/updates to the user.
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-enterprise-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 Enterprise 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.