1
0
mirror of synced 2026-01-10 00:03:04 -05:00
Files
docs/content/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md
Joe Clark 94399d6abb Update billing language for GHAS (#32109)
Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
2022-12-12 17:55:52 +00:00

9.6 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
* *
3 how_to
Advanced Security
Enterprise
View Advanced Security usage

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

Each license for {% data variables.product.prodname_GH_advanced_security %} specifies a maximum number of {% ifversion ghas-billing-UI-update %}licenses {% else %}accounts, or seats, {% endif %}that can use these features. Periodically you should check that your use is within your license capacity. For more information, see "About billing for {% data variables.product.prodname_GH_advanced_security %}."

{% ifversion ghas-committers-calculator %} You can calculate how many additional {% ifversion ghas-billing-UI-update %}licenses{% else %}seats{% endif %} will be used if you enable {% data variables.product.prodname_GH_advanced_security %} for more organizations and repositories with the site admin dashboard. For more information, see "Site admin dashboard." {% endif %}

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

You can view the enterprise account's current {% ifversion ghas-billing-UI-update %}license{% else %}seat{% endif %} limits and usage.

{% ifversion 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 licenses, 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 licenses. 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 licenses used, as well as a table with the number of committers and unique committers for each organization. 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 %}

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 %} license that is in use, including:

  • The username of the person using the {% ifversion ghas-billing-UI-update %}license{% else %}seat{% endif %}
  • The {% data variables.product.prodname_advanced_security %}-enabled repositories where commits were made
  • The organizations that people using {% ifversion ghas-billing-UI-update %}licenses{% else %}seats{% endif %} belong to
  • The most recent commit dates

You can use this information for insights into your {% data variables.product.prodname_advanced_security %} usage, such as which members of your enterprise are using an {% data variables.product.prodname_advanced_security %} {% ifversion ghas-billing-UI-update %}license{% else %}seat{% endif %} 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" %} CSV report 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" %} CSV report next to "Committers." 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 %}