License

The License API provides information on your Enterprise license.

It is only available to authenticated site administrators. Normal users will receive a 404 response if they try to access it.

List enterprise consumed licenses

Lists the license consumption information for all users, including those from connected servers, associated with an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the read:enterprise scope.

Note: The license consumption API endpoints for enterprise accounts are currently in Beta and are subject to change.

Parameters

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`enterprise`stringRequired The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Query parameters
Name, Type, Description
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`

HTTP response status codes

Status code	Description
`200`	Consumed Licenses Response

Code samples

get/enterprises/{enterprise}/consumed-licenses

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://api.github.com/enterprises/ENTERPRISE/consumed-licenses

Consumed Licenses Response

Status: 200

{
  "total_seats_consumed": 5000,
  "total_seats_purchased": 4500,
  "users": [
    {
      "enterprise_server_emails": [
        "monalisa@github.com"
      ],
      "github_com_login": "monalisa",
      "github_com_name": "Mona Lisa",
      "github_com_profile": "https://github.com/monalisa",
      "license_type": "enterprise",
      "github_com_member_roles": [
        "org1:Owner",
        "org2:Owner"
      ],
      "github_com_enterprise_role": "owner",
      "github_com_enterprise_roles": [
        "owner"
      ],
      "visual_studio_subscription_user": false,
      "github_com_verified_domain_emails": [
        "monalisa@github.com"
      ],
      "github_com_saml_name_id": "monalisa",
      "enterprise_server_user": true,
      "github_com_user": true,
      "total_user_accounts": 3,
      "enterprise_server_user_ids": [
        "example_host_name.com:123",
        "example_host_name_2:222"
      ],
      "github_com_orgs_with_pending_invites": [
        "org1",
        "org2"
      ],
      "visual_studio_subscription_email": ""
    },
    {
      "enterprise_server_emails": [
        "deleonjavier@example.com"
      ],
      "github_com_login": "",
      "github_com_name": "",
      "github_com_profile": "",
      "license_type": "enterprise",
      "github_com_member_roles": [],
      "github_com_enterprise_role": "",
      "github_com_enterprise_roles": [],
      "visual_studio_subscription_user": false,
      "github_com_verified_domain_emails": [],
      "github_com_saml_name_id": "",
      "enterprise_server_user": true,
      "github_com_user": false,
      "total_user_accounts": 1,
      "enterprise_server_user_ids": [
        "example_host_name:123"
      ],
      "github_com_orgs_with_pending_invites": [],
      "visual_studio_subscription_email": ""
    }
  ]
}

Get a license sync status

Gets information about the status of a license sync job for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the read:enterprise scope.

Parameters

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`enterprise`stringRequired The slug version of the enterprise name. You can also substitute this value with the enterprise id.

HTTP response status codes

Status code	Description
`200`	License Sync Status Response

Code samples

get/enterprises/{enterprise}/license-sync-status

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://api.github.com/enterprises/ENTERPRISE/license-sync-status

License Sync Status Response

Status: 200

{
  "server_instances": [
    {
      "server_id": "deadbeef1",
      "hostname": "github.example.com",
      "last_sync": {
        "date": "2020-01-01T00:00:00Z",
        "status": "success",
        "error": ""
      }
    },
    {
      "server_id": "filetoffish1",
      "hostname": "github2.example.com",
      "last_sync": {
        "date": "2020-01-01T00:00:00Z",
        "status": "success",
        "error": ""
      }
    }
  ]
}