[EDI] Audit and implement: /billing/how-tos/products/ generalize downloading and viewing articles (#57129)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
This commit is contained in:
Felicity Chapman
@@ -1,97 +1,62 @@
|
||||
---
|
||||
title: 'Downloading licensed use of Advanced Security'
|
||||
intro: 'You can download consumption of {% data variables.product.prodname_GHAS %} licenses by your {% data variables.enterprise.enterprise_or_org %}: volume/subscription licenses or metered usage.'
|
||||
permissions: '{% ifversion fpt %}Organization{% else %}Enterprise{% endif %} owners with {% data variables.product.prodname_AS %}'
|
||||
product: '{% data reusables.gated-features.ghas-billing %}'
|
||||
title: 'Downloading license use for your enterprise or organization'
|
||||
intro: 'Get data on consumption of {% data variables.product.github %}, {% data variables.product.prodname_copilot_short %}, and {% data variables.product.prodname_AS %} licenses.'
|
||||
permissions: '{% data reusables.permissions.enhanced-billing-enterprise %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
ghes: '*'
|
||||
topics:
|
||||
- Billing
|
||||
- Advanced Security
|
||||
- Enterprise
|
||||
shortTitle: Download GHAS license use
|
||||
shortTitle: Download license use
|
||||
allowTitleToDifferFromFilename: true
|
||||
redirect_from:
|
||||
- /billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/downloading-your-github-advanced-security-usage
|
||||
contentType: how-tos
|
||||
---
|
||||
|
||||
## Downloading {% data variables.product.prodname_AS %} license usage information
|
||||
You can download CSV files with details of paid license use through the {% data variables.product.github %} user interface or the REST API.
|
||||
|
||||
You can download a CSV file with details of paid use of {% data variables.product.prodname_GHAS %} products at both the {% data variables.enterprise.enterprise_and_org %} level. The CSV file contains information about each {% data variables.product.prodname_AS %} license that is in use, including:
|
||||
For more detailed reports on usage of all paid products, see [AUTOTITLE](/billing/how-tos/products/view-product-use).
|
||||
|
||||
* The username of the person using the {% data variables.product.prodname_GHAS_cs_or_sp %} license
|
||||
* The {% data variables.product.prodname_GH_cs_and_sp %}-enabled repositories where commits were made
|
||||
* The organizations{% ifversion secret-scanning-user-owned-repos %}{% ifversion ghec %} and user namespaces for {% data variables.product.prodname_emus %}{% endif %}{% endif %} that people using licenses belong to
|
||||
* The most recent commit dates and associated email addresses
|
||||
## On {% data variables.product.prodname_ghe_cloud %}
|
||||
|
||||
You can use this information for insights into your paid use of {% data variables.product.prodname_AS %}, such as which members of your enterprise are using a license or how licenses are being consumed across your organizations.
|
||||
1. In the upper-right corner of any page on {% data variables.product.github %}, click your profile picture.
|
||||
|
||||
You can download a CSV report of license usage through the {% data variables.product.github %} user interface or the REST API.
|
||||
1. Select the account you want to view and then access the "Billing & Licensing" pages:
|
||||
|
||||
## Using the UI to download license and metered usage
|
||||
* **Organizations**: Click **Your organizations**, then next to the organization, click **Settings**. In the organization sidebar, click **{% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} Billing & Licensing**.
|
||||
|
||||
You can download a CSV report for a repository, an organization, or an enterprise.
|
||||
* **Enterprises**: Click **Your enterprises**, then click the enterprise name. Click the **{% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} Billing & Licensing** tab at the top of the page.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
1. From the list of "Billing & licensing" pages, click {% octicon "law" aria-hidden="true" aria-label="law" %} **Licensing** to display the licensing page.
|
||||
|
||||
### For a repository
|
||||
1. In the license area of interest, click **Download CSV report**. If offered a choice, choose your preferred report.
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
1. In the "Security" section of the sidebar, select the {% data variables.product.UI_advanced_security %} dropdown menu, then click **{% data variables.product.prodname_global_settings_caps %}**.
|
||||
1. In the "{% data variables.product.prodname_GH_cs_or_sp %} repositories" section, next to the repository you want usage information for, select {% octicon "kebab-horizontal" aria-label="GHAS repository actions" %}, then click **Download CSV report**.
|
||||
The report will be emailed to the default email address associated with your {% data variables.product.github %} account. For information about the fields, see [AUTOTITLE](/billing/reference/license-reports).
|
||||
|
||||
|
||||
|
||||
### For an organization
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
1. In the "Access" section of the sidebar click **{% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} Billing and licensing** to display an overview.
|
||||
1. For metered usage, in the sidebar click **Usage**.
|
||||
1. To display only {% data variables.product.prodname_AS %} usage within the graph, click the search bar, then click **Product**. Within the list of products displayed, click **GHAS**.
|
||||
1. To further filter the usage graph, use the dropdown menus:
|
||||
* To view usage by SKU, select the **Group** dropdown, then click **SKU**. This will allow you to view usage for both {% data variables.product.prodname_GH_cs_and_sp %}.
|
||||
* To filter by time, select **Time Frame**, then click a time period.
|
||||
* Below the graph, you can see a more granular overview of the usage. Click the arrow next to a specific date to see a nested table with usage per SKU, units, price/unit, gross amount (the amount actually used), and billed amount (the amount you are charged).
|
||||
1. To download the data, click **{% octicon "download" aria-hidden="true" aria-label="download" %} Get usage report**.
|
||||
1. For license consumption, in the sidebar click **{% octicon "law" aria-hidden="true" aria-label="law" %} Licensing**.
|
||||
1. Under "{% data variables.product.prodname_GHAS %}," click the **{% octicon "download" aria-hidden="true" aria-label="download" %} Download CSV report** dropdown and then click either **{% data variables.product.prodname_code_security %}** or **{% data variables.product.prodname_secret_protection %}**.
|
||||
|
||||
### For an enterprise
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
1. Click **{% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} Billing & licensing** to display an overview.
|
||||
1. For metered usage, click {% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} **Usage**.
|
||||
1. To display only {% data variables.product.prodname_AS %} usage within the graph, click the search bar, then click **Product**. Within the list of products displayed, click **GHAS**.
|
||||
1. To further filter the usage graph, use the dropdown menus:
|
||||
* To view usage by SKU, select the **Group** dropdown, then click **SKU**. This will allow you to view usage for both {% data variables.product.prodname_GH_cs_and_sp %}.
|
||||
* To filter by time, select **Time Frame**, then click a time period.
|
||||
* Below the graph, you can see a more granular overview of the usage. Click the arrow next to a specific date to see a nested table with usage per SKU, units, price/unit, gross amount (the amount actually used), and billed amount (the amount you are charged).
|
||||
1. To download the data, click **{% octicon "download" aria-hidden="true" aria-label="download" %} Get usage report**.
|
||||
1. For license consumption, click {% octicon "law" aria-hidden="true" aria-label="law" %} **Licensing**.
|
||||
* Under "{% data variables.product.prodname_GHAS %}," click the **{% octicon "download" aria-hidden="true" aria-label="download" %} Download CSV report** dropdown and then click either **{% data variables.product.prodname_code_security %}** or **{% data variables.product.prodname_secret_protection %}**.
|
||||
|
||||
{% elsif ghes %}
|
||||
## On {% data variables.product.prodname_ghe_server %}
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.license-tab-ghes %}
|
||||
1. Under "{% data variables.product.prodname_GHAS %}," click **{% octicon "download" aria-hidden="true" aria-label="download" %} CSV report**.
|
||||
|
||||
|
||||
The page shows a summary of the licenses your enterprise is using for {% data variables.product.prodname_enterprise %} and {% data variables.product.prodname_GHAS %}. Use links on the page to view more detailed information.
|
||||
|
||||
{% endif %}
|
||||
To download a license usage report for {% data variables.product.prodname_GHAS %}:
|
||||
|
||||
## Using the REST API to download license and metered usage
|
||||
* **Enterprise**: In "{% data variables.product.prodname_GHAS %}", click {% octicon "download" aria-hidden="true" aria-label="download" %} **CSV report**.
|
||||
* **Organization**: In the "ORGANIZATION" table, click {% octicon "download" aria-label="Download CSV report" %} associated with the organization that you want to download a CSV report for.
|
||||
* **User namespace**: In the "USER NAMESPACED" table, click {% octicon "download" aria-label="Download CSV report" %} associated with the user that you want to download a CSV report for.
|
||||
* **Repository**: In the "ORGANIZATION" table, click the name of an organization to show a settings page for the organization. In the {% data variables.product.prodname_GHAS %} repositories table, click {% octicon "kebab-horizontal" aria-label="GHAS repository actions" %} and select **Download CSV report**.
|
||||
|
||||
For details of the fields included in the report, see [AUTOTITLE](/billing/reference/license-reports).
|
||||
|
||||
## Using the REST API
|
||||
|
||||
You can retrieve information on paid use of {% data variables.product.prodname_AS %} with the billing API.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
* Organization-level data (cloud only), use the `/organizations/{org}/settings/billing/usage` endpoint.{% ifversion fpt or ghec %} For more information, see [AUTOTITLE](/rest/billing/enhanced-billing?apiVersion=2022-11-28).{% endif %}
|
||||
|
||||
For organization-level data, use the `/organizations/{org}/settings/billing/usage` endpoint. For more information, see [AUTOTITLE](/rest/billing/enhanced-billing?apiVersion=2022-11-28).
|
||||
|
||||
{% endif %}
|
||||
|
||||
For enterprise-level data, use the `/enterprises/{enterprise}/settings/billing/usage` endpoint. For more information, see [AUTOTITLE](/enterprise-cloud@latest/rest/enterprise-admin/billing?apiVersion=2022-11-28#get-billing-usage-report-for-an-enterprise) in the {% data variables.product.prodname_ghe_cloud %} documentation.
|
||||
* Enterprise-level data, use the `/enterprises/{enterprise}/settings/billing/usage` endpoint. For more information, see [AUTOTITLE](/enterprise-cloud@latest/rest/enterprise-admin/billing?apiVersion=2022-11-28#get-billing-usage-report-for-an-enterprise) in the {% data variables.product.prodname_ghe_cloud %} documentation.
|
||||
|
||||
@@ -32,4 +32,3 @@ children:
|
||||
- view-ghas-committers
|
||||
contentType: how-tos
|
||||
---
|
||||
|
||||
|
||||
@@ -1,8 +1,9 @@
|
||||
---
|
||||
title: 'Managing volume licenses for GitHub Advanced Security'
|
||||
intro: 'You can monitor and control the availability and consumption of licenses for {% data variables.product.prodname_AS %} in repositories in your enterprise.'
|
||||
permissions: 'Enterprise owners with **volume/subscription licenses** for {% data variables.product.prodname_AS %}. </br>For metered usage on the new platform, see [AUTOTITLE](/billing/managing-your-billing/using-budgets-control-spending).'
|
||||
permissions: 'Enterprise owners with **volume/subscription licenses** for {% data variables.product.prodname_AS %}. </br>For metered usage, see [AUTOTITLE](/billing/managing-your-billing/using-budgets-control-spending).'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /billing/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing
|
||||
@@ -11,7 +12,8 @@ topics:
|
||||
- Billing
|
||||
- Advanced Security
|
||||
- Enterprise
|
||||
shortTitle: Manage GHAS license
|
||||
shortTitle: Manage GHAS licenses
|
||||
allowTitleToDifferFromFilename: true
|
||||
contentType: how-tos
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Viewing your usage of metered products
|
||||
intro: You can explore your use of different products that are billed by usage and see how each product contributes to your bill.
|
||||
title: Viewing your usage of metered products and licenses
|
||||
intro: Explore your use of features billed by usage on {% data variables.product.github %} cloud and see how they contribute to your bill.
|
||||
redirect_from:
|
||||
- /github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-git-large-file-storage-usage
|
||||
- /articles/viewing-storage-and-bandwidth-usage-for-a-personal-account
|
||||
@@ -31,17 +31,25 @@ redirect_from:
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '*'
|
||||
topics:
|
||||
- Billing
|
||||
shortTitle: View product use
|
||||
shortTitle: View product/license use
|
||||
allowTitleToDifferFromFilename: true
|
||||
permissions: '{% data reusables.permissions.enhanced-billing-cloud-all %}'
|
||||
product: 'Cloud only'
|
||||
contentType: how-tos
|
||||
---
|
||||
|
||||
## Viewing a summary of usage for billed products
|
||||
> [!TIP]
|
||||
> **{% data variables.product.prodname_ghe_server %}** administrators should instead see [AUTOTITLE](/billing/how-tos/products/download-ghas-license-use).
|
||||
|
||||
Anyone can view usage for their own personal account.
|
||||
## Viewing a summary of usage
|
||||
|
||||
If you are an owner or billing manager of an organization or enterprise, you will also have access to usage data for that organization or account.
|
||||
The options available to you vary according to your role and {% data variables.product.github %} plan.
|
||||
|
||||
* Anyone can view usage data for their own personal account unless their account is managed by their enterprise (EMU).
|
||||
* If you are an **owner** or **billing manager** of an enterprise, or an organization on {% data variables.product.prodname_team %}, you will also have access to usage data for that organization or enterprise account.
|
||||
|
||||
### Personal accounts
|
||||
|
||||
@@ -74,17 +82,30 @@ The metered usage chart and usage break down table both show your current choice
|
||||
|
||||
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
> [!TIP]
|
||||
> For GitHub Actions, you can also view the billable job execution minutes for an individual workflow run. For more information, see [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-job-execution-time).
|
||||
{% endif %}
|
||||
|
||||
## Downloading the data displayed
|
||||
## Downloading usage reports
|
||||
|
||||
You can download the data plotted on the billing charts shown on the "Overview" or "Usage" page as a table or an image. Click the {% octicon "kebab-horizontal" aria-label="Chart options" aria-hidden="true" %} "Chart options" button and select your preferred format.
|
||||
You can download two different types of usage report from the "Usage" page.
|
||||
|
||||
|
||||
### General usage reports
|
||||
|
||||
## Further reading
|
||||
1. At the top of the "Usage" page, click **Get usage report**.
|
||||
1. Choose the report that you want to download.
|
||||
|
||||
* [AUTOTITLE](/billing/managing-your-billing/about-billing-on-github)
|
||||
For details of the fields included in the report, see [AUTOTITLE](/billing/reference/usage-reports).
|
||||
|
||||
### Downloading the data plotted in the usage chart
|
||||
|
||||
When the chart on the "Usage" page shows the data you want to download, click the {% octicon "kebab-horizontal" aria-label="Chart options" aria-hidden="true" %} "Chart options" button and select your preferred format.
|
||||
|
||||
|
||||
|
||||
## Next steps
|
||||
|
||||
* [AUTOTITLE](/billing/reference/usage-reports){% ifversion fpt or ghec %}
|
||||
* [AUTOTITLE](/billing/managing-your-billing/using-budgets-control-spending)
|
||||
* [AUTOTITLE](/billing/managing-your-billing/automating-usage-reporting)
|
||||
* [AUTOTITLE](/billing/managing-your-billing/automating-usage-reporting){% endif %}
|
||||
|
||||
@@ -54,49 +54,7 @@ If there is no match with a SAML or SCIM attribute, or if SAML authentication or
|
||||
|
||||
The {% data variables.product.prodname_ghe_cloud %} license usage report and {% data variables.product.prodname_ghe_server %} exported license usage file include a variety of fields to help you troubleshoot license usage for your enterprise.
|
||||
|
||||
### {% data variables.product.prodname_ghe_cloud %} license usage report (CSV file)
|
||||
|
||||
The license usage report for your enterprise is a CSV file that contains the following information about members of your enterprise. Some fields are specific to your {% data variables.product.prodname_ghe_cloud %} (GHEC) deployment, {% data variables.product.prodname_ghe_server %} (GHES) connected environments, or your {% data variables.product.prodname_vs %} subscriptions (VSS) with GitHub Enterprise.
|
||||
|
||||
| Field | Description
|
||||
| ----- | -----------
|
||||
| github_com_login | The username for the user's GHEC account
|
||||
| github_com_name | The display name for the user's GHEC account
|
||||
| github_com_profile | The URL for the user's profile page on GHEC
|
||||
| github_com_user | Whether or not the user has an account on GHEC |
|
||||
| github_com_member_roles | For each of the organizations the user belongs to on GHEC, the organization name and the user's role in that organization (`Owner` or `Member`) separated by a colon<br><br>Organizations delimited by commas |
|
||||
| github_com_enterprise_role | Can be one of: `Owner`, `Member`, `Outside collaborator` (for an enterprise with personal accounts on {% data variables.product.prodname_dotcom_the_website %}), or `Repository collaborator` (for an enterprise that uses {% data variables.enterprise.prodname_managed_users %})
|
||||
| github_com_verified_domain_emails | All email addresses associated with the user's GHEC account that match your enterprise's verified domains |
|
||||
| github_com_saml_name_id | The SAML username |
|
||||
| github_com_orgs_with_pending_invites | All pending invitations for the user's GHEC account to join organizations within your enterprise |
|
||||
| {% ifversion ghas-in-license-sync %} |
|
||||
| github_com_advanced_security_license_user | Whether or not the user consumes a {% data variables.product.prodname_GHAS_cs_or_sp %} license on GHEC |
|
||||
| {% endif %} |
|
||||
| license_type | Can be one of: `Visual Studio subscription` or `Enterprise`
|
||||
| enterprise_server_user| Whether or not the user has at least one account on GHES |
|
||||
| enterprise_server_primary_emails | The primary email addresses associated with each of the user's GHES accounts |
|
||||
| enterprise_server_user_ids | For each of the user's GHES accounts, the account's user ID
|
||||
| {% ifversion ghas-in-license-sync %} |
|
||||
| enterprise_server_advanced_security_user_ids | The GHES instances where the user is using {% data variables.product.prodname_GHAS_cs_or_sp %} {% ifversion ghec %}(only present if you are using GHES version 3.12 or later, and have enabled license sync){% endif %} |
|
||||
| {% endif %} |
|
||||
| total_user_accounts | The total number of accounts the person has across both GHEC and GHES
|
||||
| visual_studio_subscription_user | Whether or not the user is a {% data variables.visual_studio.prodname_vs_subscriber %} |
|
||||
| visual_studio_subscription_email | The email address associated with the user's VSS |
|
||||
| visual_studio_license_status | Whether the Visual Studio license has been matched to a {% data variables.product.company_short %} user |
|
||||
|
||||
### {% data variables.product.prodname_ghe_server %} exported license usage (JSON file)
|
||||
|
||||
Your {% data variables.product.prodname_ghe_server %} license usage is a JSON file that is typically used when performing a manual sync of user licenses between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} deployments. The file contains the following information specific to your {% data variables.product.prodname_ghe_server %} environment.
|
||||
|
||||
| Field | Description
|
||||
| ----- | -----------
|
||||
| Features | The {% data variables.product.prodname_github_connect %} features that are enabled on your {% data variables.product.prodname_ghe_server %} instance, and the date and time of enablement.
|
||||
| Host name | The hostname of your {% data variables.product.prodname_ghe_server %} instance.
|
||||
| HTTP only | Whether Transport Layer Security (TLS) is enabled and configured on your {% data variables.product.prodname_ghe_server %} instance. Can be one of: `True` or `False`.
|
||||
| License | A hash of your {% data variables.product.prodname_ghe_server %} license.
|
||||
| Public key | The public key portion of your {% data variables.product.prodname_ghe_server %} license.
|
||||
| Server ID | UUID generated for your {% data variables.product.prodname_ghe_server %} instance.
|
||||
| Version | The version of your {% data variables.product.prodname_ghe_server %} instance.
|
||||
For details of each field, see [AUTOTITLE](/billing/reference/license-reports#github-enterprise-cloud-license-report).
|
||||
|
||||
## Troubleshooting steps
|
||||
|
||||
|
||||
@@ -18,6 +18,7 @@ children:
|
||||
- /cost-center-allocation
|
||||
- /roles-for-visual-studio
|
||||
- /license-consumption
|
||||
- /license-reports
|
||||
- /models-multipliers-and-costs
|
||||
- /enterprise-license-troubleshooting
|
||||
contentType: reference
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
title: People who consume a license in an organization
|
||||
intro: 'Learn how consumption of {% data variables.product.github %} licenses is determined for paid organizations and enterprises.'
|
||||
shortTitle: License consumption
|
||||
shortTitle: GitHub license users
|
||||
allowTitleToDifferFromFilename: true
|
||||
redirect_from:
|
||||
- /github/setting-up-and-managing-billing-and-payments-on-github/about-per-user-pricing
|
||||
- /articles/about-per-user-pricing
|
||||
|
||||
107
content/billing/reference/license-reports.md
Normal file
107
content/billing/reference/license-reports.md
Normal file
@@ -0,0 +1,107 @@
|
||||
---
|
||||
title: License reports reference
|
||||
shortTitle: License reports
|
||||
intro: 'License reports show details of the users consuming licenses that you pay for.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '*'
|
||||
topics:
|
||||
- Billing
|
||||
- Enterprise
|
||||
- Team
|
||||
permissions: '{% data reusables.permissions.enhanced-billing-enterprise %}'
|
||||
contentType: reference
|
||||
---
|
||||
|
||||
Each license report shows information about license users in your enterprise account, for {% data variables.product.prodname_copilot_short %}, or for {% data variables.product.prodname_AS %}.
|
||||
|
||||
**Cloud users** can download license reports from the {% octicon "law" aria-hidden="true" aria-label="law" %} **Licensing** page under {% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} **Billing & licensing** or using the REST API.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
* Enterprise and {% data variables.product.prodname_AS %} license users, see [AUTOTITLE](/billing/how-tos/products/download-ghas-license-use)
|
||||
* {% data variables.product.prodname_copilot %} license users, see [AUTOTITLE](/copilot/how-tos/administer-copilot/download-activity-report)
|
||||
* Report using the REST API, see [AUTOTITLE](/billing/tutorials/automate-usage-reporting)
|
||||
|
||||
If you want to generate a more detailed usage report, see [AUTOTITLE](/billing/tutorials/gather-insights).
|
||||
|
||||
{% endif %}
|
||||
|
||||
**{% data variables.product.prodname_ghe_server %} users** can download license reports for {% data variables.product.prodname_AS %} from the **License** page under enterprise settings, see [AUTOTITLE](/billing/how-tos/products/download-ghas-license-use).
|
||||
|
||||
## {% data variables.product.prodname_AS %} license report
|
||||
|
||||
The CSV file contains information about each user who is currently consuming a license. The most recent commit by each of these users to repositories with paid security features enabled is reported.
|
||||
|
||||
| Field | Description |
|
||||
|---------------------------|----------------------------|
|
||||
| User login | The {% data variables.product.github %} handle of the user. |
|
||||
| Organization / repository | A repository with paid security features that the user contributed to within the last 90 days. |
|
||||
| Last pushed date | The most recent author date of a commit pushed by the user to the repository. |
|
||||
| Last pushed email | The email address associated with that commit. |
|
||||
|
||||
Data in the "Organization / repository" field will also include `USERNAME/REPOSITORY` data in some situations:
|
||||
|
||||
* Your {% data variables.product.prodname_ghe_cloud %} has {% data variables.product.prodname_emus %}
|
||||
* Your report is for {% data variables.product.prodname_ghe_server %}
|
||||
|
||||
{% ifversion copilot %}
|
||||
|
||||
## {% data variables.product.prodname_copilot_short %} license report
|
||||
|
||||
See [AUTOTITLE](/copilot/reference/metrics-data)
|
||||
|
||||
{% endif %}
|
||||
|
||||
## {% data variables.product.prodname_ghe_cloud %} license report
|
||||
|
||||
The license usage report for your enterprise is a CSV file that contains the following information about members of your enterprise. Some fields are specific to your {% data variables.product.prodname_ghe_cloud %} (GHEC) deployment, {% data variables.product.prodname_ghe_server %} (GHES) connected environments, or your {% data variables.product.prodname_vs %} subscriptions (VSS) with GitHub Enterprise.
|
||||
|
||||
Reports generated on instances of {% data variables.enterprise.data_residency %} will see `GitHub` in place of `GitHub com`. The `Ghe license active` field will be marked true.
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| GitHub com login | The username for the user's GHEC account |
|
||||
| GitHub com name | The display name for the user's GHEC account |
|
||||
| Enterprise server user ids | For each of the user's GHES accounts, the account's user ID |
|
||||
| GitHub com user | Whether or not the user has an account on GHEC |
|
||||
| Enterprise server user | Whether or not the user has at least one account on GHES |
|
||||
| Visual studio subscription user | Whether or not the user is a {% data variables.visual_studio.prodname_vs_subscriber %} |
|
||||
| License type | Can be one of: `Visual Studio subscription` or `Enterprise` |
|
||||
| GitHub com profile | The URL for the user's profile page on GHEC |
|
||||
| GitHub com member roles | For each of the organizations the user belongs to on GHEC, the organization name and the user's role in that organization (`Owner` or `Member`) separated by a colon<br><br>Organizations delimited by commas |
|
||||
| GitHub com enterprise roles | Can be one of: `Owner`, `Member`, `Outside collaborator` (for an enterprise with personal accounts on {% data variables.product.prodname_dotcom_the_website %}), or `Repository collaborator` (for an enterprise that uses {% data variables.enterprise.prodname_managed_users %}) |
|
||||
| GitHub com verified domain emails | All email addresses associated with the user's GHEC account that match your enterprise's verified domains |
|
||||
| GitHub com saml name | The SAML username |
|
||||
| GitHub com orgs with pending invites | All pending invitations for the user's GHEC account to join organizations within your enterprise |
|
||||
| GitHub com two factor auth | Whether the user has two-factor authentication enabled (true/false) |
|
||||
| GitHub com two factor auth required by date | The date by which the user is required to enable two-factor authentication |
|
||||
| GitHub com cost center | The cost center associated with the user for billing purposes |
|
||||
| GitHub com code security license user | Whether the user consumes a code security license (true/false) |
|
||||
| GitHub com secret protection license user | Whether the user consumes a secret protection license (true/false) |
|
||||
| Ghe license active | Whether the user has an active license on {% data variables.enterprise.data_residency_site %} (true/false) |
|
||||
| Ghe license start date | The start date of the user's license on {% data variables.enterprise.data_residency_site %} |
|
||||
| Ghe license end date | The end date of the user's license on {% data variables.enterprise.data_residency_site %} |
|
||||
| Enterprise server primary emails | The primary email addresses associated with each of the user's GHES accounts |
|
||||
| Enterprise server advanced security user ids | User identifiers for advanced security features on {% data variables.product.prodname_ghe_server %} |
|
||||
| Enterprise server code security user ids | User identifiers for code security features on {% data variables.product.prodname_ghe_server %} |
|
||||
| Enterprise server secret protection user ids | User identifiers for secret protection features on {% data variables.product.prodname_ghe_server %} |
|
||||
| Visual studio license status | Whether the Visual Studio license has been matched to a {% data variables.product.company_short %} user |
|
||||
| Visual studio subscription email | The email address associated with the user's VSS |
|
||||
| Total user accounts | The total number of accounts the person has across both GHEC and GHES |
|
||||
|
||||
## {% data variables.product.prodname_ghe_server %} exported license usage (JSON file)
|
||||
|
||||
Your {% data variables.product.prodname_ghe_server %} license usage is a JSON file that is typically used when performing a manual sync of user licenses between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} deployments. The file contains the following information specific to your {% data variables.product.prodname_ghe_server %} environment.
|
||||
|
||||
| Field | Description
|
||||
| ----- | -----------
|
||||
| Features | The {% data variables.product.prodname_github_connect %} features that are enabled on your {% data variables.product.prodname_ghe_server %} instance, and the date and time of enablement.
|
||||
| Host name | The hostname of your {% data variables.product.prodname_ghe_server %} instance.
|
||||
| HTTP only | Whether Transport Layer Security (TLS) is enabled and configured on your {% data variables.product.prodname_ghe_server %} instance. Can be one of: `True` or `False`.
|
||||
| License | A hash of your {% data variables.product.prodname_ghe_server %} license.
|
||||
| Public key | The public key portion of your {% data variables.product.prodname_ghe_server %} license.
|
||||
| Server ID | UUID generated for your {% data variables.product.prodname_ghe_server %} instance.
|
||||
| Version | The version of your {% data variables.product.prodname_ghe_server %} instance.
|
||||
@@ -1,41 +1,43 @@
|
||||
---
|
||||
title: Usage reports reference
|
||||
shortTitle: Usage reports
|
||||
intro: 'Learn how to request and understand a report that shows detailed {% data variables.product.github %} usage and billing information for your account.'
|
||||
intro: 'Usage reports show detailed {% data variables.product.github %} usage and billing information for your account.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
feature: enhanced-billing-platform
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '*'
|
||||
topics:
|
||||
- Billing
|
||||
- Enterprise
|
||||
- Team
|
||||
permissions: '{% data reusables.permissions.enhanced-billing-platform %}'
|
||||
product: '{% data reusables.billing.enhanced-billing-platform-product %}'
|
||||
permissions: '{% data reusables.permissions.enhanced-billing-enterprise %}'
|
||||
redirect_from:
|
||||
- /billing/managing-your-billing/about-usage-reports
|
||||
contentType: reference
|
||||
---
|
||||
|
||||
The usage report shows detailed information about your account’s {% data variables.product.github %} usage, including how much of each SKU was used and the resulting billable amount.
|
||||
The usage report shows detailed information about your account’s {% data variables.product.github %} usage, including how much of each SKU was used and the resulting billable amount.
|
||||
|
||||
To generate a usage report, see [AUTOTITLE](/billing/managing-your-billing/gathering-insights-on-your-spending).
|
||||
To generate a usage report, see {% ifversion fpt or ghec %}[AUTOTITLE](/billing/managing-your-billing/gathering-insights-on-your-spending){% elsif ghes %}[AUTOTITLE](/enterprise-cloud@latest/billing/managing-your-billing/gathering-insights-on-your-spending) in the documentation for {% data variables.product.prodname_ghe_cloud %}{% endif %}.
|
||||
|
||||
## Usage report types
|
||||
|
||||
There are two different types of report.
|
||||
|
||||
* Summarized reports can be requested for a maximum time frame of one year.
|
||||
* Detailed reports can be requested for a maximum time frame of 31 days.
|
||||
|
||||
### Summarized report
|
||||
|
||||
The summarized usage report sums the `quantity`, `gross_amount`, `discount_amount`, and `net_amount` fields based on the combination of the following values: `date`, `sku`, `repository`, `cost_center_name`. If the usage report is for an enterprise with organizations, the amounts will be summarized by the organization value as well.
|
||||
|
||||
Summarized reports can be requested for a maximum time frame of one year.
|
||||
|
||||
### Detailed report
|
||||
|
||||
The detailed usage report includes the same fields as the summarized report and adds `username` and `workflow_path`.
|
||||
|
||||
The detailed usage report sums the `quantity`, `gross_amount`, `discount_amount`, and `net_amount` fields based on the combination of the following values: `date`, `sku`, `organization`, `repository`, `cost_center_name`, `username`, `workflow_path`.
|
||||
|
||||
Detailed reports can be requested for a maximum time frame of 31 days.
|
||||
|
||||
## Usage report fields
|
||||
|
||||
The usage report contains the following fields.
|
||||
@@ -57,11 +59,11 @@ The usage report contains the following fields.
|
||||
| `workflow_path` | The path of the {% data variables.product.prodname_actions %} workflow that generated the usage, if applicable. Only available in the detailed report. |
|
||||
| `cost_center_name` | The cost center associated with the usage, if applicable. |
|
||||
|
||||
### Deprecated report fields
|
||||
### Report fields closing down
|
||||
|
||||
{% data variables.product.github %} aims to minimize changes to the usage report structure, however at times the report structure or fields may change.
|
||||
|
||||
| Deprecated field | Replacement |
|
||||
| Closing down | Replacement |
|
||||
|--------------------|---------------------|
|
||||
| `usage_at` | Refer to `date` instead. |
|
||||
| `workflow_name` | Refer to `workflow_path` instead. |
|
||||
|
||||
@@ -1,3 +1 @@
|
||||
1. In the top-right corner of {% data variables.product.prodname_ghe_server %}, click your profile picture, then click **Enterprise settings**.
|
||||
|
||||
|
||||
|
||||
@@ -1 +1 @@
|
||||
1. Under **{% octicon "gear" aria-hidden="true" aria-label="gear" %} Settings**, click **{% ifversion ghec %}Licensing{% elsif ghes %}License{% endif %}**.
|
||||
1. Under **{% octicon "gear" aria-hidden="true" aria-label="gear" %} Settings**, click **{% ifversion fpt or ghec %}Licensing{% elsif ghes %}License{% endif %}**.
|
||||
|
||||
1
data/reusables/permissions/enhanced-billing-cloud-all.md
Normal file
1
data/reusables/permissions/enhanced-billing-cloud-all.md
Normal file
@@ -0,0 +1 @@
|
||||
Enterprise owners, organization owners, billing managers, and personal account users
|
||||
@@ -0,0 +1 @@
|
||||
Enterprise owners, organization owners, and billing managers (cloud) <br> Enterprise owners (server)
|
||||
Reference in New Issue
Block a user