Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Engineering Platform

APIs.io Engineering Platform Enterprise-Admin API

Enterprise Administration

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 122 operations across 75 paths, and defines 73 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

122 operations 75 paths 73 schemas 22 DELETE50 GET14 PATCH22 POST14 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Contact
Mike Ralphson
License
Apache 2.0 License
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Enterprise-Admin API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 122

Across 75 paths, the API surfaces 122 operations — 22 DELETE, 50 GET, 14 PATCH, 22 POST, 14 PUT. Each is listed below with its method, path, parameters, and response codes.

Enterprise-Admin 122

Enterprise Administration

GET
/admin/hooks
APIs.io Engineering Platform List global webhooks
enterprise-admin/list-global-webhooks 2 params → 200
POST
/admin/hooks
APIs.io Engineering Platform Create a global webhook
enterprise-admin/create-global-webhook body → 201
GET
/admin/hooks/{hook_id}
APIs.io Engineering Platform Get a global webhook
enterprise-admin/get-global-webhook 1 param → 200
PATCH
/admin/hooks/{hook_id}
APIs.io Engineering Platform Update a global webhook
enterprise-admin/update-global-webhook 1 param body → 200
DELETE
/admin/hooks/{hook_id}
APIs.io Engineering Platform Delete a global webhook
enterprise-admin/delete-global-webhook 1 param → 204
POST
/admin/hooks/{hook_id}/pings
APIs.io Engineering Platform Ping a global webhook
enterprise-admin/ping-global-webhook 1 param → 204
GET
/admin/keys
APIs.io Engineering Platform List public keys
enterprise-admin/list-public-keys 5 params → 200
DELETE
/admin/keys/{key_ids}
APIs.io Engineering Platform Delete a public key
enterprise-admin/delete-public-key 1 param → 204
PATCH
/admin/ldap/teams/{team_id}/mapping
APIs.io Engineering Platform Update LDAP mapping for a team
enterprise-admin/update-ldap-mapping-for-team 1 param body → 200
POST
/admin/ldap/teams/{team_id}/sync
APIs.io Engineering Platform Sync LDAP mapping for a team
enterprise-admin/sync-ldap-mapping-for-team 1 param → 201
PATCH
/admin/ldap/users/{username}/mapping
APIs.io Engineering Platform Update LDAP mapping for a user
enterprise-admin/update-ldap-mapping-for-user 1 param body → 200
POST
/admin/ldap/users/{username}/sync
APIs.io Engineering Platform Sync LDAP mapping for a user
enterprise-admin/sync-ldap-mapping-for-user 1 param → 201
POST
/admin/organizations
APIs.io Engineering Platform Create an organization
enterprise-admin/create-org body → 201
PATCH
/admin/organizations/{org}
APIs.io Engineering Platform Update an organization name
enterprise-admin/update-org-name 1 param body → 202
GET
/admin/pre-receive-environments
APIs.io Engineering Platform List pre-receive environments
enterprise-admin/list-pre-receive-environments 4 params → 200
POST
/admin/pre-receive-environments
APIs.io Engineering Platform Create a pre-receive environment
enterprise-admin/create-pre-receive-environment body → 201
GET
/admin/pre-receive-environments/{pre_receive_environment_id}
APIs.io Engineering Platform Get a pre-receive environment
enterprise-admin/get-pre-receive-environment 1 param → 200
PATCH
/admin/pre-receive-environments/{pre_receive_environment_id}
APIs.io Engineering Platform Update a pre-receive environment
enterprise-admin/update-pre-receive-environment 1 param body → 200422
DELETE
/admin/pre-receive-environments/{pre_receive_environment_id}
APIs.io Engineering Platform Delete a pre-receive environment
enterprise-admin/delete-pre-receive-environment 1 param → 204422
POST
/admin/pre-receive-environments/{pre_receive_environment_id}/downloads
APIs.io Engineering Platform Start a pre-receive environment download
enterprise-admin/start-pre-receive-environment-download 1 param → 202422
GET
/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest
APIs.io Engineering Platform Get the download status for a pre-receive environment
enterprise-admin/get-download-status-for-pre-receive-environment 1 param → 200
GET
/admin/pre-receive-hooks
APIs.io Engineering Platform List pre-receive hooks
enterprise-admin/list-pre-receive-hooks 4 params → 200
POST
/admin/pre-receive-hooks
APIs.io Engineering Platform Create a pre-receive hook
enterprise-admin/create-pre-receive-hook body → 201
GET
/admin/pre-receive-hooks/{pre_receive_hook_id}
APIs.io Engineering Platform Get a pre-receive hook
enterprise-admin/get-pre-receive-hook 1 param → 200
PATCH
/admin/pre-receive-hooks/{pre_receive_hook_id}
APIs.io Engineering Platform Update a pre-receive hook
enterprise-admin/update-pre-receive-hook 1 param body → 200
DELETE
/admin/pre-receive-hooks/{pre_receive_hook_id}
APIs.io Engineering Platform Delete a pre-receive hook
enterprise-admin/delete-pre-receive-hook 1 param → 204
GET
/admin/tokens
APIs.io Engineering Platform List personal access tokens
enterprise-admin/list-personal-access-tokens 2 params → 200
DELETE
/admin/tokens/{token_id}
APIs.io Engineering Platform Delete a personal access token
enterprise-admin/delete-personal-access-token 1 param → 204
POST
/admin/users
APIs.io Engineering Platform Create a user
enterprise-admin/create-user body → 201
PATCH
/admin/users/{username}
APIs.io Engineering Platform Update the username for a user
enterprise-admin/update-username-for-user 1 param body → 202
DELETE
/admin/users/{username}
APIs.io Engineering Platform Delete a user
enterprise-admin/delete-user 1 param → 204
POST
/admin/users/{username}/authorizations
APIs.io Engineering Platform Create an impersonation OAuth token
enterprise-admin/create-impersonation-o-auth-token 1 param body → 201200
DELETE
/admin/users/{username}/authorizations
APIs.io Engineering Platform Delete an impersonation OAuth token
enterprise-admin/delete-impersonation-o-auth-token 1 param → 204
GET
/enterprise/announcement
APIs.io Engineering Platform Get the global announcement banner
enterprise-admin/get-announcement → 200
PATCH
/enterprise/announcement
APIs.io Engineering Platform Set the global announcement banner
enterprise-admin/set-announcement body → 200
DELETE
/enterprise/announcement
APIs.io Engineering Platform Remove the global announcement banner
enterprise-admin/remove-announcement → 204
GET
/enterprise/settings/license
APIs.io Engineering Platform Get license information
enterprise-admin/get-license-information → 200
GET
/enterprise/stats/all
APIs.io Engineering Platform Get all statistics
enterprise-admin/get-all-stats → 200
GET
/enterprise/stats/comments
APIs.io Engineering Platform Get comment statistics
enterprise-admin/get-comment-stats → 200
GET
/enterprise/stats/gists
APIs.io Engineering Platform Get gist statistics
enterprise-admin/get-gist-stats → 200
GET
/enterprise/stats/hooks
APIs.io Engineering Platform Get hooks statistics
enterprise-admin/get-hooks-stats → 200
GET
/enterprise/stats/issues
APIs.io Engineering Platform Get issue statistics
enterprise-admin/get-issue-stats → 200
GET
/enterprise/stats/milestones
APIs.io Engineering Platform Get milestone statistics
enterprise-admin/get-milestone-stats → 200
GET
/enterprise/stats/orgs
APIs.io Engineering Platform Get organization statistics
enterprise-admin/get-org-stats → 200
GET
/enterprise/stats/pages
APIs.io Engineering Platform Get pages statistics
enterprise-admin/get-pages-stats → 200
GET
/enterprise/stats/pulls
APIs.io Engineering Platform Get pull request statistics
enterprise-admin/get-pull-request-stats → 200
GET
/enterprise/stats/repos
APIs.io Engineering Platform Get repository statistics
enterprise-admin/get-repo-stats → 200
GET
/enterprise/stats/users
APIs.io Engineering Platform Get users statistics
enterprise-admin/get-user-stats → 200
GET
/enterprises/{enterprise}/actions/permissions
APIs.io Engineering Platform Get GitHub Actions permissions for an enterprise
enterprise-admin/get-github-actions-permissions-enterprise 1 param → 200
PUT
/enterprises/{enterprise}/actions/permissions
APIs.io Engineering Platform Set GitHub Actions permissions for an enterprise
enterprise-admin/set-github-actions-permissions-enterprise 1 param body → 204
GET
/enterprises/{enterprise}/actions/permissions/organizations
APIs.io Engineering Platform List selected organizations enabled for GitHub Actions in an enterprise
enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise 3 params → 200
PUT
/enterprises/{enterprise}/actions/permissions/organizations
APIs.io Engineering Platform Set selected organizations enabled for GitHub Actions in an enterprise
enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise 1 param body → 204
PUT
/enterprises/{enterprise}/actions/permissions/organizations/{org_id}
APIs.io Engineering Platform Enable a selected organization for GitHub Actions in an enterprise
enterprise-admin/enable-selected-organization-github-actions-enterprise 2 params → 204
DELETE
/enterprises/{enterprise}/actions/permissions/organizations/{org_id}
APIs.io Engineering Platform Disable a selected organization for GitHub Actions in an enterprise
enterprise-admin/disable-selected-organization-github-actions-enterprise 2 params → 204
GET
/enterprises/{enterprise}/actions/permissions/selected-actions
APIs.io Engineering Platform Get allowed actions for an enterprise
enterprise-admin/get-allowed-actions-enterprise 1 param → 200
PUT
/enterprises/{enterprise}/actions/permissions/selected-actions
APIs.io Engineering Platform Set allowed actions for an enterprise
enterprise-admin/set-allowed-actions-enterprise 1 param body → 204
GET
/enterprises/{enterprise}/actions/runner-groups
APIs.io Engineering Platform List self-hosted runner groups for an enterprise
enterprise-admin/list-self-hosted-runner-groups-for-enterprise 4 params → 200
POST
/enterprises/{enterprise}/actions/runner-groups
APIs.io Engineering Platform Create a self-hosted runner group for an enterprise
enterprise-admin/create-self-hosted-runner-group-for-enterprise 1 param body → 201
GET
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}
APIs.io Engineering Platform Get a self-hosted runner group for an enterprise
enterprise-admin/get-self-hosted-runner-group-for-enterprise 2 params → 200
PATCH
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}
APIs.io Engineering Platform Update a self-hosted runner group for an enterprise
enterprise-admin/update-self-hosted-runner-group-for-enterprise 2 params body → 200
DELETE
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}
APIs.io Engineering Platform Delete a self-hosted runner group from an enterprise
enterprise-admin/delete-self-hosted-runner-group-from-enterprise 2 params → 204
GET
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations
APIs.io Engineering Platform List organization access to a self-hosted runner group in an enterprise
enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise 4 params → 200
PUT
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations
APIs.io Engineering Platform Set organization access for a self-hosted runner group in an enterprise
enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise 2 params body → 204
PUT
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}
APIs.io Engineering Platform Add organization access to a self-hosted runner group in an enterprise
enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise 3 params → 204
DELETE
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}
APIs.io Engineering Platform Remove organization access to a self-hosted runner group in an enterprise
enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise 3 params → 204
GET
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners
APIs.io Engineering Platform List self-hosted runners in a group for an enterprise
enterprise-admin/list-self-hosted-runners-in-group-for-enterprise 4 params → 200
PUT
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners
APIs.io Engineering Platform Set self-hosted runners in a group for an enterprise
enterprise-admin/set-self-hosted-runners-in-group-for-enterprise 2 params body → 204
PUT
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
APIs.io Engineering Platform Add a self-hosted runner to a group for an enterprise
enterprise-admin/add-self-hosted-runner-to-group-for-enterprise 3 params → 204
DELETE
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
APIs.io Engineering Platform Remove a self-hosted runner from a group for an enterprise
enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise 3 params → 204
GET
/enterprises/{enterprise}/actions/runners
APIs.io Engineering Platform List self-hosted runners for an enterprise
enterprise-admin/list-self-hosted-runners-for-enterprise 3 params → 200
GET
/enterprises/{enterprise}/actions/runners/downloads
APIs.io Engineering Platform List runner applications for an enterprise
enterprise-admin/list-runner-applications-for-enterprise 1 param → 200
POST
/enterprises/{enterprise}/actions/runners/registration-token
APIs.io Engineering Platform Create a registration token for an enterprise
enterprise-admin/create-registration-token-for-enterprise 1 param → 201
POST
/enterprises/{enterprise}/actions/runners/remove-token
APIs.io Engineering Platform Create a remove token for an enterprise
enterprise-admin/create-remove-token-for-enterprise 1 param → 201
GET
/enterprises/{enterprise}/actions/runners/{runner_id}
APIs.io Engineering Platform Get a self-hosted runner for an enterprise
enterprise-admin/get-self-hosted-runner-for-enterprise 2 params → 200
DELETE
/enterprises/{enterprise}/actions/runners/{runner_id}
APIs.io Engineering Platform Delete a self-hosted runner from an enterprise
enterprise-admin/delete-self-hosted-runner-from-enterprise 2 params → 204
GET
/enterprises/{enterprise}/actions/runners/{runner_id}/labels
APIs.io Engineering Platform List labels for a self-hosted runner for an enterprise
enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise 2 params → 200404
POST
/enterprises/{enterprise}/actions/runners/{runner_id}/labels
APIs.io Engineering Platform Add custom labels to a self-hosted runner for an enterprise
enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise 2 params body → 200404422
PUT
/enterprises/{enterprise}/actions/runners/{runner_id}/labels
APIs.io Engineering Platform Set custom labels for a self-hosted runner for an enterprise
enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise 2 params body → 200404422
DELETE
/enterprises/{enterprise}/actions/runners/{runner_id}/labels
APIs.io Engineering Platform Remove all custom labels from a self-hosted runner for an enterprise
enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise 2 params → 200404422
DELETE
/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}
APIs.io Engineering Platform Remove a custom label from a self-hosted runner for an enterprise
enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise 3 params → 200404422
GET
/enterprises/{enterprise}/audit-log
APIs.io Engineering Platform Get the audit log for an enterprise
enterprise-admin/get-audit-log 8 params → 200
GET
/enterprises/{enterprise}/code_security_and_analysis
APIs.io Engineering Platform Get code security and analysis features for an enterprise
secret-scanning/get-security-analysis-settings-for-enterprise 1 param → 200404
PATCH
/enterprises/{enterprise}/code_security_and_analysis
APIs.io Engineering Platform Update code security and analysis features for an enterprise
secret-scanning/patch-security-analysis-settings-for-enterprise 1 param body → 204422404
POST
/enterprises/{enterprise}/{security_product}/{enablement}
APIs.io Engineering Platform Enable or disable a security feature
secret-scanning/post-security-product-enablement-for-enterprise 3 params → 204422404
GET
/manage/v1/config/nodes
APIs.io Engineering Platform Get GHES node metadata for all nodes
enterprise-admin/get-config-nodes 2 params → 200401500
GET
/manage/v1/replication/status
APIs.io Engineering Platform Get the status of services running on all replica nodes
enterprise-admin/get-replication-status 2 params → 200401500
GET
/manage/v1/version
APIs.io Engineering Platform Get all GHES release versions for all nodes
enterprise-admin/get-version 2 params → 200401500
GET
/orgs/{org}/pre-receive-hooks
APIs.io Engineering Platform List pre-receive hooks for an organization
enterprise-admin/list-pre-receive-hooks-for-org 5 params → 200
GET
/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}
APIs.io Engineering Platform Get a pre-receive hook for an organization
enterprise-admin/get-pre-receive-hook-for-org 2 params → 200
PATCH
/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}
APIs.io Engineering Platform Update pre-receive hook enforcement for an organization
enterprise-admin/update-pre-receive-hook-enforcement-for-org 2 params body → 200
DELETE
/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}
APIs.io Engineering Platform Remove pre-receive hook enforcement for an organization
enterprise-admin/remove-pre-receive-hook-enforcement-for-org 2 params → 200
GET
/repos/{owner}/{repo}/pre-receive-hooks
APIs.io Engineering Platform List pre-receive hooks for a repository
enterprise-admin/list-pre-receive-hooks-for-repo 6 params → 200
GET
/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}
APIs.io Engineering Platform Get a pre-receive hook for a repository
enterprise-admin/get-pre-receive-hook-for-repo 3 params → 200
PATCH
/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}
APIs.io Engineering Platform Update pre-receive hook enforcement for a repository
enterprise-admin/update-pre-receive-hook-enforcement-for-repo 3 params body → 200
DELETE
/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}
APIs.io Engineering Platform Remove pre-receive hook enforcement for a repository
enterprise-admin/remove-pre-receive-hook-enforcement-for-repo 3 params → 200
GET
/scim/v2/enterprises/{enterprise}/Groups
APIs.io Engineering Platform List provisioned SCIM groups for an enterprise
enterprise-admin/list-provisioned-groups-enterprise 5 params → 200400401403429500
POST
/scim/v2/enterprises/{enterprise}/Groups
APIs.io Engineering Platform Provision a SCIM enterprise group
enterprise-admin/provision-enterprise-group 1 param body → 201400401403409429500
GET
/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}
APIs.io Engineering Platform Get SCIM provisioning information for an enterprise group
enterprise-admin/get-provisioning-information-for-enterprise-group 3 params → 200400401403404429500
PUT
/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}
APIs.io Engineering Platform Set SCIM information for a provisioned enterprise group
enterprise-admin/set-information-for-provisioned-enterprise-group 2 params body → 200400401403404409429500
PATCH
/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}
APIs.io Engineering Platform Update an attribute for a SCIM enterprise group
enterprise-admin/update-attribute-for-enterprise-group 2 params body → 204200400401403404409429
DELETE
/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}
APIs.io Engineering Platform Delete a SCIM group from an enterprise
enterprise-admin/delete-scim-group-from-enterprise 2 params → 204400401403404429500
GET
/scim/v2/enterprises/{enterprise}/Users
APIs.io Engineering Platform List SCIM provisioned identities for an enterprise
enterprise-admin/list-provisioned-identities-enterprise 4 params → 200400401403429500
POST
/scim/v2/enterprises/{enterprise}/Users
APIs.io Engineering Platform Provision a SCIM enterprise user
enterprise-admin/provision-enterprise-user 1 param body → 201400401403409429500
GET
/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}
APIs.io Engineering Platform Get SCIM provisioning information for an enterprise user
enterprise-admin/get-provisioning-information-for-enterprise-user 2 params → 200400401403404429500
PUT
/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}
APIs.io Engineering Platform Set SCIM information for a provisioned enterprise user
enterprise-admin/set-information-for-provisioned-enterprise-user 2 params body → 200400401403404409429500
PATCH
/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}
APIs.io Engineering Platform Update an attribute for a SCIM enterprise user
enterprise-admin/update-attribute-for-enterprise-user 2 params body → 200400401403404409429500
DELETE
/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}
APIs.io Engineering Platform Delete a SCIM user from an enterprise
enterprise-admin/delete-user-from-enterprise 2 params → 204400401403404429500
GET
/setup/api/configcheck
APIs.io Engineering Platform Get the configuration status
enterprise-admin/get-configuration-status → 200401
POST
/setup/api/configure
APIs.io Engineering Platform Start a configuration process
enterprise-admin/start-configuration-process → 202401
GET
/setup/api/maintenance
APIs.io Engineering Platform Get the maintenance status
enterprise-admin/get-maintenance-status → 200401
POST
/setup/api/maintenance
APIs.io Engineering Platform Enable or disable maintenance mode
enterprise-admin/enable-or-disable-maintenance-mode body → 200401
GET
/setup/api/settings
APIs.io Engineering Platform Get settings
enterprise-admin/get-settings → 200401
PUT
/setup/api/settings
APIs.io Engineering Platform Set settings
enterprise-admin/set-settings body → 204401
GET
/setup/api/settings/authorized-keys
APIs.io Engineering Platform Get all authorized SSH keys
enterprise-admin/get-all-authorized-ssh-keys → 200401
POST
/setup/api/settings/authorized-keys
APIs.io Engineering Platform Add an authorized SSH key
enterprise-admin/add-authorized-ssh-key body → 201401
DELETE
/setup/api/settings/authorized-keys
APIs.io Engineering Platform Remove an authorized SSH key
enterprise-admin/remove-authorized-ssh-key body → 200401
POST
/setup/api/start
APIs.io Engineering Platform Create a GitHub license
enterprise-admin/create-enterprise-server-license body → 202401
POST
/setup/api/upgrade
APIs.io Engineering Platform Upgrade a license
enterprise-admin/upgrade-license body → 202401
PUT
/users/{username}/site_admin
APIs.io Engineering Platform Promote a user to be a site administrator
enterprise-admin/promote-user-to-be-site-administrator 1 param → 204
DELETE
/users/{username}/site_admin
APIs.io Engineering Platform Demote a site administrator
enterprise-admin/demote-site-administrator 1 param → 204
PUT
/users/{username}/suspended
APIs.io Engineering Platform Suspend a user
enterprise-admin/suspend-user 1 param body → 204
DELETE
/users/{username}/suspended
APIs.io Engineering Platform Unsuspend a user
enterprise-admin/unsuspend-user 1 param body → 204

Schemas 73

The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are repository (95 properties), app-permissions (45 properties), audit-log-event (43 properties), ldap-mapping-user (42 properties). Each schema is shown below with its type and property counts.

nullable-simple-user
object
A GitHub user.
21 properties 18 required
repository-pre-receive-hook
object
4 properties
scim-enterprise-group-response
repository
object
A repository on GitHub.
95 properties 73 required
announcement-expiration
string
The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format: YYYY-MM-DDTHH:MM:SSZ. To set an an…
announcement-message
string
The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs…
global-hook-2
object
10 properties
ghes-cluster-topology
string
enterprise-overview
object
10 properties
runner-label
object
A label for a self hosted runner
3 properties 1 required
user
object
8 properties 6 required
license-info
object
6 properties
scim-enterprise-user-list
object
5 properties 5 required
pre-receive-environment
object
9 properties
runner-application
object
Runner Application
6 properties 4 required
enterprise-hook-overview
object
3 properties 3 required
org-pre-receive-hook
object
5 properties
patch-schema
object
2 properties 2 required
announcement
object
Enterprise global announcement
2 properties 1 required
authorization
object
The authorization for an OAuth app, GitHub App, or a Personal Access Token.
15 properties 13 required
ssh-key
object
2 properties
group-response
object
4 properties 1 required
ghes-config-nodes
object
2 properties
user-emails-response
array
The emails for the user.
enterprise-milestone-overview
object
3 properties 3 required
configuration-status
object
2 properties
basic-error
object
Basic Error
4 properties
authentication-token
object
Authentication Token
6 properties 2 required
scim-enterprise-user-response
app-permissions
object
The permissions granted to the user access token.
45 properties
enterprise-security-analysis-settings
object
5 properties 4 required
scim-error
object
Scim Error
6 properties
global-hook
object
10 properties
public-key-full
object
11 properties 10 required
actions-enterprise-permissions
object
4 properties 1 required
ghes-version
array
enterprise-comment-overview
object
4 properties 4 required
ldap-mapping-user
object
Ldap Private User
42 properties 37 required
user-name
object
4 properties 2 required
enterprise-gist-overview
object
3 properties 3 required
selected-actions-url
string
The API URL to use to get or set the actions that are allowed to run, when allowedactions is set to selected.
user-response
object
8 properties 3 required
nullable-scoped-installation
object
7 properties 5 required
enterprise-pull-request-overview
object
4 properties 4 required
enterprise-issue-overview
object
3 properties 3 required
validation-error-simple
object
Validation Error Simple
3 properties 2 required
meta
object
The metadata associated with the creation/updates to the user.
4 properties 1 required
user-emails
array
The emails for the user.
allowed-actions
string
The permissions policy that controls the actions that are allowed to run.
pre-receive-environment-download-status
object
4 properties
enabled-organizations
string
The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.
pre-receive-hook
object
7 properties
group
object
4 properties 4 required
enterprise-page-overview
object
1 property 1 required
enterprise-settings
object
2 properties
enterprise-user-overview
object
3 properties 3 required
organization-simple
object
A GitHub organization.
12 properties 12 required
maintenance-status
object
3 properties
enterprise-organization-overview
object
4 properties 4 required
runner
object
A self hosted runner
7 properties 6 required
ghes-replication-status-indicator
string
ghes-replication-status
object
2 properties
simple-user
object
A GitHub user.
21 properties 18 required
user-name-response
object
4 properties
scim-enterprise-group-list
object
5 properties 5 required
nullable-license-simple
object
License Simple
6 properties 5 required
audit-log-event
object
43 properties
runner-groups-enterprise
object
10 properties 6 required
user-role
array
The roles assigned to the user.
ghes-cluster-roles
string
enterprise-repository-overview
object
6 properties 6 required
selected-actions
object
2 properties 2 required
ldap-mapping-team
object
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-enterprise-admin-api-openapi.yml Raw ↑
#Enterprise-Admin
← Back to A APIs
API Details
ID
engineering-platform:engineering-platform-enterprise-admin-api
Base URL
https://{bucketname}.s3.amazonaws.com
Docs
https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html
Provider
Engineering Platform
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network