diff --git a/content/rest/credentials/index.md b/content/rest/credentials/index.md new file mode 100644 index 0000000000..37f896f675 --- /dev/null +++ b/content/rest/credentials/index.md @@ -0,0 +1,13 @@ +--- +title: Credentials +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +children: + - /revoke +versions: + fpt: '*' + ghec: '*' +--- + diff --git a/content/rest/credentials/revoke.md b/content/rest/credentials/revoke.md new file mode 100644 index 0000000000..95189d73af --- /dev/null +++ b/content/rest/credentials/revoke.md @@ -0,0 +1,14 @@ +--- +title: Revocation +shortTitle: Revocation +intro: Use the REST API to revoke credentials that you have found exposed on {% data variables.product.github %} or elsewhere. +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +--- + + diff --git a/content/rest/index.md b/content/rest/index.md index 023563063a..9ff5868af1 100644 --- a/content/rest/index.md +++ b/content/rest/index.md @@ -56,6 +56,7 @@ children: - /collaborators - /commits - /copilot + - /credentials - /dependabot - /dependency-graph - /deploy-keys diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json index b84783cdde..1428cda1aa 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json @@ -2171,6 +2171,14 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "credentials": [ + { + "slug": "revoke-a-list-of-credentials", + "subcategory": "revoke", + "verb": "post", + "requestPath": "/credentials/revoke" + } + ], "dependabot": [ { "slug": "list-dependabot-alerts-for-an-organization", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index a278f4a098..92ba9e964e 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -1905,6 +1905,14 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "credentials": [ + { + "slug": "revoke-a-list-of-credentials", + "subcategory": "revoke", + "verb": "post", + "requestPath": "/credentials/revoke" + } + ], "dependabot": [ { "slug": "list-dependabot-alerts-for-an-organization", diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json index b84783cdde..1428cda1aa 100644 --- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json @@ -2171,6 +2171,14 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "credentials": [ + { + "slug": "revoke-a-list-of-credentials", + "subcategory": "revoke", + "verb": "post", + "requestPath": "/credentials/revoke" + } + ], "dependabot": [ { "slug": "list-dependabot-alerts-for-an-organization", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index fd6e89ba4d..e0a5b70275 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -2209,6 +2209,14 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "credentials": [ + { + "slug": "revoke-a-list-of-credentials", + "subcategory": "revoke", + "verb": "post", + "requestPath": "/credentials/revoke" + } + ], "dependabot": [ { "slug": "list-dependabot-alerts-for-an-organization", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index bf50fed338..27836fbacc 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -1943,6 +1943,14 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "credentials": [ + { + "slug": "revoke-a-list-of-credentials", + "subcategory": "revoke", + "verb": "post", + "requestPath": "/credentials/revoke" + } + ], "dependabot": [ { "slug": "list-dependabot-alerts-for-an-organization", diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index fd6e89ba4d..e0a5b70275 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -2209,6 +2209,14 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" } ], + "credentials": [ + { + "slug": "revoke-a-list-of-credentials", + "subcategory": "revoke", + "verb": "post", + "requestPath": "/credentials/revoke" + } + ], "dependabot": [ { "slug": "list-dependabot-alerts-for-an-organization", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 1d00060c52..d5b0747c89 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "8af3e59120fdf6294e2d385bdae74b39fa824da5" + "sha": "e7a314cf1c452fbcf55e3be650f1bb7363cad424" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index b5ef6363e9..3f796952b2 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -243374,6 +243374,76 @@ } ] }, + "credentials": { + "revoke": [ + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/credentials/revoke", + "title": "Revoke a list of credentials", + "category": "credentials", + "subcategory": "revoke", + "parameters": [], + "bodyParameters": [ + { + "type": "array of strings", + "name": "credentials", + "in": "body", + "description": "

A list of credentials to be revoked, up to 1000 per request.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [], + "allowPermissionlessAccess": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "credentials": [ + "ghp_1234567890abcdef1234567890abcdef12345678", + "ghp_abcdef1234567890abcdef1234567890abcdef12" + ] + } + }, + "response": { + "statusCode": "202", + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } + } + } + ], + "previews": [], + "descriptionHTML": "

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.

\n

This endpoint currently accepts the following credential types:

\n\n

Revoked credentials may impact users on GitHub Free, Pro, & 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.

\n

To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request.

\n

Note

\n

\nAny authenticated requests will return a 403.

\n
", + "statusCodes": [ + { + "httpStatusCode": "202", + "description": "

Accepted

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + }, + { + "httpStatusCode": "500", + "description": "

Internal Error

" + } + ] + } + ] + }, "dependabot": { "alerts": [ { @@ -397864,13 +397934,14 @@ }, { "name": "filter", - "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. This options is only available for organization owners.

", + "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. 2fa_insecure means that only members with insecure 2FA methods will be returned. These options are only available for organization owners.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2fa_disabled", + "2fa_insecure", "all" ], "default": "all" @@ -403906,13 +403977,14 @@ }, { "name": "filter", - "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned.

", + "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned. 2fa_insecure means that only outside collaborators with insecure 2FA methods will be returned.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2fa_disabled", + "2fa_insecure", "all" ], "default": "all" diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 56cecd50d9..afcd22afbd 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -256694,6 +256694,76 @@ } ] }, + "credentials": { + "revoke": [ + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/credentials/revoke", + "title": "Revoke a list of credentials", + "category": "credentials", + "subcategory": "revoke", + "parameters": [], + "bodyParameters": [ + { + "type": "array of strings", + "name": "credentials", + "in": "body", + "description": "

A list of credentials to be revoked, up to 1000 per request.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [], + "allowPermissionlessAccess": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "credentials": [ + "ghp_1234567890abcdef1234567890abcdef12345678", + "ghp_abcdef1234567890abcdef1234567890abcdef12" + ] + } + }, + "response": { + "statusCode": "202", + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } + } + } + ], + "previews": [], + "descriptionHTML": "

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.

\n

This endpoint currently accepts the following credential types:

\n\n

Revoked credentials may impact users on GitHub Free, Pro, & 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.

\n

To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request.

\n

Note

\n

\nAny authenticated requests will return a 403.

\n
", + "statusCodes": [ + { + "httpStatusCode": "202", + "description": "

Accepted

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + }, + { + "httpStatusCode": "500", + "description": "

Internal Error

" + } + ] + } + ] + }, "dependabot": { "alerts": [ { @@ -434268,13 +434338,14 @@ }, { "name": "filter", - "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. This options is only available for organization owners.

", + "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. 2fa_insecure means that only members with insecure 2FA methods will be returned. These options are only available for organization owners.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2fa_disabled", + "2fa_insecure", "all" ], "default": "all" @@ -441249,13 +441320,14 @@ }, { "name": "filter", - "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned.

", + "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned. 2fa_insecure means that only outside collaborators with insecure 2FA methods will be returned.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2fa_disabled", + "2fa_insecure", "all" ], "default": "all" @@ -609336,7 +609408,8 @@ "data": [ { "secret_type": "adafruit_io_key", - "alert_number": 17 + "alert_number": 17, + "reason": "false_positive" } ], "resource_identifier": 17, @@ -609482,6 +609555,16 @@ "alert_number": { "type": "string", "description": "The number of the secret scanning alert that was detected." + }, + "reason": { + "type": "string", + "description": "The reason the user provided for requesting the dismissal.", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] } } } @@ -609755,7 +609838,8 @@ "data": [ { "secret_type": "adafruit_io_key", - "alert_number": 17 + "alert_number": 17, + "reason": "false_positive" } ], "resource_identifier": 17, @@ -609901,6 +609985,16 @@ "alert_number": { "type": "string", "description": "The number of the secret scanning alert that was detected." + }, + "reason": { + "type": "string", + "description": "The reason the user provided for requesting the dismissal.", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] } } } @@ -610112,7 +610206,8 @@ "data": [ { "secret_type": "adafruit_io_key", - "alert_number": 17 + "alert_number": 17, + "reason": "false_positive" } ], "resource_identifier": 17, @@ -610213,6 +610308,16 @@ "alert_number": { "type": "string", "description": "The number of the secret scanning alert that was detected." + }, + "reason": { + "type": "string", + "description": "The reason the user provided for requesting the dismissal.", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] } } } diff --git a/src/rest/data/ghes-3.12-2022-11-28/schema.json b/src/rest/data/ghes-3.12-2022-11-28/schema.json index 52d1362b66..423446f67f 100644 --- a/src/rest/data/ghes-3.12-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.12-2022-11-28/schema.json @@ -340183,13 +340183,14 @@ }, { "name": "filter", - "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. This options is only available for organization owners.

", + "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. 2fa_insecure means that only members with insecure 2FA methods will be returned. These options are only available for organization owners.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2fa_disabled", + "2fa_insecure", "all" ], "default": "all" @@ -343490,13 +343491,14 @@ }, { "name": "filter", - "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned.

", + "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned. 2fa_insecure means that only outside collaborators with insecure 2FA methods will be returned.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2fa_disabled", + "2fa_insecure", "all" ], "default": "all" diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json index 5dca57af5a..290538c6c1 100644 --- a/src/rest/data/ghes-3.13-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.13-2022-11-28/schema.json @@ -341762,13 +341762,14 @@ }, { "name": "filter", - "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. This options is only available for organization owners.

", + "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. 2fa_insecure means that only members with insecure 2FA methods will be returned. These options are only available for organization owners.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2fa_disabled", + "2fa_insecure", "all" ], "default": "all" @@ -345069,13 +345070,14 @@ }, { "name": "filter", - "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned.

", + "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned. 2fa_insecure means that only outside collaborators with insecure 2FA methods will be returned.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2fa_disabled", + "2fa_insecure", "all" ], "default": "all" diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index 3a6df35142..1cb18cb24a 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -341774,13 +341774,14 @@ }, { "name": "filter", - "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. This options is only available for organization owners.

", + "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. 2fa_insecure means that only members with insecure 2FA methods will be returned. These options are only available for organization owners.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2fa_disabled", + "2fa_insecure", "all" ], "default": "all" @@ -347926,13 +347927,14 @@ }, { "name": "filter", - "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned.

", + "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned. 2fa_insecure means that only outside collaborators with insecure 2FA methods will be returned.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2fa_disabled", + "2fa_insecure", "all" ], "default": "all" diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index edd1e0e0de..e75a5d670f 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -345103,13 +345103,14 @@ }, { "name": "filter", - "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. This options is only available for organization owners.

", + "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. 2fa_insecure means that only members with insecure 2FA methods will be returned. These options are only available for organization owners.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2fa_disabled", + "2fa_insecure", "all" ], "default": "all" @@ -351282,13 +351283,14 @@ }, { "name": "filter", - "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned.

", + "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned. 2fa_insecure means that only outside collaborators with insecure 2FA methods will be returned.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2fa_disabled", + "2fa_insecure", "all" ], "default": "all" diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index a15af2bd8a..7d5645d636 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -350428,13 +350428,14 @@ }, { "name": "filter", - "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. This options is only available for organization owners.

", + "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. 2fa_insecure means that only members with insecure 2FA methods will be returned. These options are only available for organization owners.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2fa_disabled", + "2fa_insecure", "all" ], "default": "all" @@ -356607,13 +356608,14 @@ }, { "name": "filter", - "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned.

", + "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned. 2fa_insecure means that only outside collaborators with insecure 2FA methods will be returned.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2fa_disabled", + "2fa_insecure", "all" ], "default": "all" diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 0c0ac931a7..7115f6f9db 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -47,5 +47,5 @@ ] } }, - "sha": "8af3e59120fdf6294e2d385bdae74b39fa824da5" + "sha": "e7a314cf1c452fbcf55e3be650f1bb7363cad424" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 474f52a007..0a1f08e172 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "8af3e59120fdf6294e2d385bdae74b39fa824da5" + "sha": "e7a314cf1c452fbcf55e3be650f1bb7363cad424" } \ No newline at end of file