diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 7de9ec9309..f623b04078 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -131058,6 +131058,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -178925,6 +178926,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -179276,6 +179278,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -179650,7 +179653,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -180062,6 +180065,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -180349,7 +180353,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -180657,7 +180661,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -181012,6 +181016,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -191081,7 +191086,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -191153,7 +191158,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 93de2388ed..74874dfd87 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -95482,6 +95482,7 @@ components: - false positive - won't fix - used in tests + - mitigated - code-scanning-alert-dismissed-comment: type: @@ -130358,6 +130359,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130627,6 +130629,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130908,7 +130911,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -131219,6 +131222,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -131440,7 +131444,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - string - 'null' @@ -131680,7 +131684,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -131952,6 +131956,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -139120,7 +139125,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object @@ -139172,7 +139178,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.json b/descriptions-next/api.github.com/api.github.com.2026-03-10.json index 4c96fcc711..5f29b3c8b0 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.json @@ -130494,6 +130494,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -178452,6 +178453,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -178803,6 +178805,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -179177,7 +179180,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -179589,6 +179592,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -179876,7 +179880,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -180184,7 +180188,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -180539,6 +180543,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -190608,7 +190613,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -190680,7 +190685,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml index 7002d32aed..820d3679ff 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml @@ -95063,6 +95063,7 @@ components: - false positive - won't fix - used in tests + - mitigated - code-scanning-alert-dismissed-comment: type: @@ -130014,6 +130015,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130283,6 +130285,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130564,7 +130567,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -130875,6 +130878,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -131096,7 +131100,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - string - 'null' @@ -131336,7 +131340,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -131608,6 +131612,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -138776,7 +138781,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object @@ -138828,7 +138834,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 98beafd16f..cd19e82050 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -131810,6 +131810,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -180197,6 +180198,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -180548,6 +180550,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -180922,7 +180925,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -181334,6 +181337,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -181621,7 +181625,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -181929,7 +181933,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -182284,6 +182288,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -192353,7 +192358,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -192425,7 +192430,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 02f41ccb4e..a0fe292ab1 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -95972,6 +95972,7 @@ components: - false positive - won't fix - used in tests + - mitigated - code-scanning-alert-dismissed-comment: type: @@ -131275,6 +131276,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -131544,6 +131546,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -131825,7 +131828,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -132136,6 +132139,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -132357,7 +132361,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - string - 'null' @@ -132597,7 +132601,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -132869,6 +132873,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -140037,7 +140042,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object @@ -140089,7 +140095,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index b3a97bb718..e0d1b83850 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -123156,6 +123156,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -359542,6 +359543,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -360617,6 +360619,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -365663,6 +365666,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -365971,6 +365975,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -975512,6 +975517,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -977997,6 +978003,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -980340,7 +980347,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -983051,6 +983058,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -985472,7 +985480,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -987912,7 +987920,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -990401,6 +990409,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1119267,7 +1119276,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -1122446,7 +1122455,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 753f17532c..7d635d7572 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -32834,6 +32834,7 @@ paths: - false positive - won't fix - used in tests + - mitigated - dismissed_comment: &434 type: @@ -131031,6 +131032,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -131363,6 +131365,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -131700,8 +131703,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -132066,6 +132069,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -132342,8 +132346,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - string - 'null' @@ -132640,8 +132644,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -132968,6 +132972,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -143718,7 +143723,8 @@ webhooks: - private repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object @@ -143829,7 +143835,8 @@ webhooks: repositories_added: *791 repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 75e4733dcf..cf7dbdc50d 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -118844,6 +118844,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -351832,6 +351833,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -352907,6 +352909,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -357729,6 +357732,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -358037,6 +358041,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -955716,6 +955721,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -958189,6 +958195,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -960520,7 +960527,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -963219,6 +963226,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -965628,7 +965636,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -968056,7 +968064,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -970533,6 +970541,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1098411,7 +1098420,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -1101578,7 +1101587,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index 0a127ff5b6..d30ed7e9c6 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -32478,6 +32478,7 @@ paths: - false positive - won't fix - used in tests + - mitigated - dismissed_comment: &434 type: @@ -130599,6 +130600,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -130931,6 +130933,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -131268,8 +131271,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -131634,6 +131637,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -131910,8 +131914,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - string - 'null' @@ -132208,8 +132212,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -132536,6 +132540,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -143286,7 +143291,8 @@ webhooks: - private repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object @@ -143397,7 +143403,8 @@ webhooks: repositories_added: *791 repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index aa96f0c99c..0d8e9882e8 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -125296,6 +125296,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -367719,6 +367720,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -368794,6 +368796,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -374129,6 +374132,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -374437,6 +374441,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -999113,6 +999118,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1001623,6 +1001629,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1003991,7 +1003998,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1006727,6 +1006734,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1009173,7 +1009181,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -1011638,7 +1011646,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1014152,6 +1014160,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1144654,7 +1144663,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -1147858,7 +1147867,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 9932ba2762..d34c55844f 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -33156,6 +33156,7 @@ paths: - false positive - won't fix - used in tests + - mitigated - dismissed_comment: &434 type: @@ -131996,6 +131997,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -132328,6 +132330,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -132665,8 +132668,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -133031,6 +133034,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -133307,8 +133311,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - string - 'null' @@ -133605,8 +133609,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -133933,6 +133937,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -144683,7 +144688,8 @@ webhooks: - private repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object @@ -144794,7 +144800,8 @@ webhooks: repositories_added: *791 repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index b319fb2728..5ad83742b2 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -42602,6 +42602,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -82587,7 +82588,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": { "get": { "summary": "Get a budget by ID", - "description": "Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.", + "description": "Gets a budget by ID. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -82924,7 +82925,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -83766,7 +83767,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": { "get": { "summary": "Get user states for a multi-user budget", - "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated user must be an enterprise admin or billing manager.", + "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -84025,7 +84026,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -178650,6 +178651,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -202917,6 +202919,309 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -202987,6 +203292,327 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -425397,6 +426023,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -426472,6 +427099,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -431518,6 +432146,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -431826,6 +432455,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1068871,6 +1069501,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1071356,6 +1071987,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1073699,7 +1074331,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1076410,6 +1077042,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1078831,7 +1079464,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -1081271,7 +1081904,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1083760,6 +1084393,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1249718,7 +1250352,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -1252921,7 +1253555,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 32529f3d4f..9c55778438 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -16601,6 +16601,7 @@ paths: - false positive - won't fix - used in tests + - mitigated - dismissed_comment: &568 type: @@ -29437,8 +29438,8 @@ paths: "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID - description: Gets a budget by ID. The authenticated user must be an enterprise - admin or billing manager. + description: Gets a budget by ID. The authenticated actor must have permission + to view enterprise billing. tags: - billing operationId: billing/get-budget @@ -29562,7 +29563,7 @@ paths: '503': *196 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: @@ -29878,7 +29879,7 @@ paths: get: summary: Get user states for a multi-user budget description: Lists per-user budget state for a multi-user customer scoped budget. - The authenticated user must be an enterprise admin or billing manager. + The authenticated actor must have permission to view enterprise billing. tags: - billing operationId: billing/get-budget-user-states @@ -29985,7 +29986,7 @@ paths: '503': *196 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -53916,6 +53917,156 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-all": + post: + summary: Revoke all credential authorizations for an organization + description: |- + Revokes all SAML SSO credential authorizations for every member of the + organization. This removes the sign-in authorizations for personal access + tokens, SSH keys, OAuth app tokens, and user-to-server tokens that members + have authorized for the organization. Members will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, that token's + > authorization for the organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-credential-authorizations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization + parameters: + - *88 + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation has been queued + with_warning: + value: + message: Credential authorization revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-credential-type": + post: + summary: Revoke a single credential type for an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + across the organization. This removes the sign-in authorizations for that + credential type for every member of the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and revoke classic + > personal access tokens, that token's authorization for the organization may + > also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + parameters: + - *88 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke across the organization. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation has been queued + with_warning: + value: + message: Credential type revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: *3 + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/credential-authorizations/{credential_id}": delete: summary: Remove a SAML SSO authorization for an organization @@ -53947,6 +54098,163 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke": + post: + summary: Revoke credential authorizations for a user in an organization + description: |- + Revokes all SAML SSO credential authorizations for a single user within the + organization. This removes the sign-in authorizations for the user's personal + access tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they + have authorized for the organization. The user will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and target yourself, + > that token's authorization for the organization may also be revoked as part of + > this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-authorizations-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization + parameters: + - *88 + - *131 + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + with_warning: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": + post: + summary: Revoke a single credential type for a user in an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + for a single user within the organization. This removes the sign-in authorizations + for that credential type for the user in the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, target yourself, and + > revoke classic personal access tokens, that token's authorization for the + > organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + parameters: + - *88 + - *131 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke for the user. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation for user 'octocat' has been + queued + with_warning: + value: + message: Credential type revocation for user 'octocat' has been + queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: *3 + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/custom-repository-roles": get: summary: List custom repository roles in an organization @@ -149250,6 +149558,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -149582,6 +149891,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -149919,8 +150229,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -150285,6 +150595,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -150561,8 +150872,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - string - 'null' @@ -150859,8 +151170,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -151187,6 +151498,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -162908,7 +163220,8 @@ webhooks: - private repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object @@ -163019,7 +163332,8 @@ webhooks: repositories_added: *933 repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json index 5001190b2d..247699d076 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json @@ -42469,6 +42469,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -82426,7 +82427,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": { "get": { "summary": "Get a budget by ID", - "description": "Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.", + "description": "Gets a budget by ID. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -82763,7 +82764,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -83605,7 +83606,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": { "get": { "summary": "Get user states for a multi-user budget", - "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated user must be an enterprise admin or billing manager.", + "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -83864,7 +83865,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -174051,6 +174052,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -198309,6 +198311,309 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -198379,6 +198684,327 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -417388,6 +418014,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -418463,6 +419090,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -423285,6 +423913,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -423593,6 +424222,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1048704,6 +1049334,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1051177,6 +1051808,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1053508,7 +1054140,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1056207,6 +1056839,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1058616,7 +1059249,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -1061044,7 +1061677,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1063521,6 +1064154,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1228311,7 +1228945,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -1231502,7 +1232136,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml index d6484cfae4..0bc779073e 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml @@ -16549,6 +16549,7 @@ paths: - false positive - won't fix - used in tests + - mitigated - dismissed_comment: &568 type: @@ -29362,8 +29363,8 @@ paths: "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID - description: Gets a budget by ID. The authenticated user must be an enterprise - admin or billing manager. + description: Gets a budget by ID. The authenticated actor must have permission + to view enterprise billing. tags: - billing operationId: billing/get-budget @@ -29487,7 +29488,7 @@ paths: '503': *196 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: @@ -29803,7 +29804,7 @@ paths: get: summary: Get user states for a multi-user budget description: Lists per-user budget state for a multi-user customer scoped budget. - The authenticated user must be an enterprise admin or billing manager. + The authenticated actor must have permission to view enterprise billing. tags: - billing operationId: billing/get-budget-user-states @@ -29910,7 +29911,7 @@ paths: '503': *196 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -53478,6 +53479,156 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-all": + post: + summary: Revoke all credential authorizations for an organization + description: |- + Revokes all SAML SSO credential authorizations for every member of the + organization. This removes the sign-in authorizations for personal access + tokens, SSH keys, OAuth app tokens, and user-to-server tokens that members + have authorized for the organization. Members will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, that token's + > authorization for the organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-credential-authorizations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization + parameters: + - *88 + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation has been queued + with_warning: + value: + message: Credential authorization revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-credential-type": + post: + summary: Revoke a single credential type for an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + across the organization. This removes the sign-in authorizations for that + credential type for every member of the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and revoke classic + > personal access tokens, that token's authorization for the organization may + > also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + parameters: + - *88 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke across the organization. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation has been queued + with_warning: + value: + message: Credential type revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: *3 + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/credential-authorizations/{credential_id}": delete: summary: Remove a SAML SSO authorization for an organization @@ -53509,6 +53660,163 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke": + post: + summary: Revoke credential authorizations for a user in an organization + description: |- + Revokes all SAML SSO credential authorizations for a single user within the + organization. This removes the sign-in authorizations for the user's personal + access tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they + have authorized for the organization. The user will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and target yourself, + > that token's authorization for the organization may also be revoked as part of + > this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-authorizations-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization + parameters: + - *88 + - *131 + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + with_warning: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": + post: + summary: Revoke a single credential type for a user in an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + for a single user within the organization. This removes the sign-in authorizations + for that credential type for the user in the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, target yourself, and + > revoke classic personal access tokens, that token's authorization for the + > organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + parameters: + - *88 + - *131 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke for the user. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation for user 'octocat' has been + queued + with_warning: + value: + message: Credential type revocation for user 'octocat' has been + queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: *3 + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/custom-repository-roles": get: summary: List custom repository roles in an organization @@ -148806,6 +149114,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -149138,6 +149447,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -149475,8 +149785,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -149841,6 +150151,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -150117,8 +150428,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - string - 'null' @@ -150415,8 +150726,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -150743,6 +151054,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -162464,7 +162776,8 @@ webhooks: - private repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object @@ -162575,7 +162888,8 @@ webhooks: repositories_added: *933 repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 586b9a0a2e..37b05b4b3a 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -43049,6 +43049,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -83059,7 +83060,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": { "get": { "summary": "Get a budget by ID", - "description": "Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.", + "description": "Gets a budget by ID. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -83396,7 +83397,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -84238,7 +84239,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": { "get": { "summary": "Get user states for a multi-user budget", - "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated user must be an enterprise admin or billing manager.", + "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -84497,7 +84498,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -181038,6 +181039,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -205338,6 +205340,309 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -205408,6 +205713,327 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -433822,6 +434448,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -434897,6 +435524,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -440232,6 +440860,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -440540,6 +441169,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1092845,6 +1093475,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1095355,6 +1095986,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1097723,7 +1098355,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1100459,6 +1101091,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1102905,7 +1103538,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -1105370,7 +1106003,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1107884,6 +1108517,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1275853,7 +1276487,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -1279081,7 +1279715,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index 7156cfd035..f1b2679c38 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -16755,6 +16755,7 @@ paths: - false positive - won't fix - used in tests + - mitigated - dismissed_comment: &568 type: @@ -29610,8 +29611,8 @@ paths: "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID - description: Gets a budget by ID. The authenticated user must be an enterprise - admin or billing manager. + description: Gets a budget by ID. The authenticated actor must have permission + to view enterprise billing. tags: - billing operationId: billing/get-budget @@ -29735,7 +29736,7 @@ paths: '503': *196 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: @@ -30051,7 +30052,7 @@ paths: get: summary: Get user states for a multi-user budget description: Lists per-user budget state for a multi-user customer scoped budget. - The authenticated user must be an enterprise admin or billing manager. + The authenticated actor must have permission to view enterprise billing. tags: - billing operationId: billing/get-budget-user-states @@ -30158,7 +30159,7 @@ paths: '503': *196 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -54251,6 +54252,156 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-all": + post: + summary: Revoke all credential authorizations for an organization + description: |- + Revokes all SAML SSO credential authorizations for every member of the + organization. This removes the sign-in authorizations for personal access + tokens, SSH keys, OAuth app tokens, and user-to-server tokens that members + have authorized for the organization. Members will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, that token's + > authorization for the organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-credential-authorizations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization + parameters: + - *88 + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation has been queued + with_warning: + value: + message: Credential authorization revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-credential-type": + post: + summary: Revoke a single credential type for an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + across the organization. This removes the sign-in authorizations for that + credential type for every member of the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and revoke classic + > personal access tokens, that token's authorization for the organization may + > also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + parameters: + - *88 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke across the organization. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation has been queued + with_warning: + value: + message: Credential type revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: *3 + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/credential-authorizations/{credential_id}": delete: summary: Remove a SAML SSO authorization for an organization @@ -54282,6 +54433,163 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke": + post: + summary: Revoke credential authorizations for a user in an organization + description: |- + Revokes all SAML SSO credential authorizations for a single user within the + organization. This removes the sign-in authorizations for the user's personal + access tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they + have authorized for the organization. The user will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and target yourself, + > that token's authorization for the organization may also be revoked as part of + > this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-authorizations-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization + parameters: + - *88 + - *131 + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + with_warning: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": + post: + summary: Revoke a single credential type for a user in an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + for a single user within the organization. This removes the sign-in authorizations + for that credential type for the user in the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, target yourself, and + > revoke classic personal access tokens, that token's authorization for the + > organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + parameters: + - *88 + - *131 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke for the user. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation for user 'octocat' has been + queued + with_warning: + value: + message: Credential type revocation for user 'octocat' has been + queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: *3 + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/custom-repository-roles": get: summary: List custom repository roles in an organization @@ -150228,6 +150536,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -150560,6 +150869,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -150897,8 +151207,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -151263,6 +151573,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -151539,8 +151850,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - string - 'null' @@ -151837,8 +152148,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -152165,6 +152476,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -163886,7 +164198,8 @@ webhooks: - private repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object @@ -163997,7 +164310,8 @@ webhooks: repositories_added: *933 repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index 104279df4b..613d63a2a4 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -18825,7 +18825,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": { "get": { "summary": "Get a budget by ID", - "description": "Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.", + "description": "Gets a budget by ID. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -18864,7 +18864,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -19143,7 +19143,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": { "get": { "summary": "Get user states for a multi-user budget", - "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated user must be an enterprise admin or billing manager.", + "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -19231,7 +19231,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -39664,6 +39664,189 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -39705,6 +39888,195 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -144159,6 +144531,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -204429,6 +204802,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -204780,6 +205154,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -205154,7 +205529,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -205566,6 +205941,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -205853,7 +206229,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -206161,7 +206537,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -206516,6 +206892,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -216585,7 +216962,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -216657,7 +217034,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index 6f61be7ac0..89010185d5 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -13943,8 +13943,8 @@ paths: "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID - description: Gets a budget by ID. The authenticated user must be an enterprise - admin or billing manager. + description: Gets a budget by ID. The authenticated actor must have permission + to view enterprise billing. tags: - billing operationId: billing/get-budget @@ -13969,7 +13969,7 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: @@ -14175,7 +14175,7 @@ paths: get: summary: Get user states for a multi-user budget description: Lists per-user budget state for a multi-user customer scoped budget. - The authenticated user must be an enterprise admin or billing manager. + The authenticated actor must have permission to view enterprise billing. tags: - billing operationId: billing/get-budget-user-states @@ -14233,7 +14233,7 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -29314,6 +29314,161 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-all": + post: + summary: Revoke all credential authorizations for an organization + description: |- + Revokes all SAML SSO credential authorizations for every member of the + organization. This removes the sign-in authorizations for personal access + tokens, SSH keys, OAuth app tokens, and user-to-server tokens that members + have authorized for the organization. Members will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, that token's + > authorization for the organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-credential-authorizations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation has been queued + with_warning: + value: + message: Credential authorization revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-credential-type": + post: + summary: Revoke a single credential type for an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + across the organization. This removes the sign-in authorizations for that + credential type for every member of the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and revoke classic + > personal access tokens, that token's authorization for the organization may + > also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke across the organization. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation has been queued + with_warning: + value: + message: Credential type revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/credential-authorizations/{credential_id}": delete: summary: Remove a SAML SSO authorization for an organization @@ -29346,6 +29501,168 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke": + post: + summary: Revoke credential authorizations for a user in an organization + description: |- + Revokes all SAML SSO credential authorizations for a single user within the + organization. This removes the sign-in authorizations for the user's personal + access tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they + have authorized for the organization. The user will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and target yourself, + > that token's authorization for the organization may also be revoked as part of + > this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-authorizations-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + with_warning: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": + post: + summary: Revoke a single credential type for a user in an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + for a single user within the organization. This removes the sign-in authorizations + for that credential type for the user in the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, target yourself, and + > revoke classic personal access tokens, that token's authorization for the + > organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke for the user. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation for user 'octocat' has been + queued + with_warning: + value: + message: Credential type revocation for user 'octocat' has been + queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/custom-repository-roles": get: summary: List custom repository roles in an organization @@ -104823,6 +105140,7 @@ components: - false positive - won't fix - used in tests + - mitigated - code-scanning-alert-dismissed-comment: type: @@ -148817,6 +149135,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -149086,6 +149405,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -149367,7 +149687,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -149678,6 +149998,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -149899,7 +150220,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - string - 'null' @@ -150139,7 +150460,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -150411,6 +150732,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -157579,7 +157901,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object @@ -157631,7 +157954,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object diff --git a/descriptions-next/ghec/ghec.2026-03-10.json b/descriptions-next/ghec/ghec.2026-03-10.json index 625649b922..679e9a50b7 100644 --- a/descriptions-next/ghec/ghec.2026-03-10.json +++ b/descriptions-next/ghec/ghec.2026-03-10.json @@ -18825,7 +18825,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": { "get": { "summary": "Get a budget by ID", - "description": "Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.", + "description": "Gets a budget by ID. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -18864,7 +18864,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -19143,7 +19143,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": { "get": { "summary": "Get user states for a multi-user budget", - "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated user must be an enterprise admin or billing manager.", + "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -19231,7 +19231,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -39602,6 +39602,189 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -39643,6 +39826,195 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -143959,6 +144331,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -203936,6 +204309,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -204287,6 +204661,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -204661,7 +205036,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -205073,6 +205448,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -205360,7 +205736,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -205668,7 +206044,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -206023,6 +206399,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -216092,7 +216469,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -216164,7 +216541,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + {"code":"deadline_exceeded","msg":"operation timed out"}