Downloading licensed use of Advanced Security

Downloading Advanced Security license usage information

You can download a CSV file with details of paid use of GitHub Advanced Security products at both the empresa e organizações 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 paid use of Advanced Security, 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. No canto superior direito de GitHub, selecione sua foto de perfil e clique em Your organizations.

2. Ao lado da organização, clique em Configurações.

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. No canto superior direito de GitHub, selecione sua foto de perfil e clique em Your organizations.
2. Ao lado da organização, clique em Configurações.
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. No canto superior direito do GitHub, selecione sua foto de perfil.
2. Dependendo do ambiente, selecione Sua empresa ou Suas empresas e escolha a empresa que deseja ver.
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 information on paid use of Advanced Security with the billing API.

For organization-level data, use the /organizations/{org}/settings/billing/usage endpoint. For more information, see Plataforma de faturamento aprimorada.

For enterprise-level data, use the /enterprises/{enterprise}/settings/billing/usage endpoint. For more information, see Pontos de extremidade da API REST para faturamento corporativo in the GitHub Enterprise Cloud documentation.