From edd4b7d9a38fd6ca56b572c2f2d7a93ec5d9c030 Mon Sep 17 00:00:00 2001 From: hubwriter Date: Mon, 20 May 2024 11:53:23 +0100 Subject: [PATCH] Improve scannability of "Managing access for Copilot in your organization" (#50530) Co-authored-by: Sarah Edwards --- ...-and-setting-up-github-copilot-business.md | 2 +- ...ling-github-copilot-enterprise-features.md | 16 ++- ...opilot-for-members-of-your-organization.md | 90 ++++++++++++ .../index.md | 4 +- ...access-for-copilot-in-your-organization.md | 131 ------------------ ...for-github-copilot-in-your-organization.md | 39 ++++++ ...rprises-audit-logs-for-copilot-business.md | 2 +- ...opilot-for-members-of-your-organization.md | 46 ++++++ content/copilot/quickstart.md | 6 +- 9 files changed, 195 insertions(+), 141 deletions(-) create mode 100644 content/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md delete mode 100644 content/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-in-your-organization.md create mode 100644 content/copilot/managing-github-copilot-in-your-organization/reviewing-usage-data-for-github-copilot-in-your-organization.md create mode 100644 content/copilot/managing-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md diff --git a/content/copilot/copilot-business/enabling-and-setting-up-github-copilot-business.md b/content/copilot/copilot-business/enabling-and-setting-up-github-copilot-business.md index e87baee478..55ccbac147 100644 --- a/content/copilot/copilot-business/enabling-and-setting-up-github-copilot-business.md +++ b/content/copilot/copilot-business/enabling-and-setting-up-github-copilot-business.md @@ -45,7 +45,7 @@ Once an enterprise owner has enabled {% data variables.product.prodname_copilot_ ## Assigning {% data variables.product.prodname_copilot %} seats -To give people or teams within your organization access to {% data variables.product.prodname_copilot %}, you need to assign them a {% data variables.product.prodname_copilot %} seat. {% ifversion ghec %}Once a {% data variables.product.prodname_ghe_cloud %} admin enables a {% data variables.product.prodname_copilot_business_short %} subscription in your organization, you can assign {% data variables.product.prodname_copilot %} seats to individuals and teams in your organization.{% endif %} To enable access for all current and future users in your organization, or specific users in your organization, follow the steps in "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-in-your-organization)." +To give people or teams within your organization access to {% data variables.product.prodname_copilot %}, you need to assign them a {% data variables.product.prodname_copilot %} seat. {% ifversion ghec %}Once a {% data variables.product.prodname_ghe_cloud %} admin enables a {% data variables.product.prodname_copilot_business_short %} subscription in your organization, you can assign {% data variables.product.prodname_copilot %} seats to individuals and teams in your organization.{% endif %} To enable access for all current and future users in your organization, or specific users in your organization, follow the steps in "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization)." ## Configuring network settings diff --git a/content/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features.md b/content/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features.md index 78165762c9..13c487aafc 100644 --- a/content/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features.md +++ b/content/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features.md @@ -17,7 +17,7 @@ To enable users to use {% data variables.product.prodname_copilot_enterprise_sho Access to {% data variables.product.prodname_copilot_short %} is determined at the enterprise and organization levels: - Enterprise owners can allow some or all of the organizations in the enterprise to access {% data variables.product.prodname_copilot_short %}. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-copilot-in-your-enterprise#managing-access-to-github-copilot-in-your-enterprise)." -- Owners of organizations that have been granted access to {% data variables.product.prodname_copilot_short %} can assign {% data variables.product.prodname_copilot_enterprise %} seats to some or all members of their organization. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-in-your-organization)." +- Owners of organizations that have been granted access to {% data variables.product.prodname_copilot_short %} can assign {% data variables.product.prodname_copilot_enterprise %} seats to some or all members of their organization. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization)." When access to {% data variables.product.prodname_copilot_short %} has been enabled, features such as the ability to use {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}, can be configured. Features are enabled or disabled at the enterprise or organization level: @@ -40,9 +40,17 @@ An enterprise owner can choose whether to enable {% data variables.product.prodn ## Enabling or disabling {% data variables.product.prodname_copilot_enterprise_short %} features for an organization -To give people or teams within your organization access to {% data variables.product.prodname_copilot_enterprise %}, you need to assign them a {% data variables.product.prodname_copilot %} seat. Once a {% data variables.product.prodname_ghe_cloud %} admin enables a {% data variables.product.prodname_copilot_enterprise_short %} subscription in your organization, you can assign {% data variables.product.prodname_copilot %} seats to individuals and teams in your organization. To enable access for all current and future users in your organization, or specific users in your organization, follow the steps in "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-in-your-organization#configuring-access-to-github-copilot-in-your-organization)." +Organization owners can enable or disable {% data variables.product.prodname_copilot_enterprise_short %} for all members of their organization that have access to {% data variables.product.prodname_copilot_enterprise_short %}, provided no specific policy has been set to enable or disable {% data variables.product.prodname_copilot_enterprise_short %} at the enterprise level. -If your organization's parent enterprise has selected **No policy** for "{% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %}" in the enterprise settings, {% data variables.product.prodname_copilot_enterprise %} will be disabled by default for your organization. If you are an owner of the organization, you can choose to enable or disable the additional features provided by {% data variables.product.prodname_copilot_enterprise %} for all of the organization's members who have access to {% data variables.product.prodname_copilot_short %}. +### Granting access to {% data variables.product.prodname_copilot_short %} + +To give members of your organization access to the features of {% data variables.product.prodname_copilot_enterprise_short %} those members must have access to {% data variables.product.prodname_copilot_short %}. This is achieved by assigning seats for {% data variables.product.prodname_copilot_short %}. Once a {% data variables.product.prodname_ghe_cloud %} admin enables a {% data variables.product.prodname_copilot_enterprise_short %} subscription in your organization, you can assign {% data variables.product.prodname_copilot %} seats to individuals and teams in the organization. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization#configuring-access-to-github-copilot-in-your-organization)." + +### Enabling or disabling {% data variables.product.prodname_copilot_enterprise_short %} + +{% data variables.product.prodname_copilot_enterprise_short %} can be enabled or disabled at either the enterprise or organization level. + +If your organization's parent enterprise has selected **No policy** for "{% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %}" in the enterprise settings, {% data variables.product.prodname_copilot_enterprise %} will initially be disabled for your organization. If you are an owner of the organization, you can choose to enable the additional features provided by {% data variables.product.prodname_copilot_enterprise %} for all of the organization's members who have access to {% data variables.product.prodname_copilot_short %}. {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} @@ -50,7 +58,7 @@ If your organization's parent enterprise has selected **No policy** for "{% data {% note %} - **Note:** If the side panel only contains the **Access** option under **{% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %}**, you need to allow the organization to assign {% data variables.product.prodname_copilot_short %} seats. Complete the steps for configuring {% data variables.product.prodname_copilot_short %} access in "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-in-your-organization#configuring-access-to-github-copilot-in-your-organization)" and then return to this procedure. + **Note:** If the side panel only contains the **Access** option under **{% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %}**, it indicates that {% data variables.product.prodname_copilot_short %} is not currently available in the organization. An enterprise admin must enable {% data variables.product.prodname_copilot_short %} for your organization. See "[AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-copilot-in-your-enterprise#managing-access-to-github-copilot-in-your-enterprise)." After {% data variables.product.prodname_copilot_short %} is enabled for the organization, return to this procedure. {% endnote %} diff --git a/content/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md b/content/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md new file mode 100644 index 0000000000..d775c34bba --- /dev/null +++ b/content/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md @@ -0,0 +1,90 @@ +--- +title: Granting access to Copilot for members of your organization +shortTitle: Granting access +intro: 'Grant access to {% data variables.product.prodname_copilot %} for some or all of the members of your organization.' +permissions: Organization owners for organizations with a subscription to {% ifversion ghec %}{% data variables.product.prodname_copilot_enterprise_short %} or{% endif %} {% data variables.product.prodname_copilot_business_short %}. +versions: + feature: copilot +redirect_from: + - /copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-in-your-organization + - /copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-business-in-your-organization + - /copilot/managing-copilot-for-business/managing-access-for-copilot-for-business-in-your-organization + - /copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization +topics: + - Copilot +--- + +## Configuring access to {% data variables.product.prodname_copilot %} in your organization + +{% ifversion ghec %}After a {% data variables.product.prodname_dotcom %} enterprise owner enables {% data variables.product.prodname_copilot_enterprise_short %} or {% data variables.product.prodname_copilot_business_short %} for an organization, an owner of that organization can grant {% data variables.product.prodname_copilot %} access to members of their organization.{% else %}After setting up a {% data variables.product.prodname_copilot_business_short %} subscription, an organization owner grant {% data variables.product.prodname_copilot %} access to members of their organization.{% endif %} + +Billing for {% data variables.product.prodname_copilot %} starts when you grant an organization member access, irrespective of when they first use {% data variables.product.prodname_copilot_short %}. If you grant an organization member access midway through a billing cycle, the cost is prorated for the remainder of the cycle. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)." + +## Granting access to {% data variables.product.prodname_copilot %} for all current and future users in your organization + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.copilot.access-settings %} +1. If the **Allow this organization to assign seats** button is displayed, click this button. +1. If you see the message "Configure code policies to start adding seats": + 1. Click **Go to policies**. + 1. Set any policies that are currently set to "Unconfigured". + 1. In the left sidebar, click **Access**. +1. Under {% ifversion ghec %}"{% data variables.product.prodname_copilot_enterprise_short %} is active in your organization" or {% endif %}"{% data variables.product.prodname_copilot_business_short %} is active in your organization," to enable {% data variables.product.prodname_copilot %} for all current and future users in your organization, select **Enabled For: All members of the organization**. +1. In the "Confirm seats purchase" dialog, to confirm that you want to enable {% data variables.product.prodname_copilot %} for all current and future users in your organization, click **Purchase seats**. + +## Granting access to {% data variables.product.prodname_copilot %} for specific users in your organization + +{% ifversion ghec %} +{% note %} + +**Note:** You can automatically enable access for every member of a group in your identity provider (IdP) by synchronizing that group with a {% data variables.product.prodname_dotcom %} team, then giving that team access to {% data variables.product.prodname_copilot %}. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." + +{% endnote %} +{% endif %} + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.copilot.access-settings %} +1. If the **Allow this organization to assign seats** button is displayed, click this button. +1. If you see the message "Configure code policies to start adding seats": + 1. Click **Go to policies**. + 1. Set any policies that are currently set to "Unconfigured". + 1. In the left sidebar, click **Access**. +1. Under {% ifversion ghec %}"{% data variables.product.prodname_copilot_enterprise_short %} is active in your organization" or {% endif %}"{% data variables.product.prodname_copilot_business_short %} is active in your organization," to enable {% data variables.product.prodname_copilot %} for selected teams or users in your organization, select **Enabled For: Selected members**. +1. If you are updating user access from the **Enabled For: All members of the organization** setting, in the "Confirm policy update" dialog, select how you want to start assigning access. + - To unassign all members and then select those who should have access, select **Start from scratch**. + - To keep all members who currently have access and then select those who should not have access, select **Renew seats**. +1. Click **Assign {% data variables.product.prodname_copilot_short %} seats**. +1. In the "Enable Copilot access for users and teams" dialog, click one of the two tabs. + + ![Screenshot of the "enable access for selected members" dialog.](/assets/images/help/copilot/enable-access-for-selected-members.png) + + - Click **Users and teams** to search for and add individual users or teams. + + To search for a user, type their username or full name in the search bar. If you select a user who is not currently a member of your organization, they will be invited to join your organization when you click **Continue to purchase** followed by **Purchase seats**. + + - Click **Upload CSV** to add users in bulk by uploading a CSV file. + + To add members in bulk, click **Choose CSV to upload**, and then upload a CSV file including either the username or email address for each member you want to add, separated by a comma. The file can contain a mixture of usernames and email addresses. + + {% warning %} + + **Warning:** When you upload a CSV file, unless you're using {% data variables.product.prodname_emus %}, {% data variables.product.prodname_copilot %} will search all users on {% data variables.product.prodname_dotcom_the_website %} for matches. If the CSV includes users who are not members of your organization, they will be invited to join your organization when you click **Continue to purchase** followed by **Purchase seats**. This warning does not apply to accounts using {% data variables.product.prodname_emus %}. + + {% endwarning %} + + Review the list of users generated from your CSV file. Clear the selection of any users you do not want to add. + +1. Click **Continue to purchase**, then click **Purchase seats**. + +## Using the API to grant access to {% data variables.product.prodname_copilot %} + +You can use {% data variables.product.prodname_dotcom %}'s REST API to grant access to {% data variables.product.prodname_copilot %} for teams, or specific users, in your organization. See "[Add teams to the Copilot subscription for an organization](/rest/copilot/copilot-user-management?apiVersion=2022-11-28#add-teams-to-the-copilot-subscription-for-an-organization)" and "[Add users to the Copilot subscription for an organization](/rest/copilot/copilot-user-management?apiVersion=2022-11-28#add-users-to-the-copilot-subscription-for-an-organization)." + +## Further reading + +- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center) +- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization)" +- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/reviewing-usage-data-for-github-copilot-in-your-organization)" +- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)" diff --git a/content/copilot/managing-github-copilot-in-your-organization/index.md b/content/copilot/managing-github-copilot-in-your-organization/index.md index d1de2c0b37..eba327321d 100644 --- a/content/copilot/managing-github-copilot-in-your-organization/index.md +++ b/content/copilot/managing-github-copilot-in-your-organization/index.md @@ -8,7 +8,9 @@ topics: - Copilot - CLI children: - - /managing-access-for-copilot-in-your-organization + - /granting-access-to-copilot-for-members-of-your-organization + - /revoking-access-to-copilot-for-members-of-your-organization + - /reviewing-usage-data-for-github-copilot-in-your-organization - /managing-policies-and-features-for-copilot-in-your-organization - /configuring-content-exclusions-for-github-copilot - /reviewing-your-organization-or-enterprises-audit-logs-for-copilot-business diff --git a/content/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-in-your-organization.md b/content/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-in-your-organization.md deleted file mode 100644 index af127ebfcc..0000000000 --- a/content/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-in-your-organization.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -title: Managing access for Copilot in your organization -intro: 'Learn how to manage access to {% ifversion ghec %}{% data variables.product.prodname_copilot_enterprise_short %} and{% endif %} {% data variables.product.prodname_copilot_business_short %} in your organization, and review usage data to inform your decisions.' -permissions: '{% ifversion ghec %} Enterprise owners can administer access to {% data variables.product.prodname_copilot %} for organizations within the enterprise.{% endif %} Organization owners can configure access to {% data variables.product.prodname_copilot %} for members of their organization. Organization owners can also access usage data relating to {% data variables.product.prodname_copilot %} in their organization and use that data to make informed decisions about seat assignment.' -versions: - feature: copilot -redirect_from: - - /copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-business-in-your-organization - - /copilot/managing-copilot-for-business/managing-access-for-copilot-for-business-in-your-organization - - /copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization -topics: - - Copilot -shortTitle: Managing access ---- - -## About managing access to {% data variables.product.prodname_copilot %} in your organization - -{% ifversion ghec %}{% data variables.product.prodname_copilot_enterprise %} and {% endif %}{% data variables.product.prodname_copilot_for_business %} {% ifversion ghec %}are{% else %}is a{% endif %} {% data variables.product.prodname_copilot %} subscription{% ifversion ghec %}s{% endif %}, billed and administered at the organization {% ifversion ghec %}or enterprise {% endif %}level. {% ifversion ghec %} - -Enterprise owners can enable or disable {% data variables.product.prodname_copilot %} for organizations within their enterprise. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-copilot-in-your-enterprise#managing-access-to-github-copilot-in-your-enterprise)." - -{% endif %}Organization owners can administer access to {% data variables.product.prodname_copilot_short %} for teams and individuals within the organization. Organization owners can also access usage data relating to {% data variables.product.prodname_copilot %} in their organization, and use that data to make informed decisions about seat assignment. - -Organization{% ifversion ghec %} and enterprise{% endif %} owners can manage various policies for {% data variables.product.prodname_copilot_short %}, such as whether to allow or block suggestions that match public code. For more information{% ifversion ghec %} about managing policies at the organization level{% endif %}, see "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization)."{% ifversion ghec %} For more information about managing policies at the enterprise level, see "[AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-copilot-in-your-enterprise)" {% endif %} - -## Configuring access to {% data variables.product.prodname_copilot %} in your organization - -{% ifversion ghec %}After a {% data variables.product.prodname_dotcom %} enterprise owner has enabled a {% data variables.product.prodname_copilot_enterprise_short %} or {% data variables.product.prodname_copilot_business_short %} subscription for an organization, an owner of that organization can assign {% data variables.product.prodname_copilot %} seats to individuals and teams in the organization.{% else %}After setting up a {% data variables.product.prodname_copilot_business_short %} subscription, an organization owner can manage their organization members' access to {% data variables.product.prodname_copilot %}.{% endif %} Granting access to {% data variables.product.prodname_copilot %} requires a seat for each organization member you want to include. - -### Enabling access to {% data variables.product.prodname_copilot %} for all current and future users in your organization - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.copilot.access-settings %} -1. If the **Allow this organization to assign seats** button is displayed, click this button. -1. If you see the message "Configure code policies to start adding seats": - 1. Click **Go to policies**. - 1. Set any policies that are currently set to "Unconfigured". - 1. In the left sidebar, click **Access**. -1. Under {% ifversion ghec %}"{% data variables.product.prodname_copilot_enterprise_short %} is active in your organization" or {% endif %}"{% data variables.product.prodname_copilot_business_short %} is active in your organization," to enable {% data variables.product.prodname_copilot %} for all current and future users in your organization, select **Enabled For: All members of the organization**. -1. In the "Confirm seats purchase" dialog, to confirm that you want to enable {% data variables.product.prodname_copilot %} for all current and future users in your organization, click **Purchase seats**. - -### Enabling access to {% data variables.product.prodname_copilot %} for specific users in your organization - -{% ifversion ghec %} -{% note %} - -**Note:** You can automatically enable access for every member of a group in your identity provider (IdP) by synchronizing that group with a {% data variables.product.prodname_dotcom %} team, then giving that team access to {% data variables.product.prodname_copilot %}. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." - -{% endnote %} -{% endif %} - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.copilot.access-settings %} -1. If the **Allow this organization to assign seats** button is displayed, click this button. -1. If you see the message "Configure code policies to start adding seats": - 1. Click **Go to policies**. - 1. Set any policies that are currently set to "Unconfigured". - 1. In the left sidebar, click **Access**. -1. Under {% ifversion ghec %}"{% data variables.product.prodname_copilot_enterprise_short %} is active in your organization" or {% endif %}"{% data variables.product.prodname_copilot_business_short %} is active in your organization," to enable {% data variables.product.prodname_copilot %} for selected teams or users in your organization, select **Enabled For: Selected members**. -1. If you are updating user access from the **Enabled For: All members of the organization** setting, in the "Confirm policy update" dialog, select how you want to start assigning access. - - To unassign all members and then select those who should have access, select **Start from scratch**. - - To keep all members who currently have access and then select those who should not have access, select **Renew seats**. -1. Click **Assign {% data variables.product.prodname_copilot_short %} seats**. -1. In the "Enable Copilot access for users and teams" dialog, click one of the two tabs. - - ![Screenshot of the "enable access for selected members" dialog.](/assets/images/help/copilot/enable-access-for-selected-members.png) - - - Click **Users and teams** to search for and add individual users or teams. - - To search for a user, type their username or full name in the search bar. If you select a user who is not currently a member of your organization, they will be invited to join your organization when you click **Continue to purchase** followed by **Purchase seats**. - - - Click **Upload CSV** to add users in bulk by uploading a CSV file. - - To add members in bulk, click **Choose CSV to upload**, and then upload a CSV file including either the username or email address for each member you want to add, separated by a comma. The file can contain a mixture of usernames and email addresses. - - {% warning %} - - **Warning:** When you upload a CSV file, unless you're using {% data variables.product.prodname_emus %}, {% data variables.product.prodname_copilot %} will search all users on {% data variables.product.prodname_dotcom_the_website %} for matches. If the CSV includes users who are not members of your organization, they will be invited to join your organization when you click **Continue to purchase** followed by **Purchase seats**. This warning does not apply to accounts using {% data variables.product.prodname_emus %}. - - {% endwarning %} - - Review the list of users generated from your CSV file. Clear the selection of any users you do not want to add. - -1. Click **Continue to purchase**, then click **Purchase seats**. - -### Revoking access to {% data variables.product.prodname_copilot %} for your whole organization - -{% data reusables.copilot.disable-copilot-organization %} - -### Revoking access to {% data variables.product.prodname_copilot %} for specific users in your organization - -Removing a user from the organization(s) that had assigned them a {% data variables.product.prodname_copilot %} seat will automatically unassign the seat from them. Alternatively, you can unassign a member's {% data variables.product.prodname_copilot %} seat while preserving their membership. These changes will take effect at the beginning of the next billing cycle. - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.copilot.access-settings %} -1. Under {% ifversion ghec %}"{% data variables.product.prodname_copilot_enterprise_short %} is active in your organization" or {% endif %}"{% data variables.product.prodname_copilot_business_short %} is active in your organization," select **Enabled For: selected members**. - - - In the "Confirm policy update" dialog, click **Renew seats**. - -1. Under "Access management," in the search bar, type the member's username or full name. -1. To remove the member from the list of users who have access to {% data variables.product.prodname_copilot %}, select the checkbox to the left of their username, then click **Cancel seat**. - - ![Screenshot of the Access management section, with a user selected and the 'Cancel seat' button highlighted.](/assets/images/help/copilot/cancel-copilot-seat.png) - -1. In the "Confirm seat removal" dialog, click **Remove seats**. - -## Reviewing usage data for {% data variables.product.prodname_copilot %} in your organization - -You can review usage data for {% data variables.product.prodname_copilot %} in your organization to help you make informed decisions about seat assignment. - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.copilot.access-settings %} -1. At the top of the page, under "{% data variables.product.prodname_copilot %}," you can see an overview of your organization's {% data variables.product.prodname_copilot %} usage. You can see the number seats assigned through your {% ifversion ghec %}{% data variables.product.prodname_copilot_enterprise_short %} or {% endif %}{% data variables.product.prodname_copilot_business_short %} subscription, and the estimated monthly cost. - - {% ifversion ghec %} - ![Screenshot of the {% data variables.product.prodname_copilot %} usage overview.](/assets/images/help/copilot/copilot-usage-overview-enterprise.png) - {% else %} - ![Screenshot of the {% data variables.product.prodname_copilot %} usage overview.](/assets/images/help/copilot/copilot-usage-overview.png) - {% endif %} - -1. For more detailed information, next to "Access management," click **Get report**. - - {% data variables.product.prodname_dotcom %} will generate a report for you, which you can download as a CSV file. -1. Alternatively, under "Access management," you can use the **Sort** options to sort the list of users by when they last used {% data variables.product.prodname_copilot %}. - -## Further reading - -- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center) diff --git a/content/copilot/managing-github-copilot-in-your-organization/reviewing-usage-data-for-github-copilot-in-your-organization.md b/content/copilot/managing-github-copilot-in-your-organization/reviewing-usage-data-for-github-copilot-in-your-organization.md new file mode 100644 index 0000000000..3253a932a4 --- /dev/null +++ b/content/copilot/managing-github-copilot-in-your-organization/reviewing-usage-data-for-github-copilot-in-your-organization.md @@ -0,0 +1,39 @@ +--- +title: Reviewing usage data for GitHub Copilot in your organization +shortTitle: Usage data +intro: 'Review {% data variables.product.prodname_copilot %} usage in your organization to make informed decisions about seat assignment.' +permissions: Organization owners for organizations with a subscription to {% ifversion ghec %}{% data variables.product.prodname_copilot_enterprise_short %} or{% endif %} {% data variables.product.prodname_copilot_business_short %}. +versions: + feature: copilot +topics: + - Copilot +--- + +## Reviewing usage data for {% data variables.product.prodname_copilot %} in your organization + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.copilot.access-settings %} +1. At the top of the page, under "{% data variables.product.prodname_copilot %}," you can see an overview of your organization's {% data variables.product.prodname_copilot %} usage. You can see the number seats assigned through your {% ifversion ghec %}{% data variables.product.prodname_copilot_enterprise_short %} or {% endif %}{% data variables.product.prodname_copilot_business_short %} subscription, and the estimated monthly cost. + + {% ifversion ghec %} + ![Screenshot of the {% data variables.product.prodname_copilot %} usage overview.](/assets/images/help/copilot/copilot-usage-overview-enterprise.png) + {% else %} + ![Screenshot of the {% data variables.product.prodname_copilot %} usage overview.](/assets/images/help/copilot/copilot-usage-overview.png) + {% endif %} + +1. For more detailed information, next to "Access management," click **Get report**. + + {% data variables.product.prodname_dotcom %} generates a report for you, which you can download as a CSV file. + +1. Alternatively, under "Access management," you can use the **Sort** options to sort the list of users by when they last used {% data variables.product.prodname_copilot %}. + +## Using the API to retrieve assignment information + +You can use {% data variables.product.prodname_dotcom %}'s REST API to get details about the assignment of {% data variables.product.prodname_copilot %} seats in your organization. See "[Get Copilot seat information and settings for an organization](/rest/copilot/copilot-user-management?apiVersion=2022-11-28#get-copilot-seat-information-and-settings-for-an-organization)," "[List all Copilot seat assignments for an organization](/rest/copilot/copilot-user-management?apiVersion=2022-11-28#list-all-copilot-seat-assignments-for-an-organization)," and "[Get Copilot seat assignment details for a user](/rest/copilot/copilot-user-management?apiVersion=2022-11-28#get-copilot-seat-assignment-details-for-a-user)." + +## Further reading + +- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center) +- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization)." +- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)" diff --git a/content/copilot/managing-github-copilot-in-your-organization/reviewing-your-organization-or-enterprises-audit-logs-for-copilot-business.md b/content/copilot/managing-github-copilot-in-your-organization/reviewing-your-organization-or-enterprises-audit-logs-for-copilot-business.md index b82bf052b9..1db0ba11cc 100644 --- a/content/copilot/managing-github-copilot-in-your-organization/reviewing-your-organization-or-enterprises-audit-logs-for-copilot-business.md +++ b/content/copilot/managing-github-copilot-in-your-organization/reviewing-your-organization-or-enterprises-audit-logs-for-copilot-business.md @@ -1,5 +1,6 @@ --- title: Reviewing your organization{% ifversion ghec%} or enterprise{% endif %}'s audit logs for Copilot Business +shortTitle: Audit logs intro: 'Review the audit logs for your {% data variables.product.prodname_copilot_business_short %} subscription to understand what actions have been taken and by which users.' allowTitleToDifferFromFilename: true redirect_from: @@ -11,7 +12,6 @@ product: '{% data reusables.gated-features.copilot-audit-logs %}' permissions: 'Organization{% ifversion ghec %} and enterprise{% endif %} owners can interact with the audit log.' topics: - Copilot -shortTitle: Audit logs --- ## About audit logs for {% data variables.product.prodname_copilot_business_short %} diff --git a/content/copilot/managing-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md b/content/copilot/managing-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md new file mode 100644 index 0000000000..e4a1ea76fa --- /dev/null +++ b/content/copilot/managing-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md @@ -0,0 +1,46 @@ +--- +title: Revoking access to Copilot for members of your organization +shortTitle: Revoking access +intro: 'Remove access to {% data variables.product.prodname_copilot %} for some or all of the members of your organization.' +permissions: Organization owners for organizations with a subscription to {% ifversion ghec %}{% data variables.product.prodname_copilot_enterprise_short %} or{% endif %} {% data variables.product.prodname_copilot_business_short %}. +versions: + feature: copilot +topics: + - Copilot +--- + +## How revoking access affects billing + +Revoking access takes effect from the start of the next billing cycle. If you remove a seat during a cycle, the user will have access to {% data variables.product.prodname_copilot_short %} for the remainder of the billing cycle. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)." + +## Revoking access to {% data variables.product.prodname_copilot %} for your whole organization + +{% data reusables.copilot.disable-copilot-organization %} + +## Revoking access to {% data variables.product.prodname_copilot %} for specific users in your organization + +Removing a user from the organization(s) that had granted them {% data variables.product.prodname_copilot %} access will automatically revoke their {% data variables.product.prodname_copilot %} access. Alternatively, you can revoke {% data variables.product.prodname_copilot %} access while preserving their organization membership. + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.copilot.access-settings %} +1. Under {% ifversion ghec %}"{% data variables.product.prodname_copilot_enterprise_short %} is active in your organization" or {% endif %}"{% data variables.product.prodname_copilot_business_short %} is active in your organization," select **Enabled For: selected members**. + + - In the "Confirm policy update" dialog, click **Renew seats**. + +1. Under "Access management," in the search bar, type the member's username or full name. +1. To remove the member from the list of users who have access to {% data variables.product.prodname_copilot %}, select the checkbox to the left of their username, then click **Cancel seat**. + + ![Screenshot of the Access management section, with a user selected and the 'Cancel seat' button highlighted.](/assets/images/help/copilot/cancel-copilot-seat.png) + +1. In the "Confirm seat removal" dialog, click **Remove seats**. + +## Using the API to revoke access to {% data variables.product.prodname_copilot %} + +You can use {% data variables.product.prodname_dotcom %}'s REST API to revoke access to {% data variables.product.prodname_copilot %} for teams, or specific users, in your organization. For example, you might want to write a script to automatically revoke seats for organization members who have not been using {% data variables.product.prodname_copilot_short %}. See "[Remove teams from the Copilot subscription for an organization](/rest/copilot/copilot-user-management?apiVersion=2022-11-28#remove-teams-from-the-copilot-subscription-for-an-organization)" and "[Remove users from the Copilot subscription for an organization](/rest/copilot/copilot-user-management?apiVersion=2022-11-28#remove-users-from-the-copilot-subscription-for-an-organization)." + +## Further reading + +- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center) +- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization)." +- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/reviewing-usage-data-for-github-copilot-in-your-organization)" diff --git a/content/copilot/quickstart.md b/content/copilot/quickstart.md index ecb097c0fc..6c90af9cce 100644 --- a/content/copilot/quickstart.md +++ b/content/copilot/quickstart.md @@ -67,7 +67,7 @@ As an organization owner, you can add a {% data variables.product.prodname_copil ## Signing up for {% data variables.product.prodname_copilot_for_business %} for your enterprise account -As an enterprise owner, you can add a {% data variables.product.prodname_copilot_for_business %} subscription to your enterprise account. Owners of organizations that you have enabled for {% data variables.product.prodname_copilot_short %} will then be able to assign {% data variables.product.prodname_copilot %} seats to members of their organization. For more information, see "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-in-your-organization)." +As an enterprise owner, you can add a {% data variables.product.prodname_copilot_for_business %} subscription to your enterprise account. Owners of organizations that you have enabled for {% data variables.product.prodname_copilot_short %} will then be able to assign {% data variables.product.prodname_copilot %} seats to members of their organization. For more information, see "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization)." ### Customers under a Microsoft Enterprise Agreement @@ -79,7 +79,7 @@ As an enterprise owner, you can add a {% data variables.product.prodname_copilot ## Signing up for {% data variables.product.prodname_copilot_enterprise %} for your enterprise account -As an enterprise owner, you can add a {% data variables.product.prodname_copilot_enterprise %} subscription to your enterprise account. Owners of organizations that you have enabled for {% data variables.product.prodname_copilot_short %} will then be able to assign {% data variables.product.prodname_copilot %} seats to members of their organization. For more information, see "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-in-your-organization)." +As an enterprise owner, you can add a {% data variables.product.prodname_copilot_enterprise %} subscription to your enterprise account. Owners of organizations that you have enabled for {% data variables.product.prodname_copilot_short %} will then be able to assign {% data variables.product.prodname_copilot %} seats to members of their organization. For more information, see "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization)." ### Customers under a Microsoft Enterprise Agreement @@ -152,7 +152,7 @@ As an enterprise owner, you must decide whether to allow all organizations in yo {% data reusables.copilot.next-steps %} -- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-in-your-organization)": As an organization owner, learn how to manage access to {% ifversion ghec %}{% data variables.product.prodname_copilot_enterprise_short %} or{% endif %} {% data variables.product.prodname_copilot_business_short %} in your organization. +- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization)": As an organization owner, learn how to grant access to {% ifversion ghec %}{% data variables.product.prodname_copilot_enterprise_short %} or{% endif %} {% data variables.product.prodname_copilot_business_short %} in your organization. - "[AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot)": You've learned how to get your first suggestion in {% data variables.product.prodname_vscode %}. These guides show you how to set up and navigate the various functions of {% data variables.product.prodname_copilot %} across all of the supported environments. - "[AUTOTITLE](/copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide)"{% ifversion ghec %} and "[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)"{% endif %}: Find out how to ask {% data variables.product.prodname_copilot %} for information and assistance. - [{% data variables.product.prodname_copilot %}](https://copilot.github.com/): See practical examples of how {% data variables.product.prodname_copilot %} can help you work.