diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 36ef2aaeb2..8a691cd246 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -2077,7 +2077,7 @@ "/enterprises/{enterprise}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -5918,6 +5918,10 @@ "secret_scanning_push_protection_custom_link": { "type": "string", "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, @@ -11401,7 +11405,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -11458,7 +11462,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -11541,7 +11545,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -11596,7 +11600,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for members of the specified team(s).", "properties": { "seats_created": { "type": "integer" @@ -11641,7 +11645,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -11696,7 +11700,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", "properties": { "seats_cancelled": { "type": "integer" @@ -11743,7 +11747,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -11798,7 +11802,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for the specified user(s).", "properties": { "seats_created": { "type": "integer" @@ -11843,7 +11847,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -11898,7 +11902,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", "properties": { "seats_cancelled": { "type": "integer" @@ -15092,7 +15096,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -98706,6 +98710,11 @@ "type": "string", "format": "date-time", "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ @@ -101905,6 +101914,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -101929,6 +101942,7 @@ "permissions", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -101991,6 +102005,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -102014,6 +102032,7 @@ "permissions", "access_granted_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -117383,6 +117402,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -124395,6 +124417,9 @@ }, "verified": { "type": "boolean" + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -130393,6 +130418,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -130419,6 +130448,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -266963,6 +266993,7 @@ "members_can_fork_private_repositories": false, "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z", + "deploy_keys_enabled_for_repositories": false, "dependency_graph_enabled_for_new_repositories": false, "dependabot_alerts_enabled_for_new_repositories": false, "dependabot_security_updates_enabled_for_new_repositories": false, @@ -270614,6 +270645,7 @@ }, "created_at": "2023-05-16T08:47:09.000-07:00", "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -270656,6 +270688,7 @@ }, "access_granted_at": "2023-05-16T08:47:09.000-07:00", "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -282519,7 +282552,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } ] }, @@ -282533,7 +282567,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } }, "label": { diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index e07450986b..97d624e82f 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -1436,11 +1436,14 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. @@ -4267,6 +4270,10 @@ paths: description: If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. + deploy_keys_enabled_for_repositories: + type: boolean + description: Controls whether or not deploy keys may be added and + used for repositories in the organization. examples: default: value: @@ -8321,7 +8328,7 @@ paths: Gets information about an organization's Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. @@ -8366,9 +8373,12 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. Only organization owners can view assigned seats. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot @@ -8429,13 +8439,13 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for all users within each specified team. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -8478,7 +8488,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for members of the + specified team(s). properties: seats_created: type: integer @@ -8512,15 +8523,17 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for all members of each team specified. - This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all members of each team specified to "pending cancellation". + This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -8560,7 +8573,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for members of the specified team(s). properties: seats_cancelled: type: integer @@ -8596,13 +8610,13 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for each user specified. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -8645,7 +8659,7 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for the specified user(s). properties: seats_created: type: integer @@ -8679,15 +8693,17 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for each user specified. - This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all users specified to "pending cancellation". + This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -8727,7 +8743,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for the specified users. properties: seats_cancelled: type: integer @@ -10977,7 +10994,10 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + + The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only organization owners can view Copilot seat assignment details for members of their organization. @@ -71960,6 +71980,11 @@ components: type: string format: date-time nullable: true + deploy_keys_enabled_for_repositories: + type: boolean + example: false + description: Controls whether or not deploy keys may be added and used for + repositories in the organization. required: - login - url @@ -74499,6 +74524,10 @@ components: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -74522,6 +74551,7 @@ components: - permissions - created_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -74574,6 +74604,10 @@ components: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -74596,6 +74630,7 @@ components: - permissions - access_granted_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -86442,6 +86477,8 @@ components: last_used: type: string nullable: true + enabled: + type: boolean required: - id - key @@ -91798,6 +91835,8 @@ components: format: uri verified: type: boolean + enabled: + type: boolean required: - id - key @@ -96347,6 +96386,10 @@ components: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -96372,6 +96415,7 @@ components: - repositories - created_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -200140,6 +200184,7 @@ components: members_can_fork_private_repositories: false web_commit_signoff_required: false updated_at: '2014-03-03T18:58:10Z' + deploy_keys_enabled_for_repositories: false dependency_graph_enabled_for_new_repositories: false dependabot_alerts_enabled_for_new_repositories: false dependabot_security_updates_enabled_for_new_repositories: false @@ -203263,6 +203308,7 @@ components: metadata: read created_at: '2023-05-16T08:47:09.000-07:00' token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -203297,6 +203343,7 @@ components: metadata: read access_granted_at: '2023-05-16T08:47:09.000-07:00' token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -213399,6 +213446,7 @@ components: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true deploy-key: value: id: 1 @@ -213410,6 +213458,7 @@ components: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true label: value: id: 208045946 diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 36ef2aaeb2..8a691cd246 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -2077,7 +2077,7 @@ "/enterprises/{enterprise}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -5918,6 +5918,10 @@ "secret_scanning_push_protection_custom_link": { "type": "string", "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, @@ -11401,7 +11405,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -11458,7 +11462,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -11541,7 +11545,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -11596,7 +11600,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for members of the specified team(s).", "properties": { "seats_created": { "type": "integer" @@ -11641,7 +11645,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -11696,7 +11700,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", "properties": { "seats_cancelled": { "type": "integer" @@ -11743,7 +11747,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -11798,7 +11802,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for the specified user(s).", "properties": { "seats_created": { "type": "integer" @@ -11843,7 +11847,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -11898,7 +11902,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", "properties": { "seats_cancelled": { "type": "integer" @@ -15092,7 +15096,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -98706,6 +98710,11 @@ "type": "string", "format": "date-time", "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ @@ -101905,6 +101914,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -101929,6 +101942,7 @@ "permissions", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -101991,6 +102005,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -102014,6 +102032,7 @@ "permissions", "access_granted_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -117383,6 +117402,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -124395,6 +124417,9 @@ }, "verified": { "type": "boolean" + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -130393,6 +130418,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -130419,6 +130448,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -266963,6 +266993,7 @@ "members_can_fork_private_repositories": false, "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z", + "deploy_keys_enabled_for_repositories": false, "dependency_graph_enabled_for_new_repositories": false, "dependabot_alerts_enabled_for_new_repositories": false, "dependabot_security_updates_enabled_for_new_repositories": false, @@ -270614,6 +270645,7 @@ }, "created_at": "2023-05-16T08:47:09.000-07:00", "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -270656,6 +270688,7 @@ }, "access_granted_at": "2023-05-16T08:47:09.000-07:00", "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -282519,7 +282552,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } ] }, @@ -282533,7 +282567,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } }, "label": { diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index e07450986b..97d624e82f 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -1436,11 +1436,14 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. @@ -4267,6 +4270,10 @@ paths: description: If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. + deploy_keys_enabled_for_repositories: + type: boolean + description: Controls whether or not deploy keys may be added and + used for repositories in the organization. examples: default: value: @@ -8321,7 +8328,7 @@ paths: Gets information about an organization's Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. @@ -8366,9 +8373,12 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. Only organization owners can view assigned seats. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot @@ -8429,13 +8439,13 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for all users within each specified team. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -8478,7 +8488,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for members of the + specified team(s). properties: seats_created: type: integer @@ -8512,15 +8523,17 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for all members of each team specified. - This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all members of each team specified to "pending cancellation". + This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -8560,7 +8573,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for members of the specified team(s). properties: seats_cancelled: type: integer @@ -8596,13 +8610,13 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for each user specified. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -8645,7 +8659,7 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for the specified user(s). properties: seats_created: type: integer @@ -8679,15 +8693,17 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for each user specified. - This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all users specified to "pending cancellation". + This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -8727,7 +8743,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for the specified users. properties: seats_cancelled: type: integer @@ -10977,7 +10994,10 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + + The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only organization owners can view Copilot seat assignment details for members of their organization. @@ -71960,6 +71980,11 @@ components: type: string format: date-time nullable: true + deploy_keys_enabled_for_repositories: + type: boolean + example: false + description: Controls whether or not deploy keys may be added and used for + repositories in the organization. required: - login - url @@ -74499,6 +74524,10 @@ components: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -74522,6 +74551,7 @@ components: - permissions - created_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -74574,6 +74604,10 @@ components: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -74596,6 +74630,7 @@ components: - permissions - access_granted_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -86442,6 +86477,8 @@ components: last_used: type: string nullable: true + enabled: + type: boolean required: - id - key @@ -91798,6 +91835,8 @@ components: format: uri verified: type: boolean + enabled: + type: boolean required: - id - key @@ -96347,6 +96386,10 @@ components: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -96372,6 +96415,7 @@ components: - repositories - created_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -200140,6 +200184,7 @@ components: members_can_fork_private_repositories: false web_commit_signoff_required: false updated_at: '2014-03-03T18:58:10Z' + deploy_keys_enabled_for_repositories: false dependency_graph_enabled_for_new_repositories: false dependabot_alerts_enabled_for_new_repositories: false dependabot_security_updates_enabled_for_new_repositories: false @@ -203263,6 +203308,7 @@ components: metadata: read created_at: '2023-05-16T08:47:09.000-07:00' token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -203297,6 +203343,7 @@ components: metadata: read access_granted_at: '2023-05-16T08:47:09.000-07:00' token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -213399,6 +213446,7 @@ components: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true deploy-key: value: id: 1 @@ -213410,6 +213458,7 @@ components: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true label: value: id: 208045946 diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index f2047d1856..1748ff2127 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -15929,7 +15929,7 @@ "/enterprises/{enterprise}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -48024,6 +48024,11 @@ "type": "string", "format": "date-time", "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ @@ -48109,6 +48114,7 @@ "members_can_fork_private_repositories": false, "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z", + "deploy_keys_enabled_for_repositories": false, "dependency_graph_enabled_for_new_repositories": false, "dependabot_alerts_enabled_for_new_repositories": false, "dependabot_security_updates_enabled_for_new_repositories": false, @@ -48325,6 +48331,10 @@ "secret_scanning_push_protection_custom_link": { "type": "string", "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, @@ -48639,6 +48649,11 @@ "type": "string", "format": "date-time", "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ @@ -48724,6 +48739,7 @@ "members_can_fork_private_repositories": false, "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z", + "deploy_keys_enabled_for_repositories": false, "dependency_graph_enabled_for_new_repositories": false, "dependabot_alerts_enabled_for_new_repositories": false, "dependabot_security_updates_enabled_for_new_repositories": false, @@ -69436,7 +69452,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -69703,7 +69719,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -70445,7 +70461,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -70506,7 +70522,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for members of the specified team(s).", "properties": { "seats_created": { "type": "integer" @@ -70643,7 +70659,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -70704,7 +70720,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", "properties": { "seats_cancelled": { "type": "integer" @@ -70843,7 +70859,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -70904,7 +70920,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for the specified user(s).", "properties": { "seats_created": { "type": "integer" @@ -71041,7 +71057,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -71102,7 +71118,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", "properties": { "seats_cancelled": { "type": "integer" @@ -92936,7 +92952,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -104960,6 +104976,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -104984,6 +105004,7 @@ "permissions", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -105028,6 +105049,7 @@ }, "created_at": "2023-05-16T08:47:09.000-07:00", "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -106925,6 +106947,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -106948,6 +106974,7 @@ "permissions", "access_granted_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -106991,6 +107018,7 @@ }, "access_granted_at": "2023-05-16T08:47:09.000-07:00", "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -325439,6 +325467,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -325464,7 +325495,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } ] } @@ -325593,6 +325625,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -325616,7 +325651,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } } } @@ -325788,6 +325824,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -325811,7 +325850,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } } } @@ -578560,6 +578600,9 @@ }, "verified": { "type": "boolean" + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -580216,6 +580259,9 @@ }, "verified": { "type": "boolean" + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -782232,6 +782278,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -782258,6 +782308,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -782918,6 +782969,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -782944,6 +782999,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -783604,6 +783660,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -783630,6 +783690,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -784289,6 +784350,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -784315,6 +784380,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 0589b0b4c6..24952a3b25 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -6912,11 +6912,14 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. @@ -15429,6 +15432,11 @@ paths: type: string format: date-time nullable: true + deploy_keys_enabled_for_repositories: + type: boolean + example: false + description: Controls whether or not deploy keys may be added + and used for repositories in the organization. required: - login - url @@ -15509,6 +15517,7 @@ paths: members_can_fork_private_repositories: false web_commit_signoff_required: false updated_at: '2014-03-03T18:58:10Z' + deploy_keys_enabled_for_repositories: false dependency_graph_enabled_for_new_repositories: false dependabot_alerts_enabled_for_new_repositories: false dependabot_security_updates_enabled_for_new_repositories: false @@ -15738,6 +15747,10 @@ paths: description: If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. + deploy_keys_enabled_for_repositories: + type: boolean + description: Controls whether or not deploy keys may be added and + used for repositories in the organization. examples: default: value: @@ -22558,7 +22571,7 @@ paths: Gets information about an organization's Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. @@ -22699,9 +22712,12 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. Only organization owners can view assigned seats. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot @@ -22755,13 +22771,13 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for all users within each specified team. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -22804,7 +22820,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for members of the + specified team(s). properties: seats_created: type: integer @@ -22834,15 +22851,17 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for all members of each team specified. - This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all members of each team specified to "pending cancellation". + This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -22882,7 +22901,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for members of the specified team(s). properties: seats_cancelled: type: integer @@ -22914,13 +22934,13 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for each user specified. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -22963,7 +22983,7 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for the specified user(s). properties: seats_created: type: integer @@ -22993,15 +23013,17 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for each user specified. - This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all users specified to "pending cancellation". + This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -23041,7 +23063,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for the specified users. properties: seats_cancelled: type: integer @@ -26138,7 +26161,10 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + + The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only organization owners can view Copilot seat assignment details for members of their organization. @@ -28775,6 +28801,11 @@ paths: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field + can also be found in an organization's settings page for Active + Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access @@ -28798,6 +28829,7 @@ paths: - permissions - created_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -28834,6 +28866,7 @@ paths: metadata: read created_at: '2023-05-16T08:47:09.000-07:00' token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -29100,6 +29133,11 @@ paths: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field + can also be found in an organization's settings page for Active + Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access @@ -29122,6 +29160,7 @@ paths: - permissions - access_granted_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -29157,6 +29196,7 @@ paths: metadata: read access_granted_at: '2023-05-16T08:47:09.000-07:00' token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -70386,6 +70426,8 @@ paths: last_used: type: string nullable: true + enabled: + type: boolean required: - id - key @@ -70406,6 +70448,7 @@ paths: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true headers: Link: *39 x-github: @@ -70473,6 +70516,7 @@ paths: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true headers: Location: example: https://api.github.com/repos/octocat/Hello-World/keys/1 @@ -104023,6 +104067,8 @@ x-webhooks: format: uri verified: type: boolean + enabled: + type: boolean required: - id - key @@ -138042,6 +138088,11 @@ x-webhooks: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field + can also be found in an organization's settings page for Active + Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access @@ -138067,6 +138118,7 @@ x-webhooks: - repositories - created_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index f2047d1856..1748ff2127 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -15929,7 +15929,7 @@ "/enterprises/{enterprise}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -48024,6 +48024,11 @@ "type": "string", "format": "date-time", "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ @@ -48109,6 +48114,7 @@ "members_can_fork_private_repositories": false, "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z", + "deploy_keys_enabled_for_repositories": false, "dependency_graph_enabled_for_new_repositories": false, "dependabot_alerts_enabled_for_new_repositories": false, "dependabot_security_updates_enabled_for_new_repositories": false, @@ -48325,6 +48331,10 @@ "secret_scanning_push_protection_custom_link": { "type": "string", "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, @@ -48639,6 +48649,11 @@ "type": "string", "format": "date-time", "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ @@ -48724,6 +48739,7 @@ "members_can_fork_private_repositories": false, "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z", + "deploy_keys_enabled_for_repositories": false, "dependency_graph_enabled_for_new_repositories": false, "dependabot_alerts_enabled_for_new_repositories": false, "dependabot_security_updates_enabled_for_new_repositories": false, @@ -69436,7 +69452,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -69703,7 +69719,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -70445,7 +70461,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -70506,7 +70522,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for members of the specified team(s).", "properties": { "seats_created": { "type": "integer" @@ -70643,7 +70659,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -70704,7 +70720,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", "properties": { "seats_cancelled": { "type": "integer" @@ -70843,7 +70859,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -70904,7 +70920,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for the specified user(s).", "properties": { "seats_created": { "type": "integer" @@ -71041,7 +71057,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -71102,7 +71118,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", "properties": { "seats_cancelled": { "type": "integer" @@ -92936,7 +92952,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -104960,6 +104976,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -104984,6 +105004,7 @@ "permissions", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -105028,6 +105049,7 @@ }, "created_at": "2023-05-16T08:47:09.000-07:00", "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -106925,6 +106947,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -106948,6 +106974,7 @@ "permissions", "access_granted_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -106991,6 +107018,7 @@ }, "access_granted_at": "2023-05-16T08:47:09.000-07:00", "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -325439,6 +325467,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -325464,7 +325495,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } ] } @@ -325593,6 +325625,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -325616,7 +325651,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } } } @@ -325788,6 +325824,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -325811,7 +325850,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } } } @@ -578560,6 +578600,9 @@ }, "verified": { "type": "boolean" + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -580216,6 +580259,9 @@ }, "verified": { "type": "boolean" + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -782232,6 +782278,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -782258,6 +782308,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -782918,6 +782969,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -782944,6 +782999,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -783604,6 +783660,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -783630,6 +783690,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -784289,6 +784350,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -784315,6 +784380,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 0589b0b4c6..24952a3b25 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -6912,11 +6912,14 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. @@ -15429,6 +15432,11 @@ paths: type: string format: date-time nullable: true + deploy_keys_enabled_for_repositories: + type: boolean + example: false + description: Controls whether or not deploy keys may be added + and used for repositories in the organization. required: - login - url @@ -15509,6 +15517,7 @@ paths: members_can_fork_private_repositories: false web_commit_signoff_required: false updated_at: '2014-03-03T18:58:10Z' + deploy_keys_enabled_for_repositories: false dependency_graph_enabled_for_new_repositories: false dependabot_alerts_enabled_for_new_repositories: false dependabot_security_updates_enabled_for_new_repositories: false @@ -15738,6 +15747,10 @@ paths: description: If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. + deploy_keys_enabled_for_repositories: + type: boolean + description: Controls whether or not deploy keys may be added and + used for repositories in the organization. examples: default: value: @@ -22558,7 +22571,7 @@ paths: Gets information about an organization's Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. @@ -22699,9 +22712,12 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. Only organization owners can view assigned seats. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot @@ -22755,13 +22771,13 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for all users within each specified team. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -22804,7 +22820,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for members of the + specified team(s). properties: seats_created: type: integer @@ -22834,15 +22851,17 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for all members of each team specified. - This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all members of each team specified to "pending cancellation". + This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -22882,7 +22901,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for members of the specified team(s). properties: seats_cancelled: type: integer @@ -22914,13 +22934,13 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for each user specified. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -22963,7 +22983,7 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for the specified user(s). properties: seats_created: type: integer @@ -22993,15 +23013,17 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for each user specified. - This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all users specified to "pending cancellation". + This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -23041,7 +23063,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for the specified users. properties: seats_cancelled: type: integer @@ -26138,7 +26161,10 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + + The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only organization owners can view Copilot seat assignment details for members of their organization. @@ -28775,6 +28801,11 @@ paths: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field + can also be found in an organization's settings page for Active + Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access @@ -28798,6 +28829,7 @@ paths: - permissions - created_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -28834,6 +28866,7 @@ paths: metadata: read created_at: '2023-05-16T08:47:09.000-07:00' token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -29100,6 +29133,11 @@ paths: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field + can also be found in an organization's settings page for Active + Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access @@ -29122,6 +29160,7 @@ paths: - permissions - access_granted_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -29157,6 +29196,7 @@ paths: metadata: read access_granted_at: '2023-05-16T08:47:09.000-07:00' token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -70386,6 +70426,8 @@ paths: last_used: type: string nullable: true + enabled: + type: boolean required: - id - key @@ -70406,6 +70448,7 @@ paths: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true headers: Link: *39 x-github: @@ -70473,6 +70516,7 @@ paths: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true headers: Location: example: https://api.github.com/repos/octocat/Hello-World/keys/1 @@ -104023,6 +104067,8 @@ x-webhooks: format: uri verified: type: boolean + enabled: + type: boolean required: - id - key @@ -138042,6 +138088,11 @@ x-webhooks: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field + can also be found in an organization's settings page for Active + Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access @@ -138067,6 +138118,7 @@ x-webhooks: - repositories - created_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index 214f0ff309..722fad23d8 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -24420,7 +24420,7 @@ "/enterprises/{enterprise}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -30354,7 +30354,7 @@ "/enterprises/{enterprise}/settings/billing/usage": { "get": { "summary": "Get billing usage report for an enterprise", - "description": "Gets a report of the total usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.\n\n**Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform).\"", + "description": "Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center.\n\n**Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform).\"", "tags": [ "billing" ], @@ -30375,7 +30375,7 @@ }, { "name": "year", - "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2023`.", + "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year.", "in": "query", "required": false, "schema": { @@ -30411,7 +30411,7 @@ }, { "name": "cost_center_id", - "description": "The ID corresponding to a cost center.", + "description": "The ID corresponding to a cost center. The default value is no cost center.", "in": "query", "required": false, "schema": { @@ -58486,6 +58486,11 @@ "type": "string", "format": "date-time", "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ @@ -58572,6 +58577,7 @@ "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z", "archived_at": null, + "deploy_keys_enabled_for_repositories": false, "dependency_graph_enabled_for_new_repositories": false, "dependabot_alerts_enabled_for_new_repositories": false, "dependabot_security_updates_enabled_for_new_repositories": false, @@ -58794,6 +58800,10 @@ "type": "boolean", "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "deprecated": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, @@ -59114,6 +59124,11 @@ "type": "string", "format": "date-time", "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ @@ -59200,6 +59215,7 @@ "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z", "archived_at": null, + "deploy_keys_enabled_for_repositories": false, "dependency_graph_enabled_for_new_repositories": false, "dependabot_alerts_enabled_for_new_repositories": false, "dependabot_security_updates_enabled_for_new_repositories": false, @@ -80517,7 +80533,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -80784,7 +80800,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -81526,7 +81542,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -81587,7 +81603,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for members of the specified team(s).", "properties": { "seats_created": { "type": "integer" @@ -81724,7 +81740,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -81785,7 +81801,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", "properties": { "seats_cancelled": { "type": "integer" @@ -81924,7 +81940,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -81985,7 +82001,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for the specified user(s).", "properties": { "seats_created": { "type": "integer" @@ -82122,7 +82138,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -82183,7 +82199,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", "properties": { "seats_cancelled": { "type": "integer" @@ -107313,7 +107329,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -120418,6 +120434,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -120442,6 +120462,7 @@ "permissions", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -120486,6 +120507,7 @@ }, "created_at": "2023-05-16T08:47:09.000-07:00", "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -122395,6 +122417,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -122418,6 +122444,7 @@ "permissions", "access_granted_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -122461,6 +122488,7 @@ }, "access_granted_at": "2023-05-16T08:47:09.000-07:00", "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -342342,6 +342370,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -342367,7 +342398,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } ] } @@ -342496,6 +342528,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -342519,7 +342554,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } } } @@ -342691,6 +342727,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -342714,7 +342753,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } } } @@ -624802,6 +624842,9 @@ }, "verified": { "type": "boolean" + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -626458,6 +626501,9 @@ }, "verified": { "type": "boolean" + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -828474,6 +828520,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -828500,6 +828550,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -829160,6 +829211,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -829186,6 +829241,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -829846,6 +829902,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -829872,6 +829932,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -830531,6 +830592,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -830557,6 +830622,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 2bcba803fd..8b5973b61a 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -10731,11 +10731,14 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. @@ -13518,7 +13521,7 @@ paths: get: summary: Get billing usage report for an enterprise description: |- - Gets a report of the total usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. + Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center. **Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform)." tags: @@ -13532,7 +13535,7 @@ paths: - name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, - `2023`. + `2024`. Default value is the current year. in: query required: false schema: @@ -13559,7 +13562,8 @@ paths: schema: type: integer - name: cost_center_id - description: The ID corresponding to a cost center. + description: The ID corresponding to a cost center. The default value is no + cost center. in: query required: false schema: @@ -19764,6 +19768,11 @@ paths: type: string format: date-time nullable: true + deploy_keys_enabled_for_repositories: + type: boolean + example: false + description: Controls whether or not deploy keys may be added + and used for repositories in the organization. required: - login - url @@ -19845,6 +19854,7 @@ paths: web_commit_signoff_required: false updated_at: '2014-03-03T18:58:10Z' archived_at: + deploy_keys_enabled_for_repositories: false dependency_graph_enabled_for_new_repositories: false dependabot_alerts_enabled_for_new_repositories: false dependabot_security_updates_enabled_for_new_repositories: false @@ -20082,6 +20092,10 @@ paths: Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization. deprecated: true + deploy_keys_enabled_for_repositories: + type: boolean + description: Controls whether or not deploy keys may be added and + used for repositories in the organization. examples: default: value: @@ -26207,7 +26221,7 @@ paths: Gets information about an organization's Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. @@ -26348,9 +26362,12 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. Only organization owners can view assigned seats. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot @@ -26404,13 +26421,13 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for all users within each specified team. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -26453,7 +26470,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for members of the + specified team(s). properties: seats_created: type: integer @@ -26483,15 +26501,17 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for all members of each team specified. - This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all members of each team specified to "pending cancellation". + This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -26531,7 +26551,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for members of the specified team(s). properties: seats_cancelled: type: integer @@ -26563,13 +26584,13 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for each user specified. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -26612,7 +26633,7 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for the specified user(s). properties: seats_created: type: integer @@ -26642,15 +26663,17 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for each user specified. - This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all users specified to "pending cancellation". + This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -26690,7 +26713,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for the specified users. properties: seats_cancelled: type: integer @@ -30717,7 +30741,10 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + + The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only organization owners can view Copilot seat assignment details for members of their organization. @@ -33641,6 +33668,11 @@ paths: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field + can also be found in an organization's settings page for Active + Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access @@ -33664,6 +33696,7 @@ paths: - permissions - created_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -33700,6 +33733,7 @@ paths: metadata: read created_at: '2023-05-16T08:47:09.000-07:00' token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -33966,6 +34000,11 @@ paths: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field + can also be found in an organization's settings page for Active + Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access @@ -33988,6 +34027,7 @@ paths: - permissions - access_granted_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -34023,6 +34063,7 @@ paths: metadata: read access_granted_at: '2023-05-16T08:47:09.000-07:00' token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -75531,6 +75572,8 @@ paths: last_used: type: string nullable: true + enabled: + type: boolean required: - id - key @@ -75551,6 +75594,7 @@ paths: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true headers: Link: *39 x-github: @@ -75618,6 +75662,7 @@ paths: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true headers: Location: example: https://api.github.com/repos/octocat/Hello-World/keys/1 @@ -112307,6 +112352,8 @@ x-webhooks: format: uri verified: type: boolean + enabled: + type: boolean required: - id - key @@ -146327,6 +146374,11 @@ x-webhooks: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field + can also be found in an organization's settings page for Active + Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access @@ -146352,6 +146404,7 @@ x-webhooks: - repositories - created_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index 214f0ff309..722fad23d8 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -24420,7 +24420,7 @@ "/enterprises/{enterprise}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -30354,7 +30354,7 @@ "/enterprises/{enterprise}/settings/billing/usage": { "get": { "summary": "Get billing usage report for an enterprise", - "description": "Gets a report of the total usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.\n\n**Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform).\"", + "description": "Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center.\n\n**Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform).\"", "tags": [ "billing" ], @@ -30375,7 +30375,7 @@ }, { "name": "year", - "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2023`.", + "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year.", "in": "query", "required": false, "schema": { @@ -30411,7 +30411,7 @@ }, { "name": "cost_center_id", - "description": "The ID corresponding to a cost center.", + "description": "The ID corresponding to a cost center. The default value is no cost center.", "in": "query", "required": false, "schema": { @@ -58486,6 +58486,11 @@ "type": "string", "format": "date-time", "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ @@ -58572,6 +58577,7 @@ "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z", "archived_at": null, + "deploy_keys_enabled_for_repositories": false, "dependency_graph_enabled_for_new_repositories": false, "dependabot_alerts_enabled_for_new_repositories": false, "dependabot_security_updates_enabled_for_new_repositories": false, @@ -58794,6 +58800,10 @@ "type": "boolean", "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "deprecated": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, @@ -59114,6 +59124,11 @@ "type": "string", "format": "date-time", "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ @@ -59200,6 +59215,7 @@ "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z", "archived_at": null, + "deploy_keys_enabled_for_repositories": false, "dependency_graph_enabled_for_new_repositories": false, "dependabot_alerts_enabled_for_new_repositories": false, "dependabot_security_updates_enabled_for_new_repositories": false, @@ -80517,7 +80533,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -80784,7 +80800,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -81526,7 +81542,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -81587,7 +81603,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for members of the specified team(s).", "properties": { "seats_created": { "type": "integer" @@ -81724,7 +81740,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -81785,7 +81801,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", "properties": { "seats_cancelled": { "type": "integer" @@ -81924,7 +81940,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -81985,7 +82001,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for the specified user(s).", "properties": { "seats_created": { "type": "integer" @@ -82122,7 +82138,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -82183,7 +82199,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", "properties": { "seats_cancelled": { "type": "integer" @@ -107313,7 +107329,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -120418,6 +120434,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -120442,6 +120462,7 @@ "permissions", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -120486,6 +120507,7 @@ }, "created_at": "2023-05-16T08:47:09.000-07:00", "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -122395,6 +122417,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -122418,6 +122444,7 @@ "permissions", "access_granted_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -122461,6 +122488,7 @@ }, "access_granted_at": "2023-05-16T08:47:09.000-07:00", "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -342342,6 +342370,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -342367,7 +342398,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } ] } @@ -342496,6 +342528,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -342519,7 +342554,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } } } @@ -342691,6 +342727,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -342714,7 +342753,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } } } @@ -624802,6 +624842,9 @@ }, "verified": { "type": "boolean" + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -626458,6 +626501,9 @@ }, "verified": { "type": "boolean" + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -828474,6 +828520,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -828500,6 +828550,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -829160,6 +829211,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -829186,6 +829241,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -829846,6 +829902,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -829872,6 +829932,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -830531,6 +830592,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -830557,6 +830622,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 2bcba803fd..8b5973b61a 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -10731,11 +10731,14 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. @@ -13518,7 +13521,7 @@ paths: get: summary: Get billing usage report for an enterprise description: |- - Gets a report of the total usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. + Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center. **Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform)." tags: @@ -13532,7 +13535,7 @@ paths: - name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, - `2023`. + `2024`. Default value is the current year. in: query required: false schema: @@ -13559,7 +13562,8 @@ paths: schema: type: integer - name: cost_center_id - description: The ID corresponding to a cost center. + description: The ID corresponding to a cost center. The default value is no + cost center. in: query required: false schema: @@ -19764,6 +19768,11 @@ paths: type: string format: date-time nullable: true + deploy_keys_enabled_for_repositories: + type: boolean + example: false + description: Controls whether or not deploy keys may be added + and used for repositories in the organization. required: - login - url @@ -19845,6 +19854,7 @@ paths: web_commit_signoff_required: false updated_at: '2014-03-03T18:58:10Z' archived_at: + deploy_keys_enabled_for_repositories: false dependency_graph_enabled_for_new_repositories: false dependabot_alerts_enabled_for_new_repositories: false dependabot_security_updates_enabled_for_new_repositories: false @@ -20082,6 +20092,10 @@ paths: Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization. deprecated: true + deploy_keys_enabled_for_repositories: + type: boolean + description: Controls whether or not deploy keys may be added and + used for repositories in the organization. examples: default: value: @@ -26207,7 +26221,7 @@ paths: Gets information about an organization's Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. @@ -26348,9 +26362,12 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. Only organization owners can view assigned seats. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot @@ -26404,13 +26421,13 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for all users within each specified team. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -26453,7 +26470,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for members of the + specified team(s). properties: seats_created: type: integer @@ -26483,15 +26501,17 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for all members of each team specified. - This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all members of each team specified to "pending cancellation". + This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -26531,7 +26551,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for members of the specified team(s). properties: seats_cancelled: type: integer @@ -26563,13 +26584,13 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for each user specified. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -26612,7 +26633,7 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for the specified user(s). properties: seats_created: type: integer @@ -26642,15 +26663,17 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for each user specified. - This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all users specified to "pending cancellation". + This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -26690,7 +26713,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for the specified users. properties: seats_cancelled: type: integer @@ -30717,7 +30741,10 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + + The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only organization owners can view Copilot seat assignment details for members of their organization. @@ -33641,6 +33668,11 @@ paths: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field + can also be found in an organization's settings page for Active + Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access @@ -33664,6 +33696,7 @@ paths: - permissions - created_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -33700,6 +33733,7 @@ paths: metadata: read created_at: '2023-05-16T08:47:09.000-07:00' token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -33966,6 +34000,11 @@ paths: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field + can also be found in an organization's settings page for Active + Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access @@ -33988,6 +34027,7 @@ paths: - permissions - access_granted_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -34023,6 +34063,7 @@ paths: metadata: read access_granted_at: '2023-05-16T08:47:09.000-07:00' token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -75531,6 +75572,8 @@ paths: last_used: type: string nullable: true + enabled: + type: boolean required: - id - key @@ -75551,6 +75594,7 @@ paths: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true headers: Link: *39 x-github: @@ -75618,6 +75662,7 @@ paths: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true headers: Location: example: https://api.github.com/repos/octocat/Hello-World/keys/1 @@ -112307,6 +112352,8 @@ x-webhooks: format: uri verified: type: boolean + enabled: + type: boolean required: - id - key @@ -146327,6 +146374,11 @@ x-webhooks: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field + can also be found in an organization's settings page for Active + Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access @@ -146352,6 +146404,7 @@ x-webhooks: - repositories - created_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 53423edf5b..ed2d1bc0d7 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -4577,7 +4577,7 @@ "/enterprises/{enterprise}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -5433,7 +5433,7 @@ "/enterprises/{enterprise}/settings/billing/usage": { "get": { "summary": "Get billing usage report for an enterprise", - "description": "Gets a report of the total usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.\n\n**Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform).\"", + "description": "Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center.\n\n**Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform).\"", "tags": [ "billing" ], @@ -5460,7 +5460,7 @@ }, { "name": "cost_center_id", - "description": "The ID corresponding to a cost center.", + "description": "The ID corresponding to a cost center. The default value is no cost center.", "in": "query", "required": false, "schema": { @@ -9009,6 +9009,10 @@ "type": "boolean", "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "deprecated": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, @@ -14683,7 +14687,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -14740,7 +14744,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -14823,7 +14827,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -14878,7 +14882,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for members of the specified team(s).", "properties": { "seats_created": { "type": "integer" @@ -14923,7 +14927,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -14978,7 +14982,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", "properties": { "seats_cancelled": { "type": "integer" @@ -15025,7 +15029,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -15080,7 +15084,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for the specified user(s).", "properties": { "seats_created": { "type": "integer" @@ -15125,7 +15129,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -15180,7 +15184,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", "properties": { "seats_cancelled": { "type": "integer" @@ -19154,7 +19158,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -108111,6 +108115,11 @@ "type": "string", "format": "date-time", "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ @@ -111188,6 +111197,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -111212,6 +111225,7 @@ "permissions", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -111274,6 +111288,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -111297,6 +111315,7 @@ "permissions", "access_granted_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -126595,6 +126614,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -134725,6 +134747,9 @@ }, "verified": { "type": "boolean" + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -140723,6 +140748,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -140749,6 +140778,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -278450,6 +278480,7 @@ "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z", "archived_at": null, + "deploy_keys_enabled_for_repositories": false, "dependency_graph_enabled_for_new_repositories": false, "dependabot_alerts_enabled_for_new_repositories": false, "dependabot_security_updates_enabled_for_new_repositories": false, @@ -281784,6 +281815,7 @@ }, "created_at": "2023-05-16T08:47:09.000-07:00", "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -281826,6 +281858,7 @@ }, "access_granted_at": "2023-05-16T08:47:09.000-07:00", "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -293700,7 +293733,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } ] }, @@ -293714,7 +293748,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } }, "label": { @@ -304236,7 +304271,7 @@ }, "billing-usage-report-year": { "name": "year", - "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2023`.", + "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year.", "in": "query", "required": false, "schema": { diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index 16df520a5f..1dd5a4370e 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -3243,11 +3243,14 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. @@ -3855,7 +3858,7 @@ paths: get: summary: Get billing usage report for an enterprise description: |- - Gets a report of the total usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. + Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center. **Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform)." tags: @@ -3871,7 +3874,8 @@ paths: - "$ref": "#/components/parameters/billing-usage-report-day" - "$ref": "#/components/parameters/billing-usage-report-hour" - name: cost_center_id - description: The ID corresponding to a cost center. + description: The ID corresponding to a cost center. The default value is no + cost center. in: query required: false schema: @@ -6504,6 +6508,10 @@ paths: Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization. deprecated: true + deploy_keys_enabled_for_repositories: + type: boolean + description: Controls whether or not deploy keys may be added and + used for repositories in the organization. examples: default: value: @@ -10697,7 +10705,7 @@ paths: Gets information about an organization's Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. @@ -10742,9 +10750,12 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. Only organization owners can view assigned seats. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot @@ -10805,13 +10816,13 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for all users within each specified team. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -10854,7 +10865,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for members of the + specified team(s). properties: seats_created: type: integer @@ -10888,15 +10900,17 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for all members of each team specified. - This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all members of each team specified to "pending cancellation". + This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -10936,7 +10950,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for members of the specified team(s). properties: seats_cancelled: type: integer @@ -10972,13 +10987,13 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for each user specified. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -11021,7 +11036,7 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for the specified user(s). properties: seats_created: type: integer @@ -11055,15 +11070,17 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for each user specified. - This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all users specified to "pending cancellation". + This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -11103,7 +11120,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for the specified users. properties: seats_cancelled: type: integer @@ -13924,7 +13942,10 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + + The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only organization owners can view Copilot seat assignment details for members of their organization. @@ -78929,6 +78950,11 @@ components: type: string format: date-time nullable: true + deploy_keys_enabled_for_repositories: + type: boolean + example: false + description: Controls whether or not deploy keys may be added and used for + repositories in the organization. required: - login - url @@ -81366,6 +81392,10 @@ components: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -81389,6 +81419,7 @@ components: - permissions - created_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -81441,6 +81472,10 @@ components: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -81463,6 +81498,7 @@ components: - permissions - access_granted_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -93258,6 +93294,8 @@ components: last_used: type: string nullable: true + enabled: + type: boolean required: - id - key @@ -99434,6 +99472,8 @@ components: format: uri verified: type: boolean + enabled: + type: boolean required: - id - key @@ -103983,6 +104023,10 @@ components: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -104008,6 +104052,7 @@ components: - repositories - created_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -208632,6 +208677,7 @@ components: web_commit_signoff_required: false updated_at: '2014-03-03T18:58:10Z' archived_at: + deploy_keys_enabled_for_repositories: false dependency_graph_enabled_for_new_repositories: false dependabot_alerts_enabled_for_new_repositories: false dependabot_security_updates_enabled_for_new_repositories: false @@ -211501,6 +211547,7 @@ components: metadata: read created_at: '2023-05-16T08:47:09.000-07:00' token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -211535,6 +211582,7 @@ components: metadata: read access_granted_at: '2023-05-16T08:47:09.000-07:00' token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -221640,6 +221688,7 @@ components: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true deploy-key: value: id: 1 @@ -221651,6 +221700,7 @@ components: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true label: value: id: 208045946 @@ -230822,7 +230872,7 @@ components: name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, - `2023`. + `2024`. Default value is the current year. in: query required: false schema: diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index 53423edf5b..ed2d1bc0d7 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -4577,7 +4577,7 @@ "/enterprises/{enterprise}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -5433,7 +5433,7 @@ "/enterprises/{enterprise}/settings/billing/usage": { "get": { "summary": "Get billing usage report for an enterprise", - "description": "Gets a report of the total usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.\n\n**Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform).\"", + "description": "Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center.\n\n**Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform).\"", "tags": [ "billing" ], @@ -5460,7 +5460,7 @@ }, { "name": "cost_center_id", - "description": "The ID corresponding to a cost center.", + "description": "The ID corresponding to a cost center. The default value is no cost center.", "in": "query", "required": false, "schema": { @@ -9009,6 +9009,10 @@ "type": "boolean", "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "deprecated": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, @@ -14683,7 +14687,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -14740,7 +14744,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.\nOnly organization owners can view assigned seats.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -14823,7 +14827,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -14878,7 +14882,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for members of the specified team(s).", "properties": { "seats_created": { "type": "integer" @@ -14923,7 +14927,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -14978,7 +14982,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", "properties": { "seats_cancelled": { "type": "integer" @@ -15025,7 +15029,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can add Copilot seats for their organization members.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response will contain the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -15080,7 +15084,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for the specified user(s).", "properties": { "seats_created": { "type": "integer" @@ -15125,7 +15129,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\n\nFor more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response will contain the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -15180,7 +15184,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", "properties": { "seats_cancelled": { "type": "integer" @@ -19154,7 +19158,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -108111,6 +108115,11 @@ "type": "string", "format": "date-time", "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ @@ -111188,6 +111197,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -111212,6 +111225,7 @@ "permissions", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -111274,6 +111288,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -111297,6 +111315,7 @@ "permissions", "access_granted_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -126595,6 +126614,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -134725,6 +134747,9 @@ }, "verified": { "type": "boolean" + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -140723,6 +140748,10 @@ "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -140749,6 +140778,7 @@ "repositories", "created_at", "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -278450,6 +278480,7 @@ "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z", "archived_at": null, + "deploy_keys_enabled_for_repositories": false, "dependency_graph_enabled_for_new_repositories": false, "dependabot_alerts_enabled_for_new_repositories": false, "dependabot_security_updates_enabled_for_new_repositories": false, @@ -281784,6 +281815,7 @@ }, "created_at": "2023-05-16T08:47:09.000-07:00", "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -281826,6 +281858,7 @@ }, "access_granted_at": "2023-05-16T08:47:09.000-07:00", "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -293700,7 +293733,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } ] }, @@ -293714,7 +293748,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } }, "label": { @@ -304236,7 +304271,7 @@ }, "billing-usage-report-year": { "name": "year", - "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2023`.", + "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year.", "in": "query", "required": false, "schema": { diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index 16df520a5f..1dd5a4370e 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -3243,11 +3243,14 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. @@ -3855,7 +3858,7 @@ paths: get: summary: Get billing usage report for an enterprise description: |- - Gets a report of the total usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. + Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center. **Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform)." tags: @@ -3871,7 +3874,8 @@ paths: - "$ref": "#/components/parameters/billing-usage-report-day" - "$ref": "#/components/parameters/billing-usage-report-hour" - name: cost_center_id - description: The ID corresponding to a cost center. + description: The ID corresponding to a cost center. The default value is no + cost center. in: query required: false schema: @@ -6504,6 +6508,10 @@ paths: Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization. deprecated: true + deploy_keys_enabled_for_repositories: + type: boolean + description: Controls whether or not deploy keys may be added and + used for repositories in the organization. examples: default: value: @@ -10697,7 +10705,7 @@ paths: Gets information about an organization's Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. @@ -10742,9 +10750,12 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. Only organization owners can view assigned seats. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot @@ -10805,13 +10816,13 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for all users within each specified team. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -10854,7 +10865,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for members of the + specified team(s). properties: seats_created: type: integer @@ -10888,15 +10900,17 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for all members of each team specified. - This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all members of each team specified to "pending cancellation". + This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -10936,7 +10950,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for members of the specified team(s). properties: seats_cancelled: type: integer @@ -10972,13 +10987,13 @@ paths: > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for each user specified. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -11021,7 +11036,7 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for the specified user(s). properties: seats_created: type: integer @@ -11055,15 +11070,17 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for each user specified. - This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all users specified to "pending cancellation". + This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -11103,7 +11120,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for the specified users. properties: seats_cancelled: type: integer @@ -13924,7 +13942,10 @@ paths: > [!NOTE] > This endpoint is in public preview and is subject to change. - Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + + The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only organization owners can view Copilot seat assignment details for members of their organization. @@ -78929,6 +78950,11 @@ components: type: string format: date-time nullable: true + deploy_keys_enabled_for_repositories: + type: boolean + example: false + description: Controls whether or not deploy keys may be added and used for + repositories in the organization. required: - login - url @@ -81366,6 +81392,10 @@ components: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -81389,6 +81419,7 @@ components: - permissions - created_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -81441,6 +81472,10 @@ components: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -81463,6 +81498,7 @@ components: - permissions - access_granted_at - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -93258,6 +93294,8 @@ components: last_used: type: string nullable: true + enabled: + type: boolean required: - id - key @@ -99434,6 +99472,8 @@ components: format: uri verified: type: boolean + enabled: + type: boolean required: - id - key @@ -103983,6 +104023,10 @@ components: description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -104008,6 +104052,7 @@ components: -{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}