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 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 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
-
GitHub의 오른쪽 위 모서리에서 프로필 사진을 선택한 다음, Your organizations를 클릭합니다.
-
조직 옆에 있는 설정을 클릭합니다.
-
In the "Security" section of the sidebar, select the Advanced Security dropdown menu, then click Global settings.
-
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
- GitHub의 오른쪽 위 모서리에서 프로필 사진을 선택한 다음, Your organizations를 클릭합니다.
- 조직 옆에 있는 설정을 클릭합니다.
- In the "Access" section of the sidebar click Billing and licensing to display an overview.
- For metered usage, in the sidebar click Usage.
- To display only Advanced Security usage within the graph, click the search bar, then click Product. Within the list of products displayed, click GHAS.
- 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).
- To download the data, click Get usage report.
- For license consumption, in the sidebar click Licensing.
- Under "GitHub Advanced Security," click the Download CSV report dropdown and then click either Code Security or Secret Protection.
For an enterprise
- GitHub의 오른쪽 위 모서리에서 프로필 사진을 클릭합니다.
- 사용자 환경에 따라 사용자 엔터프라이즈를 클릭하거나 사용자 엔터프라이즈를 클릭한 다음, 보고 싶은 엔터프라이즈를 클릭합니다.
- Click Billing & licensing to display an overview.
- For metered usage, click Usage.
- To display only Advanced Security usage within the graph, click the search bar, then click Product. Within the list of products displayed, click GHAS.
- 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).
- To download the data, click Get usage report.
- 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 향상된 청구 플랫폼.
For enterprise-level data, use the /enterprises/{enterprise}/settings/billing/usage
endpoint. For more information, see 엔터프라이즈 청구를 위한 REST API 엔드포인트 in the GitHub Enterprise Cloud documentation.