Skip to main content

License reports reference

License reports show details of the users consuming licenses that you pay for.

Who can use this feature?

Enterprise owners, organization owners, and billing managers (cloud)
Enterprise owners (server)

Each license report shows information about license users in your enterprise account, for Copilot, or for Advanced Security.

Cloud users can download license reports from the Licensing page under Billing & licensing or using the REST API.

If you want to generate a more detailed usage report, see Gathering insights on your spending.

GitHub Enterprise Server users can download license reports for Advanced Security from the License page under enterprise settings, see Downloading license use for your enterprise or organization.

Advanced Security license report

The CSV file contains information about each user who is currently consuming a license. The most recent commit by each of these users to repositories with paid security features enabled is reported.

FieldDescription
User loginThe GitHub handle of the user.
Organization / repositoryA repository with paid security features that the user contributed to within the last 90 days.
Last pushed dateThe most recent author date of a commit pushed by the user to the repository.
Last pushed emailThe email address associated with that commit.

Data in the "Organization / repository" field will also include USERNAME/REPOSITORY data in some situations:

  • Your GitHub Enterprise Cloud has Enterprise Managed Users
  • Your report is for GitHub Enterprise Server

Copilot license report

See Metrics data properties for GitHub Copilot

GitHub Enterprise Cloud license report

The license usage report for your enterprise is a CSV file that contains the following information about members of your enterprise. Some fields are specific to your GitHub Enterprise Cloud (GHEC) deployment, GitHub Enterprise Server (GHES) connected environments, or your Visual Studio subscriptions (VSS) with GitHub Enterprise.

Reports generated on instances of GitHub Enterprise Cloud with data residency will see GitHub in place of GitHub com. The Ghe license active field will be marked true.

FieldDescription
GitHub com loginThe username for the user's GHEC account
GitHub com nameThe display name for the user's GHEC account
Enterprise server user idsFor each of the user's GHES accounts, the account's user ID
GitHub com userWhether or not the user has an account on GHEC
Enterprise server userWhether or not the user has at least one account on GHES
Visual studio subscription userWhether or not the user is a Visual Studio subscriber
License typeCan be one of: Visual Studio subscription or Enterprise
GitHub com profileThe URL for the user's profile page on GHEC
GitHub com member rolesFor each of the organizations the user belongs to on GHEC, the organization name and the user's role in that organization (Owner or Member) separated by a colon. Organizations are delimited by commas.

For outside collaborators on private repositories, the value will appear as ORG/REPO:Collaborator, specifying which organization and repository the collaborator has access to.
GitHub com enterprise rolesCan be one of: Owner, Member, Outside collaborator (for an enterprise with personal accounts on GitHub.com), or Repository collaborator (for an enterprise that uses managed user accounts)
GitHub com verified domain emailsAll email addresses associated with the user's GHEC account that match your enterprise's verified domains
GitHub com saml nameThe SAML username
GitHub com orgs with pending invitesAll pending invitations for the user's GHEC account to join organizations within your enterprise
GitHub com two factor authWhether the user has two-factor authentication enabled (true/false)
GitHub com two factor auth required by dateThe date by which the user is required to enable two-factor authentication
GitHub com cost centerThe cost center associated with the user for billing purposes
GitHub com code security license userWhether the user consumes a code security license (true/false)
GitHub com secret protection license userWhether the user consumes a secret protection license (true/false)
Ghe license activeWhether the user has an active license on GHE.com (true/false)
Ghe license start dateThe start date of the user's license on GHE.com
Ghe license end dateThe end date of the user's license on GHE.com