Viewing your GitHub Advanced Security usage

About licenses for GitHub Advanced Security

Each license for GitHub Advanced Security specifies a maximum number of licenses that can use these features. Periodically you should check that your use is within your license capacity. For more information, see "About billing for GitHub Advanced Security."

Viewing GitHub Advanced Security license usage for your enterprise account

You can view the enterprise account's current license limits and usage.

1. 在 GitHub 的右上角，单击你的个人资料照片，然后单击“你的企业”****。

2. 在企业列表中，单击您想要查看的企业。

3. 在页面左侧的企业帐户边栏中，单击 “设置”。

4. 在 “设置”下，单击“Licensing”。

   Note

   如果使用增强型计费平台，则许可页面已经重定位。 请参阅“Gathering insights on your spending”。 The "GitHub Advanced Security" section shows details of the current usage.

   If you run out of licenses, the section will be red and show "Limit exceeded." You should either reduce your use of GitHub Advanced Security or purchase more licenses. For more information, see "About billing for GitHub Advanced Security" and "Managing your GitHub Advanced Security licensing."

   Note

   可以使用 security configurations 为组织管理 GitHub Advanced Security 功能的启用以及许可证使用情况。 请参阅“管理 GitHub Advanced Security 许可证使用情况”。

5. Optionally, to see a detailed breakdown of usage per organization and user namespace when using Enterprise Managed Users, in the enterprise account sidebar, click Billing.

   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, display the security and analysis settings for an organization.

   • Click the name of the organization.

   • On the "Code security & analysis" settings page, scroll to the "GitHub Advanced Security repositories" section to see an overview of your organization's license usage, as well as a detailed breakdown of usage by repository for this organization.

     For more information, see "管理组织的安全和分析设置."

Downloading GitHub Advanced Security license usage information

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

• The username of the person using the license
• The Advanced 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 an Advanced Security license or how Advanced Security licenses are being consumed across your organizations.

You can download the Advanced Security license usage CSV through the GitHub Enterprise Cloud user interface or the REST API.

Downloading Advanced Security license usage information through the UI

At the repository-level

1. 在 GitHub 的右上角，选择个人资料照片，然后单击 “你的组织”。

2. 在组织旁边，单击“设置”。

3. In the "Security" section of the sidebar, click Code security and analysis.

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

   

At the organization-level

1. 在 GitHub 的右上角，选择个人资料照片，然后单击 “你的组织”。
2. 在组织旁边，单击“设置”。
3. 在侧边栏的“访问”部分，单击“ 计费和计划”。
4. Underneath "GitHub Advanced Security," next to "Committers", click CSV report.

At the enterprise-level

1. 在 GitHub 的右上角，单击你的个人资料照片，然后单击“你的企业”****。

2. 在企业列表中，单击您想要查看的企业。

3. 在页面左侧的企业帐户边栏中，单击 “设置”。

4. 在 “设置”下，单击“Licensing”。

   Note

   如果使用增强型计费平台，则许可页面已经重定位。 请参阅“Gathering insights on your spending”。

5. Under "GitHub Advanced Security," click the Manage dropdown and then click Download 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 /orgs/{org}/settings/billing/advanced-security endpoint. For more information, see "计费的 REST API 终结点."

For enterprise-level data, use the /enterprises/{enterprise}/settings/billing/advanced-security endpoint. For more information, see "适用于 GitHub Enterprise 管理的 REST API 终结点" in the GitHub REST API documentation.