Viewing and downloading licensed use of Advanced Security

Viewing Advanced Security usage for your enterprise account

You can view the current license limits and usage for your enterprise.

1. In the top-right corner of GitHub, click your profile photo.

2. Depending on your environment, click Your enterprise, or click Your enterprises then click the enterprise you want to view.

3. At the top of the page, click Billing and licensing.

4. Click Licensing to show detailed information on license use.

   • The "Advanced Security" section shows details of the licenses you currently consume.
   • If you have a volume/subscription license, the number of licenses available to use is also displayed.
   • If you run out of licenses, for volume/subscription only, the section is red and reports "Limit exceeded." You should either reduce your use or purchase more licenses.

5. Optionally, to see a detailed breakdown of usage per organization and user namespace when using Enterprise Managed Users, in the "GitHub Advanced Security" section click More details.

   In the "GitHub Advanced Security" section, you can see a summary of your current license usage, as well as the number of committers and unique committers for each organization and user namespace when using Enterprise Managed Users. The organizations and user namespaces in the billing table are sorted by the highest number of unique committers in descending order.

6. Optionally, to see a detailed breakdown of usage by repositories within an organization, click an organization name to display the "Global code security settings" for the organization.

   On the "Global code security settings" page, scroll to the "GitHub Secret Protection, GitHub Code Security, or GitHub Advanced Security repositories" section to see a detailed breakdown of usage by repository for this organization. See Managing your paid use of Advanced Security.

Downloading Advanced Security license usage information

You can download a CSV file with GitHub Advanced Security license usage information at both the enterprise and organizations level. The CSV file contains information about each Advanced Security license that is in use, including:

• The username of the person using the GitHub Secret Protection, GitHub Code Security, or GitHub Advanced Security license
• The GitHub Secret Protection and GitHub Code Security-enabled repositories where commits were made
• The organizations and user namespaces for Enterprise Managed Users that people using licenses belong to
• The most recent commit dates and associated email addresses

You can use this information for insights into your Advanced Security usage, such as which members of your enterprise are using a license or how licenses are being consumed across your organizations.

You can download a CSV report of license usage through the GitHub user interface or the REST API.

Using the UI to download license and metered usage

You can download a CSV report for a repository, an organization, or an enterprise.

For a repository

1. In the upper-right corner of GitHub, select your profile photo, then click Your organizations.

2. Next to the organization, click Settings.

3. In the "Security" section of the sidebar, select the Advanced Security dropdown menu, then click Global settings.

4. In the "GitHub Secret Protection or GitHub Code Security repositories" section, next to the repository you want usage information for, select , then click Download CSV report.

   

For an organization

1. In the upper-right corner of GitHub, select your profile photo, then click Your organizations.
2. Next to the organization, click Settings.
3. In the "Access" section of the sidebar click Billing and licensing to display an overview.
4. For metered usage, in the sidebar click Usage.
   1. To display only Advanced Security usage within the graph, click the search bar, then click Product. Within the list of products displayed, click GHAS.
   2. 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 GitHub Secret Protection and GitHub Code Security.
      • 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).
   3. To download the data, click Get usage report.
5. For license consumption, in the sidebar click Licensing.
   1. Under "GitHub Advanced Security," click the Download CSV report dropdown and then click either Code Security or Secret Protection.

For an enterprise

1. In the top-right corner of GitHub, click your profile photo.
2. Depending on your environment, click Your enterprise, or click Your enterprises then click the enterprise you want to view.
3. Click Billing & licensing to display an overview.
4. For metered usage, click Usage.
   1. To display only Advanced Security usage within the graph, click the search bar, then click Product. Within the list of products displayed, click GHAS.
   2. 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 GitHub Secret Protection and GitHub Code Security.
      • 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).
   3. To download the data, click Get usage report.
5. For license consumption, click Licensing.
   • Under "GitHub Advanced Security," click the Download CSV report dropdown and then click either Code Security or Secret Protection.

Using the REST API to download license and metered usage

You can retrieve Advanced Security usage information via the billing API.

For organization-level data, use the /organizations/{org}/settings/billing/usage endpoint. For more information, see Enhanced billing platform.

For enterprise-level data, use the /enterprises/{enterprise}/settings/billing/usage endpoint. For more information, see REST API endpoints for enterprise billing in the GitHub Enterprise Cloud documentation.