Skip to main content
REST API теперь версия. Дополнительные сведения см. в разделе "О управлении версиями API".

Виды

Используйте REST API для получения сведений о вашей лицензии Enterprise.

These endpoints are only available to authenticated site administrators. Normal users will receive a 404 response.

These endpoints only support authentication using a personal access token (classic). For more information, see "Managing your personal access tokens."

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.

Параметры для "List enterprise consumed licenses"

Заголовки
Имя., Тип, Description
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя., Тип, Description
enterprise string Обязательное поле

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Параметры запроса
Имя., Тип, Description
per_page integer

The number of results per page (max 100).

По умолчанию.: 30

page integer

Page number of the results to fetch.

По умолчанию.: 1

Коды состояния http-ответа для "List enterprise consumed licenses"

Код состоянияОписание
200

Consumed Licenses Response

Примеры кода для "List enterprise consumed licenses"

get/enterprises/{enterprise}/consumed-licenses
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/consumed-licenses

Consumed Licenses Response

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

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.

Параметры для "Get a license sync status"

Заголовки
Имя., Тип, Description
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя., Тип, Description
enterprise string Обязательное поле

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Коды состояния http-ответа для "Get a license sync status"

Код состоянияОписание
200

License Sync Status Response

Примеры кода для "Get a license sync status"

get/enterprises/{enterprise}/license-sync-status
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ 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": "" } } ] }