Skip to content

Commit 2ae3d74

Browse files
docs-botN-UshaCopilotsaritai
authored
Update OpenAPI Description (#55442)
Co-authored-by: Usha N <n-usha@github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com>
1 parent 3049b5c commit 2ae3d74

File tree

19 files changed

+283
-20
lines changed

19 files changed

+283
-20
lines changed

‎content/rest/credentials/index.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Credentials
3+
topics:
4+
- API
5+
autogenerated: rest
6+
allowTitleToDifferFromFilename: true
7+
children:
8+
- /revoke
9+
versions:
10+
fpt: '*'
11+
ghec: '*'
12+
---
13+

‎content/rest/credentials/revoke.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Revocation
3+
shortTitle: Revocation
4+
intro: Use the REST API to revoke credentials that you have found exposed on {% data variables.product.github %} or elsewhere.
5+
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
6+
fpt: '*'
7+
ghec: '*'
8+
topics:
9+
- API
10+
autogenerated: rest
11+
allowTitleToDifferFromFilename: true
12+
---
13+
14+
<!-- Content after this section is automatically generated -->

‎content/rest/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ children:
5656
- /collaborators
5757
- /commits
5858
- /copilot
59+
- /credentials
5960
- /dependabot
6061
- /dependency-graph
6162
- /deploy-keys

‎src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json

+8
Original file line numberDiff line numberDiff line change
@@ -2171,6 +2171,14 @@
21712171
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
21722172
}
21732173
],
2174+
"credentials": [
2175+
{
2176+
"slug": "revoke-a-list-of-credentials",
2177+
"subcategory": "revoke",
2178+
"verb": "post",
2179+
"requestPath": "/credentials/revoke"
2180+
}
2181+
],
21742182
"dependabot": [
21752183
{
21762184
"slug": "list-dependabot-alerts-for-an-organization",

‎src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json

+8
Original file line numberDiff line numberDiff line change
@@ -1905,6 +1905,14 @@
19051905
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
19061906
}
19071907
],
1908+
"credentials": [
1909+
{
1910+
"slug": "revoke-a-list-of-credentials",
1911+
"subcategory": "revoke",
1912+
"verb": "post",
1913+
"requestPath": "/credentials/revoke"
1914+
}
1915+
],
19081916
"dependabot": [
19091917
{
19101918
"slug": "list-dependabot-alerts-for-an-organization",

‎src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json

+8
Original file line numberDiff line numberDiff line change
@@ -2171,6 +2171,14 @@
21712171
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
21722172
}
21732173
],
2174+
"credentials": [
2175+
{
2176+
"slug": "revoke-a-list-of-credentials",
2177+
"subcategory": "revoke",
2178+
"verb": "post",
2179+
"requestPath": "/credentials/revoke"
2180+
}
2181+
],
21742182
"dependabot": [
21752183
{
21762184
"slug": "list-dependabot-alerts-for-an-organization",

‎src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json

+8
Original file line numberDiff line numberDiff line change
@@ -2209,6 +2209,14 @@
22092209
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
22102210
}
22112211
],
2212+
"credentials": [
2213+
{
2214+
"slug": "revoke-a-list-of-credentials",
2215+
"subcategory": "revoke",
2216+
"verb": "post",
2217+
"requestPath": "/credentials/revoke"
2218+
}
2219+
],
22122220
"dependabot": [
22132221
{
22142222
"slug": "list-dependabot-alerts-for-an-organization",

‎src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json

+8
Original file line numberDiff line numberDiff line change
@@ -1943,6 +1943,14 @@
19431943
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
19441944
}
19451945
],
1946+
"credentials": [
1947+
{
1948+
"slug": "revoke-a-list-of-credentials",
1949+
"subcategory": "revoke",
1950+
"verb": "post",
1951+
"requestPath": "/credentials/revoke"
1952+
}
1953+
],
19461954
"dependabot": [
19471955
{
19481956
"slug": "list-dependabot-alerts-for-an-organization",

‎src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json

+8
Original file line numberDiff line numberDiff line change
@@ -2209,6 +2209,14 @@
22092209
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
22102210
}
22112211
],
2212+
"credentials": [
2213+
{
2214+
"slug": "revoke-a-list-of-credentials",
2215+
"subcategory": "revoke",
2216+
"verb": "post",
2217+
"requestPath": "/credentials/revoke"
2218+
}
2219+
],
22122220
"dependabot": [
22132221
{
22142222
"slug": "list-dependabot-alerts-for-an-organization",

‎src/github-apps/lib/config.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@
6060
"2022-11-28"
6161
]
6262
},
63-
"sha": "8af3e59120fdf6294e2d385bdae74b39fa824da5"
63+
"sha": "e7a314cf1c452fbcf55e3be650f1bb7363cad424"
6464
}

‎src/rest/data/fpt-2022-11-28/schema.json

+74-2
Original file line numberDiff line numberDiff line change
@@ -243374,6 +243374,76 @@
243374243374
}
243375243375
]
243376243376
},
243377+
"credentials": {
243378+
"revoke": [
243379+
{
243380+
"serverUrl": "https://api.github.com",
243381+
"verb": "post",
243382+
"requestPath": "/credentials/revoke",
243383+
"title": "Revoke a list of credentials",
243384+
"category": "credentials",
243385+
"subcategory": "revoke",
243386+
"parameters": [],
243387+
"bodyParameters": [
243388+
{
243389+
"type": "array of strings",
243390+
"name": "credentials",
243391+
"in": "body",
243392+
"description": "<p>A list of credentials to be revoked, up to 1000 per request.</p>",
243393+
"isRequired": true
243394+
}
243395+
],
243396+
"progAccess": {
243397+
"userToServerRest": true,
243398+
"serverToServer": true,
243399+
"fineGrainedPat": true,
243400+
"permissions": [],
243401+
"allowPermissionlessAccess": true
243402+
},
243403+
"codeExamples": [
243404+
{
243405+
"key": "default",
243406+
"request": {
243407+
"contentType": "application/json",
243408+
"description": "Example",
243409+
"acceptHeader": "application/vnd.github.v3+json",
243410+
"bodyParameters": {
243411+
"credentials": [
243412+
"ghp_1234567890abcdef1234567890abcdef12345678",
243413+
"ghp_abcdef1234567890abcdef1234567890abcdef12"
243414+
]
243415+
}
243416+
},
243417+
"response": {
243418+
"statusCode": "202",
243419+
"contentType": "application/json",
243420+
"description": "<p>Accepted</p>",
243421+
"example": null,
243422+
"schema": {
243423+
"type": "object"
243424+
}
243425+
}
243426+
}
243427+
],
243428+
"previews": [],
243429+
"descriptionHTML": "<p>Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation.</p>\n<p>This endpoint currently accepts the following credential types:</p>\n<ul>\n<li>Personal access tokens (classic)</li>\n<li>Fine-grained personal access tokens</li>\n</ul>\n<p>Revoked credentials may impact users on GitHub Free, Pro, &#x26; Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users.\nGitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated.</p>\n<p>To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request.</p>\n<div class=\"ghd-alert ghd-alert-accent\"><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>\nAny authenticated requests will return a 403.</p>\n</div>",
243430+
"statusCodes": [
243431+
{
243432+
"httpStatusCode": "202",
243433+
"description": "<p>Accepted</p>"
243434+
},
243435+
{
243436+
"httpStatusCode": "422",
243437+
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
243438+
},
243439+
{
243440+
"httpStatusCode": "500",
243441+
"description": "<p>Internal Error</p>"
243442+
}
243443+
]
243444+
}
243445+
]
243446+
},
243377243447
"dependabot": {
243378243448
"alerts": [
243379243449
{
@@ -397864,13 +397934,14 @@
397864397934
},
397865397935
{
397866397936
"name": "filter",
397867-
"description": "<p>Filter members returned in the list. <code>2fa_disabled</code> means that only members without <a href=\"https://github.com/blog/1614-two-factor-authentication\">two-factor authentication</a> enabled will be returned. This options is only available for organization owners.</p>",
397937+
"description": "<p>Filter members returned in the list. <code>2fa_disabled</code> means that only members without <a href=\"https://github.com/blog/1614-two-factor-authentication\">two-factor authentication</a> enabled will be returned. <code>2fa_insecure</code> means that only members with <a href=\"https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization\">insecure 2FA methods</a> will be returned. These options are only available for organization owners.</p>",
397868397938
"in": "query",
397869397939
"required": false,
397870397940
"schema": {
397871397941
"type": "string",
397872397942
"enum": [
397873397943
"2fa_disabled",
397944+
"2fa_insecure",
397874397945
"all"
397875397946
],
397876397947
"default": "all"
@@ -403906,13 +403977,14 @@
403906403977
},
403907403978
{
403908403979
"name": "filter",
403909-
"description": "<p>Filter the list of outside collaborators. <code>2fa_disabled</code> means that only outside collaborators without <a href=\"https://github.com/blog/1614-two-factor-authentication\">two-factor authentication</a> enabled will be returned.</p>",
403980+
"description": "<p>Filter the list of outside collaborators. <code>2fa_disabled</code> means that only outside collaborators without <a href=\"https://github.com/blog/1614-two-factor-authentication\">two-factor authentication</a> enabled will be returned. <code>2fa_insecure</code> means that only outside collaborators with <a href=\"https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization\">insecure 2FA methods</a> will be returned.</p>",
403910403981
"in": "query",
403911403982
"required": false,
403912403983
"schema": {
403913403984
"type": "string",
403914403985
"enum": [
403915403986
"2fa_disabled",
403987+
"2fa_insecure",
403916403988
"all"
403917403989
],
403918403990
"default": "all"

0 commit comments

Comments
 (0)