diff --git a/content/copilot/concepts/copilot-metrics.md b/content/copilot/concepts/copilot-metrics.md
index 16cc2be83f..d39a8995eb 100644
--- a/content/copilot/concepts/copilot-metrics.md
+++ b/content/copilot/concepts/copilot-metrics.md
@@ -19,15 +19,21 @@ redirect_from:
{% data reusables.copilot.usage-metrics-preview %}
+## About {% data variables.product.prodname_copilot_short %} usage metrics
+
{% data variables.product.prodname_copilot_short %} usage metrics help key stakeholders and decision-makers understand how their teams are adopting and using {% data variables.product.prodname_copilot_short %}. By tracking usage patterns across the enterprise, you can measure engagement, identify opportunities to increase value, and make data-driven decisions about enablement and rollout.
Metrics are available through:
-* The {% data variables.product.prodname_copilot_short %} usage metrics APIs, which provide detailed, user-level data you can export for further analysis.
+* The {% data variables.product.prodname_copilot_short %} usage metrics APIs, which provide detailed, exportable data at the enterprise, organization, and user levels.
* The {% data variables.product.prodname_copilot_short %} usage metrics dashboard, which visualizes 28-day usage trends across your enterprise.
* The code generation dashboard, which breaks down how code is being generated by users and agents across your enterprise.
* The {% data variables.product.prodname_copilot_short %} usage metrics NDJSON export, which offers raw data for custom BI tools or long-term storage.
+### Organization-level metrics
+
+Organization-level metrics are **only available through the APIs**. Both dashboards provide enterprise-level reporting.
+
For a complete list of available metrics and data fields, see [AUTOTITLE](/copilot/reference/copilot-usage-metrics).
## Which usage is included?
@@ -43,6 +49,22 @@ This means the data **does not include** activity from other {% data variables.p
License and seat management data are not included in {% data variables.product.prodname_copilot_short %} usage metrics reports. To view or manage license assignments, use the {% data variables.product.prodname_copilot_short %} user management API, which is the source of truth for license and seat information. See [AUTOTITLE](/rest/copilot/copilot-user-management).
+## How are metrics attributed across organizations?
+
+Organization-level {% data variables.product.prodname_copilot_short %} usage metrics are based on organization membership, not on where individual actions occur. To appear in an enterprise’s metrics, a user must have an active {% data variables.product.prodname_copilot_short %} seat assigned within that enterprise (in any organization that belongs to the enterprise). As a result, a single user’s usage may appear in multiple organization dashboards, while that same user is counted only once in the enterprise-level total. Organization-level analytics are intended for visibility into adoption and usage within an organization and are not designed to be directly compared to enterprise-level totals.
+
+Organization-level {% data variables.product.prodname_copilot_short %} analytics are available starting December 12, 2025. This is the first date for which organization-level reports are provided.
+
+
+Once a user has a seat in the enterprise, their usage is attributed to **every organization they belong to**, regardless of where the seat is assigned.
+
+This means:
+
+* If licenses are assigned in a dedicated “shell” organization for administrative purposes within the enterprise, users still appear in the metrics for all other organizations in the enterprise they belong to.
+* If a user also has a {% data variables.product.prodname_copilot_short %} seat in a **separate organization outside the enterprise**, their activity is still included in the enterprise’s organization-level metrics **as long as they have at least one seat within the enterprise**.
+
+In short: users must be licensed somewhere in the enterprise to appear in its metrics. Once they are, metrics reflect where they work (their organization membership), not which organization provides the {% data variables.product.prodname_copilot_short %} seat or where the activity originated.
+
## Supported IDEs
To be included in the {% data variables.product.prodname_copilot_short %} usage metrics, end users must use one of the following IDEs and {% data variables.copilot.copilot_chat_short %} extension versions.
@@ -94,4 +116,4 @@ Now that you understand what each {% data variables.product.prodname_copilot_sho
* To view adoption and usage trends across your enterprise, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/view-usage-and-adoption).
* To analyze how code is being generated by users and agents, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/view-code-generation).
-* To access these metrics programmatically, see [AUTOTITLE](/rest/copilot/copilot-usage-metrics).
+* To access enterprise-, organization-, and user-level metrics programmatically, see [AUTOTITLE](/rest/copilot/copilot-usage-metrics).
diff --git a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/view-code-generation.md b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/view-code-generation.md
index 95af50ac41..61ad9fd54f 100644
--- a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/view-code-generation.md
+++ b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/view-code-generation.md
@@ -24,6 +24,8 @@ The code generation dashboard shows how {% data variables.product.prodname_copil
{% data reusables.copilot.access-copilot-metrics-dashboard %}
1. In the left sidebar, click **Code generation**.
+{% data reusables.copilot.org-copilot-usage-metrics %}
+
## What you can view
The dashboard shows aggregated code generation activity across your enterprise, including:
@@ -39,4 +41,4 @@ For a full list of available metrics and definitions, see [AUTOTITLE](/copilot/r
* To explore adoption and usage trends across your enterprise, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/view-usage-and-adoption).
* To understand how Lines of Code (LoC) metrics are measured and what affects their accuracy and coverage, see [AUTOTITLE](/copilot/reference/copilot-usage-metrics/lines-of-code-metrics).
-* To access usage data programmatically, see [AUTOTITLE](/rest/copilot/copilot-usage-metrics).
+* To access enterprise-, organization-, and user-level usage data programmatically, see [AUTOTITLE](/rest/copilot/copilot-usage-metrics).
diff --git a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/view-usage-and-adoption.md b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/view-usage-and-adoption.md
index 776e040423..c2dc27ac72 100644
--- a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/view-usage-and-adoption.md
+++ b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/view-usage-and-adoption.md
@@ -24,7 +24,7 @@ After your initial rollout, the {% data variables.product.prodname_copilot_short
{% data reusables.copilot.access-copilot-metrics-dashboard %}
1. In the left sidebar, click **{% data variables.product.prodname_copilot_short %} usage**.
-Data in the dashboard is based only on IDE telemetry and may appear up to three full UTC days behind the current date. See [AUTOTITLE](/copilot/concepts/copilot-metrics#data-freshness).
+Data in the dashboard reports data at the enterprise level, is based only on IDE telemetry, and may appear up to three full UTC days behind the current date. See [AUTOTITLE](/copilot/concepts/copilot-metrics).
## Using {% data variables.copilot.copilot_chat_short %} to analyze exported data
@@ -32,7 +32,7 @@ For deeper analysis, you can export NDJSON reports from the dashboard and use {%
```copilot copy prompt
* Which users have `user_initiated_interaction_count` > 0 but low `code_acceptance_activity_count`?
-* Are there specific organizations or teams with lower adoption rates?
+* Are there specific teams with lower adoption rates?
```
## Next steps
diff --git a/content/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md b/content/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md
index 0b03872ede..31c623fcc7 100644
--- a/content/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md
+++ b/content/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md
@@ -17,6 +17,9 @@ topics:
The {% data variables.product.prodname_copilot_short %} usage metrics dashboard and APIs display and export data using a consistent set of fields. This reference lists all available metrics and describes how to interpret their values in both dashboard visuals and NDJSON or API exports. To retrieve this data programmatically, see [AUTOTITLE](/rest/copilot/copilot-usage-metrics).
+* The {% data variables.product.prodname_copilot_short %} usage metrics dashboard reports data at the **enterprise** level.
+* The {% data variables.product.prodname_copilot_short %} usage metrics APIs support **enterprise-, organization-, and user-level** records.
+
For guidance on how to read and interpret these metrics, see [AUTOTITLE](/copilot/concepts/copilot-metrics).
## {% data variables.product.prodname_copilot_short %} usage dashboard metrics
@@ -60,14 +63,15 @@ These metrics appear in the code generation dashboard and provide a breakdown of
## API and export fields
-These fields appear in the exported NDJSON reports and in the {% data variables.product.prodname_copilot_short %} usage metrics APIs. They provide granular daily records for each user in the enterprise.
+These fields appear in the exported NDJSON reports and in the {% data variables.product.prodname_copilot_short %} usage metrics APIs. They provide granular daily records for each user included in the requested enterprise or organization scope.
| Field | Description |
|:--|:--|
| `agent_edit` | A dedicated bucket in the API and reports. Captures lines added and deleted directly by {% data variables.product.prodname_copilot_short %} Agent and Edit mode.
These are not included in suggested metrics, since agent edits don’t follow a simple suggestion to acceptance flow. |
| `report_start_day` / `report_end_day` | Start and end dates for the 28-day reporting period. |
| `day` | Calendar day this record represents. |
-| `enterprise_id` | Unique ID of the enterprise or organization. |
+| `enterprise_id` | Unique ID of the enterprise. |
+| `organization_id` (API only) | Unique ID of the organization. |
| `user_id` / `user_login` | Unique identifier and {% data variables.product.github %} username for the user. |
| `user_initiated_interaction_count` | Number of explicit prompts sent to {% data variables.product.prodname_copilot_short %}.
Only counts messages or prompts actively sent to the model. Does **not** include opening the chat panel, switching modes (for example, Ask, Edit, or Agent), using keyboard shortcuts to open the inline UI, or making configuration changes. |
| `code_generation_activity_count` | Number of distinct {% data variables.product.prodname_copilot_short %} output events generated.
**Includes:** All generated content, including comments and docstrings.
**Multiple blocks:** Each distinct code block from a single user prompt counts as a separate generation.
**Note:** This metric is not directly comparable to `user_initiated_interaction_count`, since one prompt can produce multiple generations. |
diff --git a/content/copilot/reference/copilot-usage-metrics/interpret-copilot-metrics.md b/content/copilot/reference/copilot-usage-metrics/interpret-copilot-metrics.md
index e05f9fc3f9..f8be6b21d6 100644
--- a/content/copilot/reference/copilot-usage-metrics/interpret-copilot-metrics.md
+++ b/content/copilot/reference/copilot-usage-metrics/interpret-copilot-metrics.md
@@ -16,9 +16,9 @@ redirect_from:
>[!NOTE] The {% data variables.product.prodname_copilot_short %} usage metrics dashboard is currently in {% data variables.release-phases.public_preview %} and subject to change.
-After you’ve viewed usage data in the {% data variables.product.prodname_copilot_short %} usage metrics dashboard, you can use this article to interpret what each chart means and identify opportunities to increase adoption and engagement across your enterprise.
+After you’ve viewed the {% data variables.product.prodname_copilot_short %} usage metrics dashboard, you can use this article to interpret each chart and identify opportunities to increase adoption and engagement.
-You can also access these metrics programmatically through the {% data variables.product.prodname_copilot_short %} usage metrics REST API, see [AUTOTITLE](/rest/copilot/copilot-usage-metrics).
+> [!NOTE] The dashboard reports enterprise-level data. Organization-level views are available through the {% data variables.product.prodname_copilot_short %} usage metrics APIs.
## Reviewing overall usage trends
@@ -73,7 +73,6 @@ Use trends in usage, feature adoption, and language activity to guide enablement
> [!TIP]
> Consider combining dashboard trends with feedback from surveys or retrospectives to get a full picture of {% data variables.product.prodname_copilot_short %}’s impact on developer productivity.
-## Further reading
+## Next steps
-* [AUTOTITLE](/copilot/reference/copilot-usage-metrics/reconciling-usage-metrics)
-* [AUTOTITLE](/copilot/reference/copilot-usage-metrics/lines-of-code-metrics)
+* To access metrics programmatically, including enterprise, organization, and user-level records, see [AUTOTITLE](/rest/copilot/copilot-usage-metrics).
diff --git a/content/copilot/reference/copilot-usage-metrics/lines-of-code-metrics.md b/content/copilot/reference/copilot-usage-metrics/lines-of-code-metrics.md
index 675a66ea35..c2c95b04f9 100644
--- a/content/copilot/reference/copilot-usage-metrics/lines-of-code-metrics.md
+++ b/content/copilot/reference/copilot-usage-metrics/lines-of-code-metrics.md
@@ -22,8 +22,8 @@ Lines of Code (LoC) metrics provide a directional measure of {% data variables.p
You may encounter LoC metrics in:
-* **Code generation dashboard** — visualizes LoC-based user and agent activity. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/view-code-generation).
-* **Exports and APIs** — expose LoC fields such as `loc_suggested_to_add_sum`, `loc_added_sum`, and `loc_deleted_sum`. See [AUTOTITLE](/rest/copilot/copilot-usage-metrics).
+* **Code generation dashboard (enterprise level)** — visualizes LoC-based user and agent activity. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/view-code-generation).
+* **Exports and APIs (enterprise, organization, and user level)** — expose LoC fields such as `loc_suggested_to_add_sum`, `loc_added_sum`, and `loc_deleted_sum`. See [AUTOTITLE](/rest/copilot/copilot-usage-metrics).
* **"Data available in {% data variables.product.prodname_copilot_short %} usage metrics" reference** — lists all dashboard and API fields derived from LoC. See [AUTOTITLE](/copilot/reference/copilot-usage-metrics/copilot-usage-metrics).
This article covers how LoC is measured and what affects its accuracy and coverage. For detailed definitions, refer to the reference article above.
diff --git a/content/copilot/reference/copilot-usage-metrics/reconciling-usage-metrics.md b/content/copilot/reference/copilot-usage-metrics/reconciling-usage-metrics.md
index 964ddc517b..346b57db72 100644
--- a/content/copilot/reference/copilot-usage-metrics/reconciling-usage-metrics.md
+++ b/content/copilot/reference/copilot-usage-metrics/reconciling-usage-metrics.md
@@ -18,6 +18,9 @@ redirect_from:
The {% data variables.product.prodname_copilot_short %} usage metrics dashboard, APIs, and export files all use the same underlying telemetry data, but they aggregate and present it differently. Understanding these differences helps you reconcile numbers across sources and trust your analysis when preparing internal reports.
+* The {% data variables.product.prodname_copilot_short %} usage metrics dashboard reports data at the **enterprise-level**.
+* The {% data variables.product.prodname_copilot_short %} usage metrics APIs support **enterprise-, organization-, and user-level** records.
+
## Prerequisite
{% data variables.product.prodname_copilot_short %} usage metrics depend on **telemetry from users’ IDEs**. If a developer has disabled telemetry in their IDE, their {% data variables.product.prodname_copilot_short %} activity will **not** appear in the dashboard, API reports, or exported data.
diff --git a/content/copilot/tutorials/roll-out-at-scale/measure-success.md b/content/copilot/tutorials/roll-out-at-scale/measure-success.md
index f2ad1ef780..34864c6529 100644
--- a/content/copilot/tutorials/roll-out-at-scale/measure-success.md
+++ b/content/copilot/tutorials/roll-out-at-scale/measure-success.md
@@ -38,6 +38,10 @@ Setting clear goals makes it easier to interpret results and communicate value t
## Step 2: View adoption and engagement metrics in the dashboard
+> [!NOTE]
+> * The {% data variables.product.prodname_copilot_short %} usage metrics dashboard reports data at the enterprise level.
+> * Organization-level metrics are available through the {% data variables.product.prodname_copilot_short %} usage metrics APIs and exports.
+
{% data reusables.copilot.access-copilot-metrics-dashboard %}
The dashboard shows 28 days of aggregated IDE telemetry data for all licensed users in your enterprise. Focus on these **key metrics** during your trial:
diff --git a/data/reusables/copilot/org-copilot-usage-metrics.md b/data/reusables/copilot/org-copilot-usage-metrics.md
new file mode 100644
index 0000000000..37ce071b9c
--- /dev/null
+++ b/data/reusables/copilot/org-copilot-usage-metrics.md
@@ -0,0 +1 @@
+> [!NOTE] The {% data variables.product.prodname_copilot_short %} usage metrics dashboard reports data at the enterprise level. Organization-level metrics are available through the {% data variables.product.prodname_copilot_short %} usage metrics APIs only. See [AUTOTITLE](/rest/copilot/copilot-usage-metrics).
diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
index 9892129a31..c06c730baf 100644
--- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
@@ -2408,6 +2408,48 @@
}
]
},
+ "organization_copilot_metrics": {
+ "title": "Organization Copilot metrics",
+ "displayTitle": "Organization permissions for \"Organization Copilot metrics\"",
+ "permissions": [
+ {
+ "category": "copilot",
+ "slug": "get-copilot-organization-usage-metrics-for-a-specific-day",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/organization-1-day",
+ "additional-permissions": false,
+ "access": "read"
+ },
+ {
+ "category": "copilot",
+ "slug": "get-copilot-organization-usage-metrics",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest",
+ "additional-permissions": false,
+ "access": "read"
+ },
+ {
+ "category": "copilot",
+ "slug": "get-copilot-organization-users-usage-metrics-for-a-specific-day",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/users-1-day",
+ "additional-permissions": false,
+ "access": "read"
+ },
+ {
+ "category": "copilot",
+ "slug": "get-copilot-organization-users-usage-metrics",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/users-28-day/latest",
+ "additional-permissions": false,
+ "access": "read"
+ }
+ ]
+ },
"organization_announcement_banners": {
"title": "Organization announcement banners",
"displayTitle": "Organization permissions for \"Organization announcement banners\"",
@@ -2753,6 +2795,15 @@
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}",
"additional-permissions": true,
"access": "write"
+ },
+ {
+ "category": "dependabot",
+ "slug": "cancel-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}",
+ "additional-permissions": true,
+ "access": "write"
}
]
},
@@ -6882,6 +6933,15 @@
"additional-permissions": false,
"access": "read"
},
+ {
+ "category": "dependabot",
+ "slug": "create-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}",
+ "additional-permissions": false,
+ "access": "read"
+ },
{
"category": "dependabot",
"slug": "review-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
@@ -6890,6 +6950,15 @@
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}",
"additional-permissions": true,
"access": "read"
+ },
+ {
+ "category": "dependabot",
+ "slug": "cancel-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}",
+ "additional-permissions": true,
+ "access": "read"
}
]
},
diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
index 95231dac44..96f4c5caa4 100644
--- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
+++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
@@ -2194,6 +2194,30 @@
"verb": "get",
"requestPath": "/orgs/{org}/copilot/metrics"
},
+ {
+ "slug": "get-copilot-organization-usage-metrics-for-a-specific-day",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/organization-1-day"
+ },
+ {
+ "slug": "get-copilot-organization-usage-metrics",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest"
+ },
+ {
+ "slug": "get-copilot-organization-users-usage-metrics-for-a-specific-day",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/users-1-day"
+ },
+ {
+ "slug": "get-copilot-organization-users-usage-metrics",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/users-28-day/latest"
+ },
{
"slug": "get-copilot-seat-assignment-details-for-a-user",
"subcategory": "copilot-user-management",
@@ -2352,11 +2376,23 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}"
},
+ {
+ "slug": "create-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}"
+ },
{
"slug": "review-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
"subcategory": "alert-dismissal-requests",
"verb": "patch",
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}"
+ },
+ {
+ "slug": "cancel-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}"
}
],
"dependency-graph": [
diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
index f3372886b8..e3d83b2d5b 100644
--- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
@@ -3425,6 +3425,56 @@
}
]
},
+ "organization_copilot_metrics": {
+ "title": "Organization Copilot metrics",
+ "displayTitle": "Organization permissions for \"Organization Copilot metrics\"",
+ "permissions": [
+ {
+ "category": "copilot",
+ "slug": "get-copilot-organization-usage-metrics-for-a-specific-day",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/organization-1-day",
+ "access": "read",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": false
+ },
+ {
+ "category": "copilot",
+ "slug": "get-copilot-organization-usage-metrics",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest",
+ "access": "read",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": false
+ },
+ {
+ "category": "copilot",
+ "slug": "get-copilot-organization-users-usage-metrics-for-a-specific-day",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/users-1-day",
+ "access": "read",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": false
+ },
+ {
+ "category": "copilot",
+ "slug": "get-copilot-organization-users-usage-metrics",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/users-28-day/latest",
+ "access": "read",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": false
+ }
+ ]
+ },
"organization_announcement_banners": {
"title": "Organization announcement banners",
"displayTitle": "Organization permissions for \"Organization announcement banners\"",
@@ -3838,6 +3888,17 @@
"user-to-server": true,
"server-to-server": true,
"additional-permissions": true
+ },
+ {
+ "category": "dependabot",
+ "slug": "cancel-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}",
+ "access": "write",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": true
}
]
},
@@ -9115,6 +9176,17 @@
"server-to-server": true,
"additional-permissions": false
},
+ {
+ "category": "dependabot",
+ "slug": "create-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}",
+ "access": "read",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": false
+ },
{
"category": "dependabot",
"slug": "review-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
@@ -9125,6 +9197,17 @@
"user-to-server": true,
"server-to-server": true,
"additional-permissions": true
+ },
+ {
+ "category": "dependabot",
+ "slug": "cancel-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}",
+ "access": "read",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": true
}
]
},
diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
index 215592869d..fd2258be9c 100644
--- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
+++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
@@ -2170,6 +2170,30 @@
"verb": "get",
"requestPath": "/orgs/{org}/copilot/metrics"
},
+ {
+ "slug": "get-copilot-organization-usage-metrics-for-a-specific-day",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/organization-1-day"
+ },
+ {
+ "slug": "get-copilot-organization-usage-metrics",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest"
+ },
+ {
+ "slug": "get-copilot-organization-users-usage-metrics-for-a-specific-day",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/users-1-day"
+ },
+ {
+ "slug": "get-copilot-organization-users-usage-metrics",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/users-28-day/latest"
+ },
{
"slug": "get-copilot-seat-assignment-details-for-a-user",
"subcategory": "copilot-user-management",
@@ -2336,11 +2360,23 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}"
},
+ {
+ "slug": "create-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}"
+ },
{
"slug": "review-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
"subcategory": "alert-dismissal-requests",
"verb": "patch",
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}"
+ },
+ {
+ "slug": "cancel-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}"
}
],
"dependency-graph": [
diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
index 17c248eb0f..6a2c39bb9c 100644
--- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
+++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
@@ -2418,6 +2418,30 @@
"verb": "get",
"requestPath": "/orgs/{org}/copilot/metrics"
},
+ {
+ "slug": "get-copilot-organization-usage-metrics-for-a-specific-day",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/organization-1-day"
+ },
+ {
+ "slug": "get-copilot-organization-usage-metrics",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest"
+ },
+ {
+ "slug": "get-copilot-organization-users-usage-metrics-for-a-specific-day",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/users-1-day"
+ },
+ {
+ "slug": "get-copilot-organization-users-usage-metrics",
+ "subcategory": "copilot-usage-metrics",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/copilot/metrics/reports/users-28-day/latest"
+ },
{
"slug": "get-copilot-seat-assignment-details-for-a-user",
"subcategory": "copilot-user-management",
@@ -2584,11 +2608,23 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}"
},
+ {
+ "slug": "create-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}"
+ },
{
"slug": "review-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
"subcategory": "alert-dismissal-requests",
"verb": "patch",
"requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}"
+ },
+ {
+ "slug": "cancel-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}"
}
],
"dependency-graph": [
diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json
index 52057e9a48..984266dcdb 100644
--- a/src/github-apps/lib/config.json
+++ b/src/github-apps/lib/config.json
@@ -60,5 +60,5 @@
"2022-11-28"
]
},
- "sha": "b1e772fd7deb79fdcde54863353275d990299269"
+ "sha": "8fcf2850bf7699b117f63cd2f385f792dde1d760"
}
\ No newline at end of file
diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json
index 8959abc288..fd41be9f36 100644
--- a/src/rest/data/fpt-2022-11-28/schema.json
+++ b/src/rest/data/fpt-2022-11-28/schema.json
@@ -229830,6 +229830,15 @@
"error"
]
}
+ },
+ {
+ "name": "assignees",
+ "description": "
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
If true, attempt to create an alert dismissal request.
The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert.
" } ], "descriptionHTML": "Updates the status of a single code scanning alert.\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
OK
" }, + { + "httpStatusCode": "202", + "description": "Accepted
" + }, { "httpStatusCode": "403", "description": "Forbidden
" @@ -470555,6 +470582,10 @@ "httpStatusCode": "200", "description": "OK
" }, + { + "httpStatusCode": "202", + "description": "Accepted
" + }, { "httpStatusCode": "403", "description": "Forbidden
" @@ -470679,6 +470710,10 @@ "httpStatusCode": "200", "description": "OK
" }, + { + "httpStatusCode": "202", + "description": "Accepted
" + }, { "httpStatusCode": "403", "description": "Forbidden
" @@ -470891,6 +470926,10 @@ "httpStatusCode": "200", "description": "OK
" }, + { + "httpStatusCode": "202", + "description": "Accepted
" + }, { "httpStatusCode": "403", "description": "Forbidden
" @@ -494024,7 +494063,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -494177,7 +494217,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ] }, { @@ -494316,7 +494357,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -494502,7 +494544,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -494637,7 +494680,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ] }, { @@ -494747,7 +494791,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 448fde41d3..e23081884f 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -241576,6 +241576,15 @@ ], "default": "created" } + }, + { + "name": "assignees", + "description": "Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
If true, attempt to create an alert dismissal request.
The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert.
" } ], "descriptionHTML": "Updates the status of a single code scanning alert.\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in YYYY-MM-DD format.
Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.
\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.
\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.
\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
For more information about organization metrics attribution, see How are metrics attributed across organizations.
", + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + }, + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Organization Copilot metrics\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest", + "title": "Get Copilot organization usage metrics", + "category": "copilot", + "subcategory": "copilot-usage-metrics", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.
\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.
\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.
\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
For more information about organization metrics attribution, see How are metrics attributed across organizations.
", + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + }, + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Organization Copilot metrics\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot/metrics/reports/users-1-day", + "title": "Get Copilot organization users usage metrics for a specific day", + "category": "copilot", + "subcategory": "copilot-usage-metrics", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in YYYY-MM-DD format.
Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.
\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.
\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.
\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
For more information about organization metrics attribution, see How are metrics attributed across organizations.
", + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + }, + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Organization Copilot metrics\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot/metrics/reports/users-28-day/latest", + "title": "Get Copilot organization users usage metrics", + "category": "copilot", + "subcategory": "copilot-usage-metrics", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.
\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.
\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.
\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
For more information about organization metrics attribution, see How are metrics attributed across organizations.
", + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + }, + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Organization Copilot metrics\" organization permissions": "read" + } + ] + } } ], "copilot-user-management": [ @@ -336770,6 +337234,353 @@ ] } }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}", + "title": "Create a dismissal request for a Dependabot alert for a repository", + "category": "dependabot", + "subcategory": "alert-dismissal-requests", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The number that identifies the Dependabot alert.
", + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "dismissed_reason", + "in": "body", + "description": "The reason for dismissing the alert.
", + "isRequired": true, + "enum": [ + "fix_started", + "no_bandwidth", + "tolerable_risk", + "inaccurate", + "not_used" + ] + }, + { + "type": "string", + "name": "dismissed_comment", + "in": "body", + "description": "An optional comment explaining the dismissal.
" + } + ], + "descriptionHTML": "Creates a new dismissal request to dismiss a Dependabot alert in a repository.
\nDelegated alert dismissal must be enabled on the repository and the user must have permission to view Dependabot alerts to access this endpoint.\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint.
The created dismissal request.
", + "example": { + "id": 1, + "number": 1, + "repository": { + "id": 1, + "name": "hello-world", + "full_name": "octocat/hello-world" + }, + "organization": { + "id": 1, + "name": "octocat" + }, + "requester": { + "actor_id": 1, + "actor_name": "octocat" + }, + "request_type": "dependabot_alert_closure", + "data": [ + { + "reason": "tolerable_risk", + "alert_number": "42", + "alert_title": "lodash vulnerability" + } + ], + "resource_identifier": "42", + "status": "pending", + "requester_comment": "Risk is acceptable for this project.", + "expires_at": "2024-01-15T00:00:00Z", + "created_at": "2024-01-08T00:00:00Z", + "responses": null, + "url": "https://github.com/octocat/hello-world/security/dependabot/42" + }, + "schema": { + "title": "Dependabot alert dismissal request", + "description": "Alert dismissal request made by a user asking to dismiss a Dependabot alert.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the dismissal request." + }, + "number": { + "type": "integer", + "format": "int64", + "description": "The number uniquely identifying the dismissal request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the repository the dismissal request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the dismissal request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the dismissal request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the dismissal request.", + "properties": { + "actor_id": { + "type": "integer", + "format": "int64", + "description": "The ID of the GitHub user who requested the dismissal request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the dismissal request." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "type": [ + "array", + "null" + ], + "description": "Data describing the dismissal request metadata.", + "items": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "The reason for the dismissal request." + }, + "alert_number": { + "type": "string", + "description": "The alert number." + }, + "alert_title": { + "type": "string", + "description": "The title of the alert." + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the dismissal request.", + "examples": [ + "123" + ] + }, + "status": { + "type": "string", + "description": "The status of the dismissal request.", + "enum": [ + "pending", + "denied", + "approved", + "expired" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the dismissal request." + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the dismissal request.", + "items": { + "title": "Dismissal request response", + "description": "A response made by a requester to dismiss the request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the response to the dismissal request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the dismissal request.", + "properties": { + "actor_id": { + "type": "integer", + "format": "int64", + "description": "The ID of the GitHub user who reviewed the dismissal request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the dismissal request." + } + } + }, + "message": { + "type": [ + "string", + "null" + ], + "description": "The response comment of the reviewer." + }, + "status": { + "type": "string", + "description": "The response status to the dismissal request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the dismissal request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/1" + ] + }, + "html_url": { + "type": "string", + "description": "The URL to view the dismissal request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/octo-org/smile/security/dependabot/1" + ] + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "The created dismissal request.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Dependabot alerts\" repository permissions": "read" + } + ] + } + }, { "serverUrl": "https://api.github.com", "verb": "patch", @@ -336897,6 +337708,93 @@ } ] } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}", + "title": "Cancel a dismissal request for a Dependabot alert for a repository", + "category": "dependabot", + "subcategory": "alert-dismissal-requests", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The number that identifies the Dependabot alert.
", + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Cancels a pending dismissal request for a Dependabot alert in a repository.
\nThe authenticated user must be the requester of the dismissal request or have reviewer permissions (security manager or organization owner).\nDelegated alert dismissal must be enabled on the repository.\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint.
Dismissal request cancelled successfully.
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "Dismissal request cancelled successfully.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Organization dismissal requests for Dependabot\" organization permissions": "write", + "\"Dependabot alerts\" repository permissions": "read" + } + ] + } } ], "alerts": [ @@ -363311,7 +364209,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -363465,7 +364364,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ] }, { @@ -363604,7 +364504,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -363801,7 +364702,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -363987,7 +364889,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -364123,7 +365026,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ] }, { @@ -364233,7 +365137,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -364504,7 +365409,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -364664,7 +365570,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ] }, { @@ -364808,7 +365715,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -365008,7 +365916,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -365150,7 +366059,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ] }, { @@ -365263,7 +366173,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -516125,6 +517036,10 @@ "httpStatusCode": "200", "description": "OK
" }, + { + "httpStatusCode": "202", + "description": "Accepted
" + }, { "httpStatusCode": "403", "description": "Forbidden
" @@ -516296,6 +517211,10 @@ "httpStatusCode": "200", "description": "OK
" }, + { + "httpStatusCode": "202", + "description": "Accepted
" + }, { "httpStatusCode": "403", "description": "Forbidden
" @@ -516420,6 +517339,10 @@ "httpStatusCode": "200", "description": "OK
" }, + { + "httpStatusCode": "202", + "description": "Accepted
" + }, { "httpStatusCode": "403", "description": "Forbidden
" @@ -516632,6 +517555,10 @@ "httpStatusCode": "200", "description": "OK
" }, + { + "httpStatusCode": "202", + "description": "Accepted
" + }, { "httpStatusCode": "403", "description": "Forbidden
" @@ -539695,7 +540622,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -539848,7 +540776,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ] }, { @@ -539987,7 +540916,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -540173,7 +541103,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -540308,7 +541239,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ] }, { @@ -540418,7 +541350,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index 06f169d218..ff36df0e45 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -327867,6 +327867,15 @@ ], "default": "created" } + }, + { + "name": "assignees", + "description": "Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
The dismissal comment associated with the dismissal of the alert.
" + }, + { + "type": "array of strings", + "name": "assignees", + "in": "body", + "description": "The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert.
" } ], "descriptionHTML": "Updates the status of a single code scanning alert.\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
The dismissal comment associated with the dismissal of the alert.
" + }, + { + "type": "array of strings", + "name": "assignees", + "in": "body", + "description": "The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert.
" } ], "descriptionHTML": "Updates the status of a single code scanning alert.\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
The dismissal comment associated with the dismissal of the alert.
" + }, + { + "type": "array of strings", + "name": "assignees", + "in": "body", + "description": "The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert.
" } ], "descriptionHTML": "Updates the status of a single code scanning alert.\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
The dismissal comment associated with the dismissal of the alert.
" + }, + { + "type": "array of strings", + "name": "assignees", + "in": "body", + "description": "The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert.
" } ], "descriptionHTML": "Updates the status of a single code scanning alert.\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
The dismissal comment associated with the dismissal of the alert.
" + }, + { + "type": "array of strings", + "name": "assignees", + "in": "body", + "description": "The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert.
" } ], "descriptionHTML": "Updates the status of a single code scanning alert.\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., octocat or octocat,hubot).\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
If true, attempt to create an alert dismissal request.
The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert.
" } ], "descriptionHTML": "Updates the status of a single code scanning alert.\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.