1
0
mirror of synced 2025-12-30 03:01:36 -05:00
Files
docs/content/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md
2022-04-13 08:32:01 +02:00

8.8 KiB

title, intro, permissions, product, redirect_from, versions, miniTocMaxHeadingLevel, type, topics, shortTitle
title intro permissions product redirect_from versions miniTocMaxHeadingLevel type topics shortTitle
Viewing your GitHub Advanced Security usage You can view usage of {% data variables.product.prodname_GH_advanced_security %} for your enterprise. Enterprise owners can view usage for {% data variables.product.prodname_GH_advanced_security %}. {% data reusables.gated-features.ghas %}
/billing/managing-licensing-for-github-advanced-security/viewing-your-github-advanced-security-usage
/admin/advanced-security/viewing-your-github-advanced-security-usage
/github/setting-up-and-managing-billing-and-payments-on-github/managing-licensing-for-github-advanced-security/viewing-your-github-advanced-security-usage
/github/setting-up-and-managing-your-enterprise/managing-use-of-advanced-security-for-organizations-in-your-enterprise-account
/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-advanced-security-usage
ghes ghec ghae
* * issue-5378
3 how_to
Advanced Security
Enterprise
View Advanced Security usage

About licenses for {% data variables.product.prodname_GH_advanced_security %}

{% data reusables.advanced-security.about-ghas-license-seats %} For more information, see "About billing for {% data variables.product.prodname_GH_advanced_security %}."

Viewing {% data variables.product.prodname_GH_advanced_security %} license usage for your enterprise account

You can check how many seats your license includes and how many of them are currently used.

{% ifversion fpt or ghec %}

{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.license-tab %} The "{% data variables.product.prodname_GH_advanced_security %}" section shows details of the current usage. {% data variables.product.prodname_GH_advanced_security %} in enterprise licensing settings If you run out of seats, the section will be red and show "Limit exceeded." You should either reduce your use of {% data variables.product.prodname_GH_advanced_security %} or purchase more seats. For more information, see "About billing for {% data variables.product.prodname_GH_advanced_security %}." {% data variables.product.prodname_GH_advanced_security %} in enterprise licensing settings showing "Limit exceeded" 4. Optionally, to see a detailed breakdown of usage per organization, in the left sidebar, click Billing. Billing tab in the enterprise account settings sidebar In the "{% data variables.product.prodname_GH_advanced_security %}" section you can see the number of committers and unique committers for each organization. {% data variables.product.prodname_GH_advanced_security %} in enterprise billing settings 5. Optionally, click the name of an organization where you are an owner to display the security and analysis settings for the organization. Owned organization in {% data variables.product.prodname_GH_advanced_security %} section of enterprise billing settings 6. On the "Security & analysis" settings page, scroll to the "{% data variables.product.prodname_GH_advanced_security %} repositories" section to see a detailed breakdown of usage by repository for this organization. {% data variables.product.prodname_GH_advanced_security %} repositories section For more information, see "Managing security and analysis settings for your organization."

{% elsif ghes %}

{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.license-tab %} The "{% data variables.product.prodname_GH_advanced_security %}" section shows details of the current usage. You can see the total number of seats used, as well as a table with the number of committers and unique committers for each organization. {% data variables.product.prodname_GH_advanced_security %} section of Enterprise license 5. Optionally, click the name of an organization where you are an owner to display the security and analysis settings for the organization. Owned organization in {% data variables.product.prodname_GH_advanced_security %} section of enterprise billing settings 6. On the "Security & analysis" settings page, scroll to the "{% data variables.product.prodname_GH_advanced_security %} repositories" section to see a detailed breakdown of usage by repository for this organization. {% data variables.product.prodname_GH_advanced_security %} repositories section For more information, see "Managing security and analysis settings for your organization."

{% endif %}

{% ifversion ghec or ghes > 3.3 or ghae-issue-5378 %}

Downloading {% data variables.product.prodname_GH_advanced_security %} license usage information

You can download a CSV file with {% data variables.product.prodname_GH_advanced_security %} license usage information at both the enterprise and organization levels. The CSV file contains information about each {% data variables.product.prodname_advanced_security %} seat that is in use, including:

  • The username of the person using the seat
  • The {% data variables.product.prodname_advanced_security %}-enabled repositories where commits were made
  • The organizations that people using seats belong to
  • The most recent commit dates

You can use this information for insights into how your {% data variables.product.prodname_advanced_security %} licenses are being used, such as which members of your enterprise are using an {% data variables.product.prodname_advanced_security %} seat or how {% data variables.product.prodname_advanced_security %} licenses are being consumed across your organizations.

You can download the {% data variables.product.prodname_advanced_security %} license usage CSV through the {% data variables.product.product_name %} user interface or the REST API.

Downloading {% data variables.product.prodname_advanced_security %} license usage information through the UI

At the organization-level

{% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.billing_plans %}

  1. Underneath "{% data variables.product.prodname_GH_advanced_security %}," click {% octicon "download" aria-label="The download icon" %} next to "Committers." Download button for organization-level data

At the enterprise-level

{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.license-tab %}

  1. Under "{% data variables.product.prodname_GH_advanced_security %}," click {% octicon "download" aria-label="The download icon" %} next to "Commiters." Download button for enterprise-level data

Downloading {% data variables.product.prodname_advanced_security %} license usage information through the REST API

You can retrieve {% data variables.product.prodname_advanced_security %} usage information via the billing API.

{% ifversion ghec %}

For organization-level data, use the /orgs/{org}/settings/billing/advanced-security endpoint. For more information, see "Billing" in the {% data variables.product.prodname_dotcom %} REST API documentation.

{% endif %}

For enterprise-level data, use the /enterprises/{enterprise}/settings/billing/advanced-security endpoint. For more information, see "{% data variables.product.prodname_enterprise %} administration" in the {% data variables.product.prodname_dotcom %} REST API documentation.

{% endif %}