1
0
mirror of synced 2025-12-19 18:10:59 -05:00

Update OpenAPI Description (#56428)

Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com>
Co-authored-by: Hirsch Singhal <1666363+hpsin@users.noreply.github.com>
This commit is contained in:
docs-bot
2025-07-01 12:01:20 -07:00
committed by GitHub
parent 3f72bc3f64
commit 1e40010323
17 changed files with 4892 additions and 497 deletions

View File

@@ -27,6 +27,7 @@ children:
- /management-console - /management-console
- /network-configurations - /network-configurations
- /org-pre-receive-hooks - /org-pre-receive-hooks
- /organization-installations
- /orgs - /orgs
- /pre-receive-environments - /pre-receive-environments
- /pre-receive-hooks - /pre-receive-hooks

View File

@@ -0,0 +1,13 @@
---
title: REST API for managing organization GitHub App installations
shortTitle: GitHub App installations
intro: Use the REST API to manage which {% data variables.product.prodname_github_apps %} are installed in your enterprise's organizations.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
ghec: '*'
topics:
- API
autogenerated: rest
allowTitleToDifferFromFilename: true
---
<!-- Content after this section is automatically generated -->

View File

@@ -173,6 +173,144 @@
} }
] ]
}, },
"enterprise_organization_installation_repositories": {
"title": "Enterprise organization installation repositories",
"displayTitle": "Enterprise permissions for \"Enterprise organization installation repositories\"",
"permissions": [
{
"category": "enterprise-admin",
"slug": "get-repositories-belonging-to-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations/{org}/accessible_repositories",
"additional-permissions": true,
"access": "read"
},
{
"category": "enterprise-admin",
"slug": "get-the-repositories-accessible-to-a-given-github-app-installation",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories",
"additional-permissions": true,
"access": "read"
},
{
"category": "enterprise-admin",
"slug": "toggle-installation-repository-access-between-selected-and-all-repositories",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories",
"additional-permissions": true,
"access": "write"
},
{
"category": "enterprise-admin",
"slug": "grant-repository-access-to-an-organization-installation",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/add",
"additional-permissions": true,
"access": "write"
},
{
"category": "enterprise-admin",
"slug": "remove-repository-access-from-an-organization-installation",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/remove",
"additional-permissions": true,
"access": "write"
}
]
},
"enterprise_organization_installations": {
"title": "Enterprise organization installations",
"displayTitle": "Enterprise permissions for \"Enterprise organization installations\"",
"permissions": [
{
"category": "enterprise-admin",
"slug": "get-enterprise-owned-organizations-that-can-have-github-apps-installed",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations",
"additional-permissions": false,
"access": "read"
},
{
"category": "enterprise-admin",
"slug": "get-repositories-belonging-to-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations/{org}/accessible_repositories",
"additional-permissions": true,
"access": "read"
},
{
"category": "enterprise-admin",
"slug": "list-github-apps-installed-on-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations",
"additional-permissions": false,
"access": "read"
},
{
"category": "enterprise-admin",
"slug": "install-a-github-app-on-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "post",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations",
"additional-permissions": false,
"access": "write"
},
{
"category": "enterprise-admin",
"slug": "uninstall-a-github-app-from-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "delete",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}",
"additional-permissions": false,
"access": "write"
},
{
"category": "enterprise-admin",
"slug": "get-the-repositories-accessible-to-a-given-github-app-installation",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories",
"additional-permissions": true,
"access": "read"
},
{
"category": "enterprise-admin",
"slug": "toggle-installation-repository-access-between-selected-and-all-repositories",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories",
"additional-permissions": true,
"access": "write"
},
{
"category": "enterprise-admin",
"slug": "grant-repository-access-to-an-organization-installation",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/add",
"additional-permissions": true,
"access": "write"
},
{
"category": "enterprise-admin",
"slug": "remove-repository-access-from-an-organization-installation",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/remove",
"additional-permissions": true,
"access": "write"
}
]
},
"organization_api_insights": { "organization_api_insights": {
"title": "API Insights", "title": "API Insights",
"displayTitle": "Organization permissions for \"API Insights\"", "displayTitle": "Organization permissions for \"API Insights\"",

View File

@@ -2564,6 +2564,60 @@
"verb": "get", "verb": "get",
"requestPath": "/enterprise-installation/{enterprise_or_org}/server-statistics" "requestPath": "/enterprise-installation/{enterprise_or_org}/server-statistics"
}, },
{
"slug": "get-enterprise-owned-organizations-that-can-have-github-apps-installed",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations"
},
{
"slug": "get-repositories-belonging-to-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations/{org}/accessible_repositories"
},
{
"slug": "list-github-apps-installed-on-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations"
},
{
"slug": "install-a-github-app-on-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "post",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations"
},
{
"slug": "uninstall-a-github-app-from-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "delete",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}"
},
{
"slug": "get-the-repositories-accessible-to-a-given-github-app-installation",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories"
},
{
"slug": "toggle-installation-repository-access-between-selected-and-all-repositories",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories"
},
{
"slug": "grant-repository-access-to-an-organization-installation",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/add"
},
{
"slug": "remove-repository-access-from-an-organization-installation",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/remove"
},
{ {
"slug": "get-the-audit-log-for-an-enterprise", "slug": "get-the-audit-log-for-an-enterprise",
"subcategory": "audit-log", "subcategory": "audit-log",

View File

@@ -209,6 +209,172 @@
} }
] ]
}, },
"enterprise_organization_installation_repositories": {
"title": "Enterprise organization installation repositories",
"displayTitle": "Enterprise permissions for \"Enterprise organization installation repositories\"",
"permissions": [
{
"category": "enterprise-admin",
"slug": "get-repositories-belonging-to-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations/{org}/accessible_repositories",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": true
},
{
"category": "enterprise-admin",
"slug": "get-the-repositories-accessible-to-a-given-github-app-installation",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": true
},
{
"category": "enterprise-admin",
"slug": "toggle-installation-repository-access-between-selected-and-all-repositories",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": true
},
{
"category": "enterprise-admin",
"slug": "grant-repository-access-to-an-organization-installation",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/add",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": true
},
{
"category": "enterprise-admin",
"slug": "remove-repository-access-from-an-organization-installation",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/remove",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": true
}
]
},
"enterprise_organization_installations": {
"title": "Enterprise organization installations",
"displayTitle": "Enterprise permissions for \"Enterprise organization installations\"",
"permissions": [
{
"category": "enterprise-admin",
"slug": "get-enterprise-owned-organizations-that-can-have-github-apps-installed",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "enterprise-admin",
"slug": "get-repositories-belonging-to-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations/{org}/accessible_repositories",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": true
},
{
"category": "enterprise-admin",
"slug": "list-github-apps-installed-on-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "enterprise-admin",
"slug": "install-a-github-app-on-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "post",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "enterprise-admin",
"slug": "uninstall-a-github-app-from-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "delete",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "enterprise-admin",
"slug": "get-the-repositories-accessible-to-a-given-github-app-installation",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": true
},
{
"category": "enterprise-admin",
"slug": "toggle-installation-repository-access-between-selected-and-all-repositories",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": true
},
{
"category": "enterprise-admin",
"slug": "grant-repository-access-to-an-organization-installation",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/add",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": true
},
{
"category": "enterprise-admin",
"slug": "remove-repository-access-from-an-organization-installation",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/remove",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": true
}
]
},
"organization_api_insights": { "organization_api_insights": {
"title": "API Insights", "title": "API Insights",
"displayTitle": "Organization permissions for \"API Insights\"", "displayTitle": "Organization permissions for \"API Insights\"",

View File

@@ -2292,6 +2292,60 @@
"verb": "get", "verb": "get",
"requestPath": "/enterprise-installation/{enterprise_or_org}/server-statistics" "requestPath": "/enterprise-installation/{enterprise_or_org}/server-statistics"
}, },
{
"slug": "get-enterprise-owned-organizations-that-can-have-github-apps-installed",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations"
},
{
"slug": "get-repositories-belonging-to-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations/{org}/accessible_repositories"
},
{
"slug": "list-github-apps-installed-on-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations"
},
{
"slug": "install-a-github-app-on-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "post",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations"
},
{
"slug": "uninstall-a-github-app-from-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "delete",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}"
},
{
"slug": "get-the-repositories-accessible-to-a-given-github-app-installation",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories"
},
{
"slug": "toggle-installation-repository-access-between-selected-and-all-repositories",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories"
},
{
"slug": "grant-repository-access-to-an-organization-installation",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/add"
},
{
"slug": "remove-repository-access-from-an-organization-installation",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/remove"
},
{ {
"slug": "get-the-audit-log-for-an-enterprise", "slug": "get-the-audit-log-for-an-enterprise",
"subcategory": "audit-log", "subcategory": "audit-log",

View File

@@ -2564,6 +2564,60 @@
"verb": "get", "verb": "get",
"requestPath": "/enterprise-installation/{enterprise_or_org}/server-statistics" "requestPath": "/enterprise-installation/{enterprise_or_org}/server-statistics"
}, },
{
"slug": "get-enterprise-owned-organizations-that-can-have-github-apps-installed",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations"
},
{
"slug": "get-repositories-belonging-to-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations/{org}/accessible_repositories"
},
{
"slug": "list-github-apps-installed-on-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations"
},
{
"slug": "install-a-github-app-on-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "post",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations"
},
{
"slug": "uninstall-a-github-app-from-an-enterprise-owned-organization",
"subcategory": "organization-installations",
"verb": "delete",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}"
},
{
"slug": "get-the-repositories-accessible-to-a-given-github-app-installation",
"subcategory": "organization-installations",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories"
},
{
"slug": "toggle-installation-repository-access-between-selected-and-all-repositories",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories"
},
{
"slug": "grant-repository-access-to-an-organization-installation",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/add"
},
{
"slug": "remove-repository-access-from-an-organization-installation",
"subcategory": "organization-installations",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/remove"
},
{ {
"slug": "get-the-audit-log-for-an-enterprise", "slug": "get-the-audit-log-for-an-enterprise",
"subcategory": "audit-log", "subcategory": "audit-log",

View File

@@ -60,5 +60,5 @@
"2022-11-28" "2022-11-28"
] ]
}, },
"sha": "c52348cd88be16e613e49c26b39d2653e20b817d" "sha": "527d41e4237d9ad0bac93932fe1d2fb22f8d1b97"
} }

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -954,7 +954,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise administration\" enterprise permissions": "write" "\"Enterprise administration\" enterprise permissions": "write"
@@ -1030,7 +1030,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise administration\" enterprise permissions": "write" "\"Enterprise administration\" enterprise permissions": "write"
@@ -1123,7 +1123,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise administration\" enterprise permissions": "write" "\"Enterprise administration\" enterprise permissions": "write"
@@ -92729,6 +92729,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -93811,6 +93817,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -94536,7 +94548,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>", "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -96655,7 +96667,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>", "descriptionHTML": "<p>Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -99158,6 +99170,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -100245,6 +100263,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -101330,6 +101354,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -103685,6 +103715,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -210889,7 +210925,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "read" "\"Enterprise SCIM\" enterprise permissions": "read"
@@ -211249,7 +211285,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -211542,7 +211578,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "read" "\"Enterprise SCIM\" enterprise permissions": "read"
@@ -211859,7 +211895,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -212399,7 +212435,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -212912,7 +212948,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -213036,7 +213072,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "read" "\"Enterprise SCIM\" enterprise permissions": "read"
@@ -213577,7 +213613,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -214294,7 +214330,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "read" "\"Enterprise SCIM\" enterprise permissions": "read"
@@ -214795,7 +214831,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -215233,7 +215269,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -216241,7 +216277,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -335685,6 +335721,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -340459,7 +340501,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.</p>", "descriptionHTML": "<p>Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -341443,7 +341485,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>In order to remove a user's membership with an organization, the authenticated user must be an organization owner.</p>\n<p>If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.</p>", "descriptionHTML": "<p>In order to remove a user's membership with an organization, the authenticated user must be an organization owner.</p>\n<p>If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",

View File

@@ -954,7 +954,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise administration\" enterprise permissions": "write" "\"Enterprise administration\" enterprise permissions": "write"
@@ -1030,7 +1030,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise administration\" enterprise permissions": "write" "\"Enterprise administration\" enterprise permissions": "write"
@@ -1123,7 +1123,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise administration\" enterprise permissions": "write" "\"Enterprise administration\" enterprise permissions": "write"
@@ -93053,6 +93053,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -94143,6 +94149,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -94876,7 +94888,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>", "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -97012,7 +97024,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>", "descriptionHTML": "<p>Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -99538,6 +99550,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -100633,6 +100651,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -101726,6 +101750,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -104089,6 +104119,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -213786,7 +213822,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "read" "\"Enterprise SCIM\" enterprise permissions": "read"
@@ -214146,7 +214182,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -214439,7 +214475,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "read" "\"Enterprise SCIM\" enterprise permissions": "read"
@@ -214756,7 +214792,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -215296,7 +215332,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -215809,7 +215845,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -215933,7 +215969,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "read" "\"Enterprise SCIM\" enterprise permissions": "read"
@@ -216474,7 +216510,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -217191,7 +217227,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "read" "\"Enterprise SCIM\" enterprise permissions": "read"
@@ -217692,7 +217728,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -218130,7 +218166,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -219138,7 +219174,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -339006,6 +339042,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -343788,7 +343830,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.</p>", "descriptionHTML": "<p>Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -344772,7 +344814,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>In order to remove a user's membership with an organization, the authenticated user must be an organization owner.</p>\n<p>If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.</p>", "descriptionHTML": "<p>In order to remove a user's membership with an organization, the authenticated user must be an organization owner.</p>\n<p>If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",

View File

@@ -954,7 +954,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise administration\" enterprise permissions": "write" "\"Enterprise administration\" enterprise permissions": "write"
@@ -1030,7 +1030,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise administration\" enterprise permissions": "write" "\"Enterprise administration\" enterprise permissions": "write"
@@ -1123,7 +1123,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise administration\" enterprise permissions": "write" "\"Enterprise administration\" enterprise permissions": "write"
@@ -1228,13 +1228,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -1554,13 +1554,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets GitHub Actions cache usage policy for a repository.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets GitHub Actions cache usage policy for a repository.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -13114,13 +13114,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists self-hosted runners that are in a specific organization group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists self-hosted runners that are in a specific organization group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -16058,13 +16058,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>Example using remove token:</p>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>Example using remove token:</p>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -19923,13 +19923,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -22428,13 +22428,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>For example, you can replace <code>TOKEN</code> in the following example with the registration token provided by this endpoint to configure your self-hosted runner:</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>\n<p>Authenticated users must have admin access to the repository to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>For example, you can replace <code>TOKEN</code> in the following example with the registration token provided by this endpoint to configure your self-hosted runner:</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>\n<p>Authenticated users must have admin access to the repository to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -24719,13 +24719,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all organization variables.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists all organization variables.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -80978,13 +80978,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: <a href=\"https://github.com/notifications\">https://github.com/notifications</a>.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No content</p>" "description": "<p>No content</p>"
} }
], ]
"descriptionHTML": "<p>Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: <a href=\"https://github.com/notifications\">https://github.com/notifications</a>.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -93053,6 +93053,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -94151,6 +94157,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -94892,7 +94904,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.16/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>", "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.16/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -97045,7 +97057,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.16/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>", "descriptionHTML": "<p>Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.16/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -99588,6 +99600,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -100691,6 +100709,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -101792,6 +101816,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -104163,6 +104193,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -126176,13 +126212,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -196284,13 +196320,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Create a new snapshot of a repository's dependencies.</p>\n<p>The authenticated user must have access to the repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>Create a new snapshot of a repository's dependencies.</p>\n<p>The authenticated user must have access to the repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
} }
], ],
"sboms": [ "sboms": [
@@ -196786,13 +196822,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -198058,13 +198094,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Simple filtering of deployments is available via query parameters:</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Simple filtering of deployments is available via query parameters:</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -212426,13 +212462,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -212891,13 +212927,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Note that this API call does not automatically initiate an LDAP sync. Rather, if a <code>201</code> is returned, the sync job is queued successfully, and is performed when the instance is ready.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>Note that this API call does not automatically initiate an LDAP sync. Rather, if a <code>201</code> is returned, the sync job is queued successfully, and is performed when the instance is ready.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -218970,7 +219006,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "read" "\"Enterprise SCIM\" enterprise permissions": "read"
@@ -219330,7 +219366,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -219623,7 +219659,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "read" "\"Enterprise SCIM\" enterprise permissions": "read"
@@ -219940,7 +219976,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -220480,7 +220516,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -220993,7 +221029,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -221117,7 +221153,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "read" "\"Enterprise SCIM\" enterprise permissions": "read"
@@ -221658,7 +221694,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -222375,7 +222411,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "read" "\"Enterprise SCIM\" enterprise permissions": "read"
@@ -222876,7 +222912,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -223314,7 +223350,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -224322,7 +224358,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -344323,6 +344359,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -349113,7 +349155,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.</p>", "descriptionHTML": "<p>Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -350097,7 +350139,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>In order to remove a user's membership with an organization, the authenticated user must be an organization owner.</p>\n<p>If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.</p>", "descriptionHTML": "<p>In order to remove a user's membership with an organization, the authenticated user must be an organization owner.</p>\n<p>If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -418020,13 +418062,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the <a href=\"https://docs.github.com/enterprise-server@3.16/rest/pulls/reviews#list-reviews-for-a-pull-request\">List reviews for a pull request</a> operation.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the <a href=\"https://docs.github.com/enterprise-server@3.16/rest/pulls/reviews#list-reviews-for-a-pull-request\">List reviews for a pull request</a> operation.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -433971,13 +434013,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussions#get-a-discussion\">team discussion</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussions#get-a-discussion\">team discussion</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -440439,13 +440481,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n</div>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussions#get-a-discussion\">team discussion</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n</div>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussions#get-a-discussion\">team discussion</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -443218,13 +443260,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>View the latest published full release for the repository.</p>\n<p>The latest release is the most recent non-prerelease, non-draft release, sorted by the <code>created_at</code> attribute. The <code>created_at</code> attribute is the date of the commit used for the release, and not the date when the release was drafted or published.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>View the latest published full release for the repository.</p>\n<p>The latest release is the most recent non-prerelease, non-draft release, sorted by the <code>created_at</code> attribute. The <code>created_at</code> attribute is the date of the commit used for the release, and not the date when the release was drafted or published.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -463915,13 +463957,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -531654,13 +531696,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Get a specific comment on a team discussion.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Get a specific comment on a team discussion.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -537954,13 +537996,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussions#update-a-discussion\">Update a discussion</a> endpoint.</p>\n</div>\n<p>Edits the title and body text of a discussion post. Only the parameters you provide are updated.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussions#update-a-discussion\">Update a discussion</a> endpoint.</p>\n</div>\n<p>Edits the title and body text of a discussion post. Only the parameters you provide are updated.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",

View File

@@ -954,7 +954,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise administration\" enterprise permissions": "write" "\"Enterprise administration\" enterprise permissions": "write"
@@ -1000,13 +1000,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the total GitHub Actions cache usage for an enterprise.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Gets the total GitHub Actions cache usage for an enterprise.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -1030,7 +1030,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise administration\" enterprise permissions": "write" "\"Enterprise administration\" enterprise permissions": "write"
@@ -1123,7 +1123,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise administration\" enterprise permissions": "write" "\"Enterprise administration\" enterprise permissions": "write"
@@ -2555,13 +2555,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -6431,7 +6431,6 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
@@ -6441,7 +6440,8 @@
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>Response when updating a secret</p>" "description": "<p>Response when updating a secret</p>"
} }
] ],
"descriptionHTML": "<p>Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10618,13 +10618,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
] ],
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10688,13 +10688,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
] ],
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -12820,13 +12820,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-organization\">Create a self-hosted runner group for an organization</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
] ],
"descriptionHTML": "<p>Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-organization\">Create a self-hosted runner group for an organization</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -13365,13 +13365,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
] ],
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
} }
], ],
"self-hosted-runners": [ "self-hosted-runners": [
@@ -17269,13 +17269,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all self-hosted runners configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Lists all self-hosted runners configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -26158,7 +26158,6 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all repositories that can access an organization variable\nthat is available to selected repositories.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -26168,7 +26167,8 @@
"httpStatusCode": "409", "httpStatusCode": "409",
"description": "<p>Response when the visibility of the variable is not set to <code>selected</code></p>" "description": "<p>Response when the visibility of the variable is not set to <code>selected</code></p>"
} }
] ],
"descriptionHTML": "<p>Lists all repositories that can access an organization variable\nthat is available to selected repositories.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -27265,13 +27265,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all environment variables.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Lists all environment variables.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -93245,6 +93245,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -94343,6 +94349,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -95084,7 +95096,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>", "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -97237,7 +97249,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>", "descriptionHTML": "<p>Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -99780,6 +99792,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -100883,6 +100901,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -101984,6 +102008,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -103871,13 +103901,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/apps/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
] ],
"descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/apps/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -104355,6 +104385,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -167279,7 +167315,6 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists the repositories associated with a code security configuration in an organization.</p>\n<p>The authenticated user must be an administrator or security manager for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -167293,7 +167328,8 @@
"httpStatusCode": "404", "httpStatusCode": "404",
"description": "<p>Resource not found</p>" "description": "<p>Resource not found</p>"
} }
] ],
"descriptionHTML": "<p>Lists the repositories associated with a code security configuration in an organization.</p>\n<p>The authenticated user must be an administrator or security manager for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -194285,13 +194321,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all secrets available in an organization without revealing their\nencrypted values.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Lists all secrets available in an organization without revealing their\nencrypted values.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -204098,13 +204134,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/enterprise-server@3.17/rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>List of deployment protection rules</p>" "description": "<p>List of deployment protection rules</p>"
} }
] ],
"descriptionHTML": "<p>Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/enterprise-server@3.17/rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -209654,13 +209690,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -209717,13 +209753,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -210110,13 +210146,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -210295,13 +210331,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": ""
} }
], ],
"announcement": [ "announcement": [
@@ -212255,13 +212291,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Deletes an existing audit log stream configuration for an enterprise.</p>\n<p>When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"<a href=\"/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>The audit log stream configuration was deleted successfully.</p>" "description": "<p>The audit log stream configuration was deleted successfully.</p>"
} }
] ],
"descriptionHTML": "<p>Deletes an existing audit log stream configuration for an enterprise.</p>\n<p>When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"<a href=\"/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>"
} }
], ],
"billing": [ "billing": [
@@ -217330,13 +217366,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removes any overrides for this hook at the org level for this org.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Removes any overrides for this hook at the org level for this org.</p>"
} }
], ],
"orgs": [ "orgs": [
@@ -217510,13 +217546,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
] ],
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -218585,13 +218621,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -219683,13 +219719,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Deletes any overridden enforcement on this repository for the specified hook.</p>\n<p>Responds with effective values inherited from owner and/or global level.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>Responds with effective values inherited from owner and/or global level.</p>" "description": "<p>Responds with effective values inherited from owner and/or global level.</p>"
} }
] ],
"descriptionHTML": "<p>Deletes any overridden enforcement on this repository for the specified hook.</p>\n<p>Responds with effective values inherited from owner and/or global level.</p>"
} }
], ],
"scim": [ "scim": [
@@ -219772,7 +219808,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "read" "\"Enterprise SCIM\" enterprise permissions": "read"
@@ -220132,7 +220168,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -220425,7 +220461,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "read" "\"Enterprise SCIM\" enterprise permissions": "read"
@@ -220742,7 +220778,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -221282,7 +221318,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -221795,7 +221831,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -221919,7 +221955,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "read" "\"Enterprise SCIM\" enterprise permissions": "read"
@@ -222460,7 +222496,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -223177,7 +223213,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "read" "\"Enterprise SCIM\" enterprise permissions": "read"
@@ -223678,7 +223714,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -224116,7 +224152,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -225124,7 +225160,7 @@
"progAccess": { "progAccess": {
"userToServerRest": true, "userToServerRest": true,
"serverToServer": true, "serverToServer": true,
"fineGrainedPat": true, "fineGrainedPat": false,
"permissions": [ "permissions": [
{ {
"\"Enterprise SCIM\" enterprise permissions": "write" "\"Enterprise SCIM\" enterprise permissions": "write"
@@ -342577,7 +342613,6 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.17/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.17/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.17/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n</div>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>You can only send one of these scope keys at a time.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -342587,7 +342622,8 @@
"httpStatusCode": "422", "httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>" "description": "<p>Validation failed, or the endpoint has been spammed.</p>"
} }
] ],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.17/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.17/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.17/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n</div>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>You can only send one of these scope keys at a time.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -345261,6 +345297,12 @@
1 1
] ]
}, },
"client_id": {
"type": "string",
"examples": [
"Iv1.ab1112223334445c"
]
},
"target_id": { "target_id": {
"description": "The ID of the user or organization this token is being scoped to.", "description": "The ID of the user or organization this token is being scoped to.",
"type": "integer" "type": "integer"
@@ -350496,7 +350538,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.</p>", "descriptionHTML": "<p>Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -351480,7 +351522,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>In order to remove a user's membership with an organization, the authenticated user must be an organization owner.</p>\n<p>If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.</p>", "descriptionHTML": "<p>In order to remove a user's membership with an organization, the authenticated user must be an organization owner.</p>\n<p>If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -375398,13 +375440,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets a specific package version in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Gets a specific package version in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -466300,13 +466342,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -504209,13 +504251,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:repo_hook</code> or <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:repo_hook</code> or <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -526034,13 +526076,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>To delete a team, the authenticated user must be an organization owner or team maintainer.</p>\n<p>If you are an organization owner, deleting a parent team will delete all of its child teams as well.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}</code>.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
] ],
"descriptionHTML": "<p>To delete a team, the authenticated user must be an organization owner or team maintainer.</p>\n<p>If you are an organization owner, deleting a parent team will delete all of its child teams as well.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}</code>.</p>\n</div>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -541862,13 +541904,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Delete a discussion from a team's page.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
] ],
"descriptionHTML": "<p>Delete a discussion from a team's page.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",

View File

@@ -47,5 +47,5 @@
] ]
} }
}, },
"sha": "c52348cd88be16e613e49c26b39d2653e20b817d" "sha": "527d41e4237d9ad0bac93932fe1d2fb22f8d1b97"
} }

View File

@@ -1,3 +1,3 @@
{ {
"sha": "c52348cd88be16e613e49c26b39d2653e20b817d" "sha": "527d41e4237d9ad0bac93932fe1d2fb22f8d1b97"
} }