@octokit/openapi
Version:
GitHub's official OpenAPI spec with Octokit extensions
1,384 lines • 50.3 MB
JSON
{
"openapi": "3.0.3",
"info": {
"version": "21.0.0",
"title": "GitHub's official OpenAPI spec + Octokit extension",
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
"license": {
"name": "MIT",
"url": "https://spdx.org/licenses/MIT"
},
"termsOfService": "https://docs.github.com/articles/github-terms-of-service",
"contact": {
"name": "Support",
"url": "https://github.com/octokit/openapi"
},
"x-github-plan": "ghes",
"x-github-release": 3.17
},
"tags": [
{
"name": "actions",
"description": "Endpoints to manage GitHub Actions using the REST API."
},
{
"name": "activity",
"description": "Activity APIs provide access to notifications, subscriptions, and timelines."
},
{
"name": "apps",
"description": "Information for integrations and installations."
},
{
"name": "billing",
"description": "Monitor charges and usage from Actions and Packages."
},
{
"name": "checks",
"description": "Rich interactions with checks run by your integrations."
},
{
"name": "code-scanning",
"description": "Retrieve code scanning alerts from a repository."
},
{
"name": "codes-of-conduct",
"description": "Insight into codes of conduct for your communities."
},
{
"name": "emojis",
"description": "List emojis available to use on GitHub."
},
{
"name": "dependabot",
"description": "Endpoints to manage Dependabot."
},
{
"name": "dependency-graph",
"description": "Endpoints to access Dependency Graph features."
},
{
"name": "gists",
"description": "View, modify your gists."
},
{
"name": "git",
"description": "Raw Git functionality."
},
{
"name": "gitignore",
"description": "View gitignore templates"
},
{
"name": "issues",
"description": "Interact with GitHub Issues."
},
{
"name": "licenses",
"description": "View various OSS licenses."
},
{
"name": "markdown",
"description": "Render GitHub flavored markdown"
},
{
"name": "merge-queue",
"description": "Interact with GitHub Merge Queues."
},
{
"name": "meta",
"description": "Endpoints that give information about the API."
},
{
"name": "migrations",
"description": "Move projects to or from GitHub."
},
{
"name": "oidc",
"description": "Endpoints to manage GitHub OIDC configuration using the REST API."
},
{
"name": "orgs",
"description": "Interact with GitHub Orgs."
},
{
"name": "packages",
"description": "Manage packages for authenticated users and organizations."
},
{
"name": "projects-classic",
"description": "Interact with GitHub Projects (classic)."
},
{
"name": "pulls",
"description": "Interact with GitHub Pull Requests."
},
{
"name": "rate-limit",
"description": "Check your current rate limit status"
},
{
"name": "reactions",
"description": "Interact with reactions to various GitHub entities."
},
{
"name": "repos",
"description": "Interact with GitHub Repos."
},
{
"name": "search",
"description": "Look for stuff on GitHub."
},
{
"name": "secret-scanning",
"description": "Retrieve secret scanning alerts from a repository."
},
{
"name": "teams",
"description": "Interact with GitHub Teams."
},
{
"name": "users",
"description": "Interact with and view information about users and also current user."
},
{
"name": "scim",
"description": "Provisioning of GitHub organization membership for SCIM-enabled providers."
},
{
"name": "enterprise-admin",
"description": "Enterprise Administration"
},
{
"name": "oauth-authorizations",
"description": "OAuth Authorizations API"
},
{
"name": "security-advisories",
"description": "Security Advisories API"
},
{
"name": "code-security",
"description": "Endpoints to manage code security using the REST API."
},
{
"name": "private-registries",
"description": "Manage private registry configurations."
}
],
"servers": [
{
"url": "{protocol}://{hostname}/api/v3",
"variables": {
"hostname": {
"description": "Self-hosted Enterprise Server hostname",
"default": "HOSTNAME"
},
"protocol": {
"description": "Self-hosted Enterprise Server protocol",
"default": "http"
}
}
}
],
"externalDocs": {
"description": "GitHub Enterprise Developer Docs",
"url": "https://docs.github.com/enterprise-server@3.17/rest/"
},
"paths": {
"/": {
"get": {
"summary": "GitHub API Root",
"description": "Get Hypermedia links to resources accessible in GitHub's REST API",
"tags": [
"meta"
],
"operationId": "meta/root",
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"current_user_url": {
"type": "string",
"format": "uri-template"
},
"current_user_authorizations_html_url": {
"type": "string",
"format": "uri-template"
},
"authorizations_url": {
"type": "string",
"format": "uri-template"
},
"code_search_url": {
"type": "string",
"format": "uri-template"
},
"commit_search_url": {
"type": "string",
"format": "uri-template"
},
"emails_url": {
"type": "string",
"format": "uri-template"
},
"emojis_url": {
"type": "string",
"format": "uri-template"
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"feeds_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri-template"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"hub_url": {
"type": "string",
"format": "uri-template",
"deprecated": true
},
"issue_search_url": {
"type": "string",
"format": "uri-template"
},
"issues_url": {
"type": "string",
"format": "uri-template"
},
"keys_url": {
"type": "string",
"format": "uri-template"
},
"label_search_url": {
"type": "string",
"format": "uri-template"
},
"notifications_url": {
"type": "string",
"format": "uri-template"
},
"organization_url": {
"type": "string",
"format": "uri-template"
},
"organization_repositories_url": {
"type": "string",
"format": "uri-template"
},
"organization_teams_url": {
"type": "string",
"format": "uri-template"
},
"public_gists_url": {
"type": "string",
"format": "uri-template"
},
"rate_limit_url": {
"type": "string",
"format": "uri-template"
},
"repository_url": {
"type": "string",
"format": "uri-template"
},
"repository_search_url": {
"type": "string",
"format": "uri-template"
},
"current_user_repositories_url": {
"type": "string",
"format": "uri-template"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"starred_gists_url": {
"type": "string",
"format": "uri-template"
},
"topic_search_url": {
"type": "string",
"format": "uri-template"
},
"user_url": {
"type": "string",
"format": "uri-template"
},
"user_organizations_url": {
"type": "string",
"format": "uri-template"
},
"user_repositories_url": {
"type": "string",
"format": "uri-template"
},
"user_search_url": {
"type": "string",
"format": "uri-template"
}
},
"required": [
"current_user_url",
"current_user_authorizations_html_url",
"authorizations_url",
"code_search_url",
"commit_search_url",
"emails_url",
"emojis_url",
"events_url",
"feeds_url",
"followers_url",
"following_url",
"gists_url",
"issue_search_url",
"issues_url",
"keys_url",
"label_search_url",
"notifications_url",
"organization_url",
"organization_repositories_url",
"organization_teams_url",
"public_gists_url",
"rate_limit_url",
"repository_url",
"repository_search_url",
"current_user_repositories_url",
"starred_url",
"starred_gists_url",
"user_url",
"user_organizations_url",
"user_repositories_url",
"user_search_url"
]
},
"examples": {
"default": {
"value": {
"current_user_url": "https://api.github.com/user",
"current_user_authorizations_html_url": "https://github.com/settings/connections/applications{/client_id}",
"authorizations_url": "https://api.github.com/authorizations",
"code_search_url": "https://api.github.com/search/code?q={query}{&page,per_page,sort,order}",
"commit_search_url": "https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}",
"emails_url": "https://api.github.com/user/emails",
"emojis_url": "https://api.github.com/emojis",
"events_url": "https://api.github.com/events",
"feeds_url": "https://api.github.com/feeds",
"followers_url": "https://api.github.com/user/followers",
"following_url": "https://api.github.com/user/following{/target}",
"gists_url": "https://api.github.com/gists{/gist_id}",
"hub_url": "https://api.github.com/hub",
"issue_search_url": "https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}",
"issues_url": "https://api.github.com/issues",
"keys_url": "https://api.github.com/user/keys",
"label_search_url": "https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page}",
"notifications_url": "https://api.github.com/notifications",
"organization_url": "https://api.github.com/orgs/{org}",
"organization_repositories_url": "https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}",
"organization_teams_url": "https://api.github.com/orgs/{org}/teams",
"public_gists_url": "https://api.github.com/gists/public",
"rate_limit_url": "https://api.github.com/rate_limit",
"repository_url": "https://api.github.com/repos/{owner}/{repo}",
"repository_search_url": "https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}",
"current_user_repositories_url": "https://api.github.com/user/repos{?type,page,per_page,sort}",
"starred_url": "https://api.github.com/user/starred{/owner}{/repo}",
"starred_gists_url": "https://api.github.com/gists/starred",
"topic_search_url": "https://api.github.com/search/topics?q={query}{&page,per_page}",
"user_url": "https://api.github.com/users/{user}",
"user_organizations_url": "https://api.github.com/user/orgs",
"user_repositories_url": "https://api.github.com/users/{user}/repos{?type,page,per_page,sort}",
"user_search_url": "https://api.github.com/search/users?q={query}{&page,per_page,sort,order}"
}
}
}
}
}
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "meta",
"subcategory": "meta"
},
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.17/rest/meta/meta#github-api-root"
},
"x-octokit": {}
}
},
"/admin/hooks": {
"get": {
"summary": "List global webhooks",
"description": "",
"operationId": "enterprise-admin/list-global-webhooks",
"tags": [
"enterprise-admin"
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.17/rest/enterprise-admin/global-webhooks#list-global-webhooks"
},
"parameters": [
{
"name": "per_page",
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.17/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
"in": "query",
"schema": {
"type": "integer",
"default": 30
}
},
{
"name": "page",
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.17/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
"in": "query",
"schema": {
"type": "integer",
"default": 1
}
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"active": {
"type": "boolean"
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"config": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"content_type": {
"type": "string"
},
"insecure_ssl": {
"type": "string"
},
"secret": {
"type": "string"
}
}
},
"updated_at": {
"type": "string"
},
"created_at": {
"type": "string"
},
"url": {
"type": "string"
},
"ping_url": {
"type": "string"
}
}
}
},
"examples": {
"default": {
"value": [
{
"type": "Global",
"id": 1,
"name": "web",
"active": true,
"events": [
"organization",
"user"
],
"config": {
"url": "https://example.com",
"content_type": "json",
"insecure_ssl": "0",
"secret": "********"
},
"updated_at": "2017-12-07T00:14:59Z",
"created_at": "2017-12-07T00:14:59Z",
"url": "https://api.github.com/admin/hooks/1",
"ping_url": "https://api.github.com/admin/hooks/1/pings"
}
]
}
}
}
},
"headers": {
"Link": {
"example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\"",
"schema": {
"type": "string"
}
}
}
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"category": "enterprise-admin",
"subcategory": "global-webhooks"
},
"x-octokit": {}
},
"post": {
"summary": "Create a global webhook",
"description": "",
"operationId": "enterprise-admin/create-global-webhook",
"tags": [
"enterprise-admin"
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.17/rest/enterprise-admin/global-webhooks#create-a-global-webhook"
},
"responses": {
"201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"active": {
"type": "boolean"
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"config": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"content_type": {
"type": "string"
},
"insecure_ssl": {
"type": "string"
},
"secret": {
"type": "string"
}
}
},
"updated_at": {
"type": "string"
},
"created_at": {
"type": "string"
},
"url": {
"type": "string"
},
"ping_url": {
"type": "string"
}
}
},
"examples": {
"default": {
"value": {
"type": "Global",
"id": 1,
"name": "web",
"active": true,
"events": [
"organization",
"user"
],
"config": {
"url": "https://example.com",
"content_type": "json",
"insecure_ssl": "0",
"secret": "********"
},
"updated_at": "2017-12-07T00:14:59Z",
"created_at": "2017-12-07T00:14:59Z",
"url": "https://api.github.com/admin/hooks/1",
"ping_url": "https://api.github.com/admin/hooks/1/pings"
}
}
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Must be passed as \"web\"."
},
"config": {
"type": "object",
"description": "Key/value pairs to provide settings for this webhook.",
"properties": {
"url": {
"type": "string",
"description": "The URL to which the payloads will be delivered."
},
"content_type": {
"type": "string",
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`."
},
"secret": {
"type": "string",
"description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.17/webhooks/event-payloads/#delivery-headers) header."
},
"insecure_ssl": {
"type": "string",
"description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**"
}
},
"required": [
"url"
]
},
"events": {
"type": "array",
"description": "The [events](https://docs.github.com/enterprise-server@3.17/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.",
"items": {
"type": "string"
}
},
"active": {
"type": "boolean",
"description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
"default": true
}
},
"required": [
"name",
"config"
]
},
"examples": {
"default": {
"value": {
"name": "web",
"events": [
"organization",
"user"
],
"config": {
"url": "https://example.com/webhook",
"content_type": "json",
"secret": "secret"
}
}
}
}
}
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"category": "enterprise-admin",
"subcategory": "global-webhooks"
},
"x-octokit": {}
}
},
"/admin/hooks/{hook_id}": {
"get": {
"summary": "Get a global webhook",
"description": "",
"operationId": "enterprise-admin/get-global-webhook",
"tags": [
"enterprise-admin"
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.17/rest/enterprise-admin/global-webhooks#get-a-global-webhook"
},
"parameters": [
{
"name": "hook_id",
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"active": {
"type": "boolean"
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"config": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"content_type": {
"type": "string"
},
"insecure_ssl": {
"type": "string"
},
"secret": {
"type": "string"
}
}
},
"updated_at": {
"type": "string"
},
"created_at": {
"type": "string"
},
"url": {
"type": "string"
},
"ping_url": {
"type": "string"
}
}
},
"examples": {
"default": {
"value": {
"type": "Global",
"id": 1,
"name": "web",
"active": true,
"events": [
"organization",
"user"
],
"config": {
"url": "https://example.com",
"content_type": "json",
"insecure_ssl": "0",
"secret": "********"
},
"updated_at": "2017-12-07T00:14:59Z",
"created_at": "2017-12-07T00:14:59Z",
"url": "https://api.github.com/admin/hooks/1",
"ping_url": "https://api.github.com/admin/hooks/1/pings"
}
}
}
}
}
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"category": "enterprise-admin",
"subcategory": "global-webhooks"
},
"x-octokit": {}
},
"patch": {
"summary": "Update a global webhook",
"description": "Parameters that are not provided will be overwritten with the default value or removed if no default exists.",
"operationId": "enterprise-admin/update-global-webhook",
"tags": [
"enterprise-admin"
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.17/rest/enterprise-admin/global-webhooks#update-a-global-webhook"
},
"parameters": [
{
"name": "hook_id",
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"active": {
"type": "boolean"
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"config": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"content_type": {
"type": "string"
},
"insecure_ssl": {
"type": "string"
}
}
},
"updated_at": {
"type": "string"
},
"created_at": {
"type": "string"
},
"url": {
"type": "string"
},
"ping_url": {
"type": "string"
}
}
},
"examples": {
"default": {
"value": {
"type": "Global",
"id": 1,
"name": "web",
"active": true,
"events": [
"organization"
],
"config": {
"url": "https://example.com",
"content_type": "form",
"insecure_ssl": "0"
},
"updated_at": "2017-12-07T00:14:59Z",
"created_at": "2017-12-07T00:14:59Z",
"url": "https://api.github.com/admin/hooks/1",
"ping_url": "https://api.github.com/admin/hooks/1/pings"
}
}
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"config": {
"type": "object",
"description": "Key/value pairs to provide settings for this webhook.",
"properties": {
"url": {
"type": "string",
"description": "The URL to which the payloads will be delivered."
},
"content_type": {
"type": "string",
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`."
},
"secret": {
"type": "string",
"description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.17/webhooks/event-payloads/#delivery-headers) header."
},
"insecure_ssl": {
"type": "string",
"description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**"
}
},
"required": [
"url"
]
},
"events": {
"type": "array",
"description": "The [events](https://docs.github.com/enterprise-server@3.17/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.",
"items": {
"type": "string"
}
},
"active": {
"type": "boolean",
"description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
"default": true
}
}
},
"examples": {
"default": {
"value": {
"events": [
"organization"
],
"config": {
"url": "https://example.com/webhook"
}
}
}
}
}
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"category": "enterprise-admin",
"subcategory": "global-webhooks"
},
"x-octokit": {}
},
"delete": {
"summary": "Delete a global webhook",
"description": "",
"operationId": "enterprise-admin/delete-global-webhook",
"tags": [
"enterprise-admin"
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.17/rest/enterprise-admin/global-webhooks#delete-a-global-webhook"
},
"parameters": [
{
"name": "hook_id",
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"category": "enterprise-admin",
"subcategory": "global-webhooks"
},
"x-octokit": {}
}
},
"/admin/hooks/{hook_id}/pings": {
"post": {
"summary": "Ping a global webhook",
"description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.17/webhooks/#ping-event) to be sent to the webhook.",
"operationId": "enterprise-admin/ping-global-webhook",
"tags": [
"enterprise-admin"
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.17/rest/enterprise-admin/global-webhooks#ping-a-global-webhook"
},
"parameters": [
{
"name": "hook_id",
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"category": "enterprise-admin",
"subcategory": "global-webhooks"
},
"x-octokit": {}
}
},
"/admin/keys": {
"get": {
"summary": "List public keys",
"description": "",
"operationId": "enterprise-admin/list-public-keys",
"tags": [
"enterprise-admin"
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.17/rest/enterprise-admin/users#list-public-keys"
},
"parameters": [
{
"name": "per_page",
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.17/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
"in": "query",
"schema": {
"type": "integer",
"default": 30
}
},
{
"name": "page",
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.17/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
"in": "query",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "direction",
"description": "The direction to sort the results by.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"created",
"updated",
"accessed"
],
"default": "created"
}
},
{
"name": "since",
"description": "Only show public keys accessed after the given time.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"key": {
"type": "string"
},
"user_id": {
"nullable": true,
"type": "integer"
},
"repository_id": {
"nullable": true,
"type": "integer",
"format": "int64"
},
"url": {
"type": "string"
},
"title": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"verified": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"added_by": {
"type": "string",
"nullable": true
},
"last_used": {
"nullable": true,
"type": "string",
"format": "date-time"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"id",
"key",
"url",
"title",
"verified",
"created_at",
"read_only",
"last_used",
"user_id",
"repository_id"
]
}
},
"examples": {
"default": {
"value": [
{
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
"id": 2,
"url": "https://api.github.com/user/keys/2",
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
"created_at": "2020-06-11T21:31:57Z",
"verified": false,
"read_only": false,
"last_used": "2020-06-11T22:31:57Z",
"user_id": 1,
"repository_id": 2
},
{
"key": "9Og8iYjAyymI9LvABpJerYrMxURPc8r+dB7TJyvv1234",
"id": 3,
"url": "https://api.github.com/user/keys/2",
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
"created_at": "2020-06-11T21:31:57Z",
"verified": false,
"read_only": false,
"last_used": "2020-06-11T22:31:57Z",
"user_id": 1,
"repository_id": 2
}
]
}
}
}
},
"headers": {
"Link": {
"example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\"",
"schema": {
"type": "string"
}
}
}
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"category": "enterprise-admin",
"subcategory": "users"
},
"x-octokit": {}
}
},
"/admin/keys/{key_ids}": {
"delete": {
"summary": "Delete a public key",
"description": "",
"operationId": "enterprise-admin/delete-public-key",
"tags": [
"enterprise-admin"
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.17/rest/enterprise-admin/users#delete-a-public-key"
},
"parameters": [
{
"name": "key_ids",
"description": "The unique identifier of the key.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"category": "enterprise-admin",
"subcategory": "users"
},
"x-octokit": {}
}
},
"/admin/ldap/teams/{team_id}/mapping": {
"patch": {
"summary": "Update LDAP mapping for a team",
"description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.17/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.17/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping.",
"operationId": "enterprise-admin/update-ldap-mapping-for-team",
"tags": [
"enterprise-admin"
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.17/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team"
},
"parameters": [
{
"name": "team_id",
"description": "The unique identifier of the team.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ldap_dn": {
"type": "string"
},
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"url": {
"type": "string"
},
"html_url": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"t