Skip to main content

Troubleshooting license usage for GitHub Enterprise

You can troubleshoot license usage for your enterprise by auditing license reports.

Enterprise owners can review license usage for GitHub Enterprise.

About unexpected license usage

If the number of consumed licenses for your enterprise is unexpected, you can review your consumed license report to audit your license usage across all your enterprise deployments and subscriptions. For more information, see "Viewing license usage for GitHub Enterprise" and "Viewing the subscription and usage for your enterprise account."

If you find errors, you can try troubleshooting steps.

For privacy reasons, enterprise owners cannot directly access the details of user accounts unless you use Usuarios Administrados de Enterprise.

About the calculation of consumed licenses

GitHub bills for each person who uses deployments of GitHub Enterprise Server, is a member of one of your organizations on Nube de GitHub Enterprise, or is a Suscriptor de Visual Studio. For more information about the people in your enterprise who consume a license, see "About per-user pricing."

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 Nube de GitHub Enterprise. Para obtener más información, consulta la sección "Sincronizar el uso de licencia entre GitHub Enterprise Server y Nube de GitHub Enterprise".

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

First, we first check the primary email address of each user on GitHub Enterprise Server. Then, we attempt to match that address with the email address for a user account on Nube de GitHub Enterprise. If your enterprise uses SAML SSO, we first check the following SAML attributes for email addresses.

  • http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name
  • http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
  • nombre de usuario
  • ID del nombre
  • emails

If no email addresses found in these attributes match the primary email address on GitHub Enterprise Server, or if your enterprise doesn't use SAML SSO, we then check each of the user's verified email addresses on Nube de GitHub Enterprise. Para obtener más información sobre la verificación de las direcciones de correo electrónico de GitHub.com, consulta la sección "Verificar tu dirección de correo electrónico" en la documentación de Nube de GitHub Enterprise.

Fields in the consumed license files

The GitHub.com 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.com 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 Nube de GitHub Enterprise (GHEC) deployment, GitHub Enterprise Server (GHES) connected environments, or your Visual Studio subscriptions (VSS) with GitHub Enterprise.

CampoDescripción
github_com_loginThe username for the user's GHEC account
github_com_nameThe display name for the user's GHEC account
github_com_profileThe URL for the user's profile page on GHEC
github_com_userWhether or not the user has an account 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 delimited by commas
github_com_enterprise_roleCan be one of: Owner, Member, or Outside collaborator
github_com_verified_domain_emailsAll email addresses associated with the user's GHEC account that match your enterprise's verified domains
github_com_saml_name_idThe SAML username
github_com_orgs_with_pending_invitesAll pending invitations for the user's GHEC account to join organizations within your enterprise
license_typeCan be one of: Visual Studio subscription or Enterprise
enterprise_server_userWhether or not the user has at least one account on GHES
enterprise_server_primary_emailsThe primary email addresses associated with each of the user's GHES accounts
enterprise_server_user_idsFor each of the user's GHES accounts, the account's user ID
total_user_accountsThe total number of accounts the person has across both GHEC and GHES
visual_studio_subscription_userWhether or not the user is a Suscriptor de Visual Studio
visual_studio_subscription_emailThe email address associated with the user's VSS
visual_studio_license_statusWhether the Visual Studio license has been matched to a GitHub user

Suscriptor de Visual Studios who are not yet members of at least one organization in your enterprise will be included in the report with a pending invitation status, and will be missing values for the "Name" or "Profile link" field.

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 Nube de GitHub Enterprise deployments. The file contains the following information specific to your GitHub Enterprise Server environment.

CampoDescripción
CaracterísticasThe GitHub Connect features that are enabled on your GitHub Enterprise Server instance, and the date and time of enablement.
Host nameThe hostname of your GitHub Enterprise Server instance.
HTTP onlyWhether Transport Layer Security (TLS) is enabled and configured on your GitHub Enterprise Server instance. Can be one of: True or False.
LicenciaUn hash de tu licencia GitHub Enterprise Server.
Public keyLa parte pública de la clave de tu licencia GitHub Enterprise Server.
Server IDUUID generated for your GitHub Enterprise Server instance.
VersiónThe version of your GitHub Enterprise Server instance.

Troubleshooting consumed licenses

To ensure that the each user is only consuming a single seat for different deployments and subscriptions, try the following troubleshooting steps.

  1. To help identify users that are consuming multiple seats, if your enterprise uses verified domains for Nube de GitHub Enterprise, review the list of enterprise members who do not have an email address from a verified domain associated with their account on GitHub.com. Often, these are the users who erroneously consume more than one licensed seat. Para obtener más información, consulta la sección "Ver a los miembros sin un a dirección de correo electrónico desde un dominio verificado".

    Note: To make troubleshooting easier, we recommend using verified domains with your enterprise account on GitHub.com. Para obtener más información, consulta la sección "Verificar o aprobar un dominio para tu empresa".

  2. After you identify users who are consuming multiple seats, make sure that the same email address is associated with all of the user's accounts. For more information about which email addresses must match, see "About the calculation of consumed licenses."

  3. If an email address was recently updated or verified to correct a mismatch, view the timestamp of the last license sync job. If a job hasn't run since the correction was made, manually trigger a new job. For more information, see "Syncing license usage between GitHub Enterprise Server and GitHub Enterprise Cloud."

If you still have questions about your consumed licenses after reviewing the troubleshooting information above, you can contact Soporte de GitHub through the GitHub Support portal.