Skip to main content
Publicamos actualizaciones para la documentación con frecuencia y es posible que aún se esté traduciendo esta página. Para obtener la información más reciente, consulta la documentación en inglés.
Ahora la API de REST tiene control de versiones. Para obtener más información, consulta "Acerca del control de versiones de la API".

Licencia

Usa la API REST para recuperar información sobre la licencia Enterprise.

Estos puntos de conexión solo están disponibles para los administradores de sitios autenticados. Los usuarios normales recibirán una respuesta 404.

Estos puntos de conexión solo admiten la autenticación mediante personal access token (classic). Para obtener más información, vea «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.

Parámetros para "List enterprise consumed licenses"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
enterprise string Requerido

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

Parámetros de consulta
Nombre, Tipo, Descripción
per_page integer

The number of results per page (max 100).

Valor predeterminado: 30

page integer

Page number of the results to fetch.

Valor predeterminado: 1

Códigos de estado de respuesta HTTP para "List enterprise consumed licenses"

status codeDescripción
200

Consumed Licenses Response

Ejemplos de código para "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_primary_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.

Parámetros para "Get a license sync status"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
enterprise string Requerido

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

Códigos de estado de respuesta HTTP para "Get a license sync status"

status codeDescripción
200

License Sync Status Response

Ejemplos de código para "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": "" } } ] }