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 & Licensing (visible if you use the new billing platform). Alternatively, click Settings.

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

   • The "GitHub 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.

Downloading license usage information from the UI

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 & licensing and then Usage.
4. Filter the metered usage to show product:ghas and choose "Group: SKU".
5. Optionally, use the "Time Frame" field to set the period to report on.
6. Click Get usage report to download the report.

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.

   License consumption:

   1. Click Licensing.
   2. Under "GitHub Advanced Security," click the Download report dropdown and then click either Code Security or Secret Protection.

   Metered usage:

   1. Scroll to the tabbed usage information at the bottom of the "Overview" page and click Advanced Security to show usage.
   2. In the summary box, click "View details" to show metered usage for Advanced Security grouped by SKU.
   3. Select a time frame and click Get usage report to download a detailed report.

Downloading Advanced Security license usage information through the REST API

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.