From 3a53cbb9a0e761c9f9bf3b4feb52f5e9e52fd6b0 Mon Sep 17 00:00:00 2001 From: github-openapi-bot Date: Tue, 29 Sep 2026 12:35:25 -0700 Subject: [PATCH] Update OpenAPI 3.0 Descriptions --- .../dereferenced/ghec.2022-11-28.deref.json | 18 ++++++++++++------ .../dereferenced/ghec.2022-11-28.deref.yaml | 12 ++++++++++++ .../dereferenced/ghec.2026-03-10.deref.json | 18 ++++++++++++------ .../dereferenced/ghec.2026-03-10.deref.yaml | 12 ++++++++++++ descriptions/ghec/dereferenced/ghec.deref.json | 18 ++++++++++++------ descriptions/ghec/dereferenced/ghec.deref.yaml | 12 ++++++++++++ descriptions/ghec/ghec.2022-11-28.json | 18 ++++++++++++------ descriptions/ghec/ghec.2022-11-28.yaml | 12 ++++++++++++ descriptions/ghec/ghec.2026-03-10.json | 18 ++++++++++++------ descriptions/ghec/ghec.2026-03-10.yaml | 12 ++++++++++++ descriptions/ghec/ghec.json | 18 ++++++++++++------ descriptions/ghec/ghec.yaml | 12 ++++++++++++ 12 files changed, 144 insertions(+), 36 deletions(-) diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index c99e548fe3..8a4c820973 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -58088,7 +58088,7 @@ "/enterprises/{enterprise}/credentials": { "get": { "summary": "List enterprise token inventory", - "description": "Lists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use \"[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)\", which accepts the same filters in its request body, to start a CSV export, then \"[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)\" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/).\n\nLists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", "tags": [ "enterprise-admin" ], @@ -58650,8 +58650,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "token-inventory" - } + "subcategory": "token-inventory", + "deprecationDate": "2026-09-29", + "removalDate": "2026-10-02" + }, + "deprecated": true } }, "/enterprises/{enterprise}/credentials/exports": { @@ -58930,7 +58933,7 @@ "/enterprises/{enterprise}/credentials/{inventory_id}": { "get": { "summary": "Get an enterprise token inventory item", - "description": "Returns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use \"[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)\" to start a CSV export, optionally scoped with filters such as `owner` or `application`, then \"[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)\" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/).\n\nReturns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", "tags": [ "enterprise-admin" ], @@ -59248,8 +59251,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "token-inventory" - } + "subcategory": "token-inventory", + "deprecationDate": "2026-09-29", + "removalDate": "2026-10-02" + }, + "deprecated": true } }, "/enterprises/{enterprise}/dependabot/alerts": { diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 1f0ea4f73c..0a5aead12f 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -21187,6 +21187,9 @@ paths: get: summary: List enterprise token inventory description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use "[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)", which accepts the same filters in its request body, to start a CSV export, then "[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/). + Lists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count. You must be an enterprise owner (or hold a role with the "View enterprise credentials" permission) to use this endpoint. @@ -21641,6 +21644,9 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: token-inventory + deprecationDate: '2026-09-29' + removalDate: '2026-10-02' + deprecated: true "/enterprises/{enterprise}/credentials/exports": post: summary: Create an enterprise token inventory export @@ -21827,6 +21833,9 @@ paths: get: summary: Get an enterprise token inventory item description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use "[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)" to start a CSV export, optionally scoped with filters such as `owner` or `application`, then "[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/). + Returns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise. You must be an enterprise owner (or hold a role with the "View enterprise credentials" permission) to use this endpoint. @@ -21900,6 +21909,9 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: token-inventory + deprecationDate: '2026-09-29' + removalDate: '2026-10-02' + deprecated: true "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise diff --git a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json index cd7170332b..2d656e164b 100644 --- a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json @@ -57973,7 +57973,7 @@ "/enterprises/{enterprise}/credentials": { "get": { "summary": "List enterprise token inventory", - "description": "Lists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use \"[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)\", which accepts the same filters in its request body, to start a CSV export, then \"[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)\" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/).\n\nLists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", "tags": [ "enterprise-admin" ], @@ -58535,8 +58535,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "token-inventory" - } + "subcategory": "token-inventory", + "deprecationDate": "2026-09-29", + "removalDate": "2026-10-02" + }, + "deprecated": true } }, "/enterprises/{enterprise}/credentials/exports": { @@ -58815,7 +58818,7 @@ "/enterprises/{enterprise}/credentials/{inventory_id}": { "get": { "summary": "Get an enterprise token inventory item", - "description": "Returns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use \"[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)\" to start a CSV export, optionally scoped with filters such as `owner` or `application`, then \"[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)\" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/).\n\nReturns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", "tags": [ "enterprise-admin" ], @@ -59133,8 +59136,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "token-inventory" - } + "subcategory": "token-inventory", + "deprecationDate": "2026-09-29", + "removalDate": "2026-10-02" + }, + "deprecated": true } }, "/enterprises/{enterprise}/dependabot/alerts": { diff --git a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml index 49373c4703..051c8f98c0 100644 --- a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml @@ -21139,6 +21139,9 @@ paths: get: summary: List enterprise token inventory description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use "[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)", which accepts the same filters in its request body, to start a CSV export, then "[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/). + Lists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count. You must be an enterprise owner (or hold a role with the "View enterprise credentials" permission) to use this endpoint. @@ -21593,6 +21596,9 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: token-inventory + deprecationDate: '2026-09-29' + removalDate: '2026-10-02' + deprecated: true "/enterprises/{enterprise}/credentials/exports": post: summary: Create an enterprise token inventory export @@ -21779,6 +21785,9 @@ paths: get: summary: Get an enterprise token inventory item description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use "[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)" to start a CSV export, optionally scoped with filters such as `owner` or `application`, then "[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/). + Returns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise. You must be an enterprise owner (or hold a role with the "View enterprise credentials" permission) to use this endpoint. @@ -21852,6 +21861,9 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: token-inventory + deprecationDate: '2026-09-29' + removalDate: '2026-10-02' + deprecated: true "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index b6a6be338c..01d61e7a9f 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -58535,7 +58535,7 @@ "/enterprises/{enterprise}/credentials": { "get": { "summary": "List enterprise token inventory", - "description": "Lists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use \"[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)\", which accepts the same filters in its request body, to start a CSV export, then \"[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)\" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/).\n\nLists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", "tags": [ "enterprise-admin" ], @@ -59097,8 +59097,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "token-inventory" - } + "subcategory": "token-inventory", + "deprecationDate": "2026-09-29", + "removalDate": "2026-10-02" + }, + "deprecated": true } }, "/enterprises/{enterprise}/credentials/exports": { @@ -59377,7 +59380,7 @@ "/enterprises/{enterprise}/credentials/{inventory_id}": { "get": { "summary": "Get an enterprise token inventory item", - "description": "Returns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use \"[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)\" to start a CSV export, optionally scoped with filters such as `owner` or `application`, then \"[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)\" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/).\n\nReturns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", "tags": [ "enterprise-admin" ], @@ -59695,8 +59698,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "token-inventory" - } + "subcategory": "token-inventory", + "deprecationDate": "2026-09-29", + "removalDate": "2026-10-02" + }, + "deprecated": true } }, "/enterprises/{enterprise}/dependabot/alerts": { diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 11461077de..e85fcccd2d 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -21341,6 +21341,9 @@ paths: get: summary: List enterprise token inventory description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use "[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)", which accepts the same filters in its request body, to start a CSV export, then "[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/). + Lists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count. You must be an enterprise owner (or hold a role with the "View enterprise credentials" permission) to use this endpoint. @@ -21795,6 +21798,9 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: token-inventory + deprecationDate: '2026-09-29' + removalDate: '2026-10-02' + deprecated: true "/enterprises/{enterprise}/credentials/exports": post: summary: Create an enterprise token inventory export @@ -21981,6 +21987,9 @@ paths: get: summary: Get an enterprise token inventory item description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use "[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)" to start a CSV export, optionally scoped with filters such as `owner` or `application`, then "[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/). + Returns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise. You must be an enterprise owner (or hold a role with the "View enterprise credentials" permission) to use this endpoint. @@ -22054,6 +22063,9 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: token-inventory + deprecationDate: '2026-09-29' + removalDate: '2026-10-02' + deprecated: true "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index f35df3dc4b..a4e04031c9 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -15199,7 +15199,7 @@ "/enterprises/{enterprise}/credentials": { "get": { "summary": "List enterprise token inventory", - "description": "Lists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use \"[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)\", which accepts the same filters in its request body, to start a CSV export, then \"[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)\" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/).\n\nLists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", "tags": [ "enterprise-admin" ], @@ -15346,8 +15346,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "token-inventory" - } + "subcategory": "token-inventory", + "deprecationDate": "2026-09-29", + "removalDate": "2026-10-02" + }, + "deprecated": true } }, "/enterprises/{enterprise}/credentials/exports": { @@ -15550,7 +15553,7 @@ "/enterprises/{enterprise}/credentials/{inventory_id}": { "get": { "summary": "Get an enterprise token inventory item", - "description": "Returns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use \"[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)\" to start a CSV export, optionally scoped with filters such as `owner` or `application`, then \"[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)\" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/).\n\nReturns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", "tags": [ "enterprise-admin" ], @@ -15597,8 +15600,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "token-inventory" - } + "subcategory": "token-inventory", + "deprecationDate": "2026-09-29", + "removalDate": "2026-10-02" + }, + "deprecated": true } }, "/enterprises/{enterprise}/dependabot/alerts": { diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index 85343df6cc..c269626401 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -11367,6 +11367,9 @@ paths: get: summary: List enterprise token inventory description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use "[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)", which accepts the same filters in its request body, to start a CSV export, then "[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/). + Lists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count. You must be an enterprise owner (or hold a role with the "View enterprise credentials" permission) to use this endpoint. @@ -11487,6 +11490,9 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: token-inventory + deprecationDate: '2026-09-29' + removalDate: '2026-10-02' + deprecated: true "/enterprises/{enterprise}/credentials/exports": post: summary: Create an enterprise token inventory export @@ -11649,6 +11655,9 @@ paths: get: summary: Get an enterprise token inventory item description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use "[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)" to start a CSV export, optionally scoped with filters such as `owner` or `application`, then "[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/). + Returns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise. You must be an enterprise owner (or hold a role with the "View enterprise credentials" permission) to use this endpoint. @@ -11687,6 +11696,9 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: token-inventory + deprecationDate: '2026-09-29' + removalDate: '2026-10-02' + deprecated: true "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise diff --git a/descriptions/ghec/ghec.2026-03-10.json b/descriptions/ghec/ghec.2026-03-10.json index 2f8e48c3d6..ee504b8be4 100644 --- a/descriptions/ghec/ghec.2026-03-10.json +++ b/descriptions/ghec/ghec.2026-03-10.json @@ -15199,7 +15199,7 @@ "/enterprises/{enterprise}/credentials": { "get": { "summary": "List enterprise token inventory", - "description": "Lists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use \"[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)\", which accepts the same filters in its request body, to start a CSV export, then \"[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)\" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/).\n\nLists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", "tags": [ "enterprise-admin" ], @@ -15346,8 +15346,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "token-inventory" - } + "subcategory": "token-inventory", + "deprecationDate": "2026-09-29", + "removalDate": "2026-10-02" + }, + "deprecated": true } }, "/enterprises/{enterprise}/credentials/exports": { @@ -15550,7 +15553,7 @@ "/enterprises/{enterprise}/credentials/{inventory_id}": { "get": { "summary": "Get an enterprise token inventory item", - "description": "Returns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use \"[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)\" to start a CSV export, optionally scoped with filters such as `owner` or `application`, then \"[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)\" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/).\n\nReturns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", "tags": [ "enterprise-admin" ], @@ -15597,8 +15600,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "token-inventory" - } + "subcategory": "token-inventory", + "deprecationDate": "2026-09-29", + "removalDate": "2026-10-02" + }, + "deprecated": true } }, "/enterprises/{enterprise}/dependabot/alerts": { diff --git a/descriptions/ghec/ghec.2026-03-10.yaml b/descriptions/ghec/ghec.2026-03-10.yaml index e0f4b965b7..52ea0ace7f 100644 --- a/descriptions/ghec/ghec.2026-03-10.yaml +++ b/descriptions/ghec/ghec.2026-03-10.yaml @@ -11367,6 +11367,9 @@ paths: get: summary: List enterprise token inventory description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use "[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)", which accepts the same filters in its request body, to start a CSV export, then "[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/). + Lists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count. You must be an enterprise owner (or hold a role with the "View enterprise credentials" permission) to use this endpoint. @@ -11487,6 +11490,9 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: token-inventory + deprecationDate: '2026-09-29' + removalDate: '2026-10-02' + deprecated: true "/enterprises/{enterprise}/credentials/exports": post: summary: Create an enterprise token inventory export @@ -11649,6 +11655,9 @@ paths: get: summary: Get an enterprise token inventory item description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use "[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)" to start a CSV export, optionally scoped with filters such as `owner` or `application`, then "[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/). + Returns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise. You must be an enterprise owner (or hold a role with the "View enterprise credentials" permission) to use this endpoint. @@ -11687,6 +11696,9 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: token-inventory + deprecationDate: '2026-09-29' + removalDate: '2026-10-02' + deprecated: true "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index ae92768bae..d65a3a16e4 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -15213,7 +15213,7 @@ "/enterprises/{enterprise}/credentials": { "get": { "summary": "List enterprise token inventory", - "description": "Lists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use \"[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)\", which accepts the same filters in its request body, to start a CSV export, then \"[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)\" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/).\n\nLists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", "tags": [ "enterprise-admin" ], @@ -15360,8 +15360,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "token-inventory" - } + "subcategory": "token-inventory", + "deprecationDate": "2026-09-29", + "removalDate": "2026-10-02" + }, + "deprecated": true } }, "/enterprises/{enterprise}/credentials/exports": { @@ -15564,7 +15567,7 @@ "/enterprises/{enterprise}/credentials/{inventory_id}": { "get": { "summary": "Get an enterprise token inventory item", - "description": "Returns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use \"[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)\" to start a CSV export, optionally scoped with filters such as `owner` or `application`, then \"[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)\" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/).\n\nReturns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise.\n\nYou must be an enterprise owner (or hold a role with the \"View enterprise credentials\" permission) to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint.", "tags": [ "enterprise-admin" ], @@ -15611,8 +15614,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "token-inventory" - } + "subcategory": "token-inventory", + "deprecationDate": "2026-09-29", + "removalDate": "2026-10-02" + }, + "deprecated": true } }, "/enterprises/{enterprise}/dependabot/alerts": { diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index 63f43a0cb1..32461a73d5 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -11375,6 +11375,9 @@ paths: get: summary: List enterprise token inventory description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use "[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)", which accepts the same filters in its request body, to start a CSV export, then "[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/). + Lists an enterprise's credential inventory: both credentials currently authorized to access the enterprise and credentials owned by enterprise members that have no current enterprise authorization. Covers personal access tokens (classic and fine-grained), OAuth App and GitHub App user tokens, SSH keys, GitHub App installations, and federated credentials, assembled on demand from the canonical sources. Results are paginated with an opaque cursor via the `Link` header; there is no total count. You must be an enterprise owner (or hold a role with the "View enterprise credentials" permission) to use this endpoint. @@ -11495,6 +11498,9 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: token-inventory + deprecationDate: '2026-09-29' + removalDate: '2026-10-02' + deprecated: true "/enterprises/{enterprise}/credentials/exports": post: summary: Create an enterprise token inventory export @@ -11657,6 +11663,9 @@ paths: get: summary: Get an enterprise token inventory item description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on October 2, 2026. Please migrate to the asynchronous export: use "[Create an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#create-an-enterprise-token-inventory-export)" to start a CSV export, optionally scoped with filters such as `owner` or `application`, then "[Get an enterprise token inventory export](https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/token-inventory#get-an-enterprise-token-inventory-export)" to download it. For more information, see the [changelog](https://github.blog/changelog/2026-09-21-github-enterprise-adds-credential-inventory-exports/). + Returns a single credential from the enterprise token inventory. Use the opaque `inventory_id` returned by the list endpoint for the same enterprise. You must be an enterprise owner (or hold a role with the "View enterprise credentials" permission) to use this endpoint. @@ -11695,6 +11704,9 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: token-inventory + deprecationDate: '2026-09-29' + removalDate: '2026-10-02' + deprecated: true "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise