License troubleshooting information for GitHub Enterprise

People who consume a license

A person consumes a license for GitHub Enterprise depending on specific criteria. If a user has not yet accepted an invitation to join your enterprise, the user still consumes a license. For more information about the people in your enterprise who consume a license, see People who consume a license in an organization.

Visual Studio 订阅者s

If the verified email address for the personal account of an enterprise member on GitHub matches the User Principal Name (UPN) for a subscriber to your Visual Studio account, the Visual Studio subscriber will automatically consume one license for 包含 GitHub Enterprise Cloud 的 Visual Studio 订阅.

For more information, see 关于包含 GitHub Enterprise 的 Visual Studio 订阅.

Users of GitHub Enterprise Cloud and GitHub Enterprise Server

For each user to consume a single seat regardless of how many deployments they use, you must synchronize license usage between GitHub Enterprise Server and GitHub Enterprise Cloud. For more information, see 将许可证使用情况从 GitHub Enterprise Server 同步到 Cloud.

After you synchronize license usage, GitHub matches user accounts on GitHub Enterprise Server with user accounts on GitHub Enterprise Cloud by email address.

1. We check the primary email address of each user on GitHub Enterprise Server.
2. We attempt to match that address with the email address for a user account on GitHub Enterprise Cloud.

With SAML or SCIM

If your enterprise on GitHub Enterprise Cloud or any of the enterprise's organizations use SAML authentication or SCIM provisioning, we first check the linked SAML or SCIM identities to see if the identity contains one of the attributes below. We attempt to match the values of these attributes to the primary email address of each GitHub Enterprise Server user.

• http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name
• http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
• username
• NameID
• emails

Without SAML or SCIM

If there is no match with a SAML or SCIM attribute, or if SAML authentication or SCIM provisioning is not in use, we attempt to match the primary email address on GitHub Enterprise Server with a verified email address for a user account on GitHub Enterprise Cloud. For more information about verification of email addresses on GitHub Enterprise Cloud, see 验证电子邮件地址 in the GitHub Enterprise Cloud documentation.

Fields in the consumed license files

The GitHub Enterprise Cloud license usage report and GitHub Enterprise Server exported license usage file include a variety of fields to help you troubleshoot license usage for your enterprise.

GitHub Enterprise Cloud license usage report (CSV file)

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.

Field	Description
github_com_login	The username for the user's GHEC account
github_com_name	The display name for the user's GHEC account
github_com_profile	The URL for the user's profile page on GHEC
github_com_user	Whether or not the user has an account on GHEC
github_com_member_roles	For 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 delimited by commas
github_com_enterprise_role	Can be one of: Owner, Member, Outside collaborator (for an enterprise with personal accounts on GitHub.com), or Repository collaborator (for an enterprise that uses 托管用户帐户)
github_com_verified_domain_emails	All email addresses associated with the user's GHEC account that match your enterprise's verified domains
github_com_saml_name_id	The SAML username
github_com_orgs_with_pending_invites	All pending invitations for the user's GHEC account to join organizations within your enterprise
github_com_advanced_security_license_user	Whether or not the user consumes a GitHub Advanced Security license on GHEC
license_type	Can be one of: Visual Studio subscription or Enterprise
enterprise_server_user	Whether or not the user has at least one account on GHES
enterprise_server_primary_emails	The primary email addresses associated with each of the user's GHES accounts
enterprise_server_user_ids	For each of the user's GHES accounts, the account's user ID
enterprise_server_advanced_security_user_ids	The GHES instances where the user is using GitHub Advanced Security
total_user_accounts	The total number of accounts the person has across both GHEC and GHES
visual_studio_subscription_user	Whether or not the user is a Visual Studio 订阅者
visual_studio_subscription_email	The email address associated with the user's VSS
visual_studio_license_status	Whether the Visual Studio license has been matched to a GitHub user

GitHub Enterprise Server exported license usage (JSON file)

Your GitHub Enterprise Server license usage is a JSON file that is typically used when performing a manual sync of user licenses between GitHub Enterprise Server and GitHub Enterprise Cloud deployments. The file contains the following information specific to your GitHub Enterprise Server environment.

Field	Description
Features	The GitHub Connect features that are enabled on your GitHub Enterprise Server instance, and the date and time of enablement.
Host name	The hostname of your GitHub Enterprise Server instance.
HTTP only	Whether Transport Layer Security (TLS) is enabled and configured on your GitHub Enterprise Server instance. Can be one of: True or False.
License	A hash of your GitHub Enterprise Server license.
Public key	The public key portion of your GitHub Enterprise Server license.
Server ID	UUID generated for your GitHub Enterprise Server instance.
Version	The version of your GitHub Enterprise Server instance.

Troubleshooting steps

For troubleshooting steps, see GitHub Enterprise 许可证使用情况疑难解答.