许可 - GitHub Enterprise Cloud Docs

List enterprise consumed licenses

Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.

The authenticated user must be an enterprise admin to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.

“List enterprise consumed licenses”的细粒度访问令牌

此端点支持以下精细令牌类型:

细粒度令牌必须具有以下权限集:

"Enterprise administration" enterprise permissions (read)

“”List enterprise consumed licenses 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`enterprise` string 必须 The slug version of the enterprise name.

查询参数
名称, 类型, 说明
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 默认: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 默认: `1`

“List enterprise consumed licenses”的 HTTP 响应状态代码

状态代码	说明
`200`	Consumed Licenses Response

“List enterprise consumed licenses”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

get/enterprises/{enterprise}/consumed-licenses

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  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.

The authenticated user must be an enterprise admin to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.

“Get a license sync status”的细粒度访问令牌

此端点支持以下精细令牌类型:

细粒度令牌必须具有以下权限集:

"Enterprise administration" enterprise permissions (read)

“”Get a license sync status 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`enterprise` string 必须 The slug version of the enterprise name.

“Get a license sync status”的 HTTP 响应状态代码

状态代码	说明
`200`	License Sync Status Response

“Get a license sync status”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  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": ""
      }
    }
  ]
}

Get GitHub Advanced Security active committers for an enterprise

Gets the GitHub Advanced Security active committers for an enterprise per repository. The authenticated user must be an enterprise admin or billing manager.

Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.

The total number of repositories with committer information is tracked by the total_count field.

“Get GitHub Advanced Security active committers for an enterprise”的细粒度访问令牌

此端点支持以下精细令牌类型:

细粒度令牌必须具有以下权限集:

"Enterprise administration" enterprise permissions (write)

“”Get GitHub Advanced Security active committers for an enterprise 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`enterprise` string 必须 The slug version of the enterprise name.

查询参数
名称, 类型, 说明
`advanced_security_product` string The security product to get GitHub Advanced Security active committers for. For standalone Code Scanning or Secret Protection products, this parameter is required to specify which product you want committer information for. For other plans this parameter cannot be used. 可以是以下选项之一: `code_security`, `secret_protection`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 默认: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 默认: `1`

“Get GitHub Advanced Security active committers for an enterprise”的 HTTP 响应状态代码

状态代码	说明
`200`	Success

“Get GitHub Advanced Security active committers for an enterprise”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

get/enterprises/{enterprise}/settings/billing/advanced-security

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/advanced-security

Success

Status: 200

{
  "total_advanced_security_committers": 2,
  "total_count": 2,
  "maximum_advanced_security_committers": 4,
  "purchased_advanced_security_committers": 4,
  "repositories": [
    {
      "name": "octocat-org/Hello-World",
      "advanced_security_committers": 2,
      "advanced_security_committers_breakdown": [
        {
          "user_login": "octocat",
          "last_pushed_date": "2021-11-03",
          "last_pushed_email": "octocat@github.com"
        },
        {
          "user_login": "octokitten",
          "last_pushed_date": "2021-10-25",
          "last_pushed_email": "octokitten@github.com"
        }
      ]
    },
    {
      "name": "octocat-org/server",
      "advanced_security_committers": 1,
      "advanced_security_committers_breakdown": [
        {
          "user_login": "octokitten",
          "last_pushed_date": "2021-10-26",
          "last_pushed_email": "octokitten@github.com"
        }
      ]
    }
  ]
}

Get a list of Visual Studio subscriptions for the enterprise

Retrieves a list of Visual Studio subscriptions for the specified enterprise.

“Get a list of Visual Studio subscriptions for the enterprise”的细粒度访问令牌

此端点支持以下精细令牌类型:

细粒度令牌必须具有以下权限集:

"Enterprise Licensing" enterprise permissions (read)

“”Get a list of Visual Studio subscriptions for the enterprise 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`enterprise` string 必须 The slug version of the enterprise name

查询参数
名称, 类型, 说明
`is_unmatched_only` boolean When true, only returns Visual Studio subscriptions that are not matched to a GitHub user.
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 默认: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 默认: `1`

“Get a list of Visual Studio subscriptions for the enterprise”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found

“Get a list of Visual Studio subscriptions for the enterprise”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

get/enterprises/{enterprise}/visual-studio-subscriptions

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/enterprises/ENTERPRISE/visual-studio-subscriptions

Response

Status: 200

{
  "total_count": 1,
  "visual_studio_subscription_assignments": [
    {
      "email": "test@example.com",
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "username": "gh-user",
      "manual_match": true
    }
  ]
}

Add or update a Visual Studio subscription user match

Updates a manual match between a user and a Visual Studio subscription.

“Add or update a Visual Studio subscription user match”的细粒度访问令牌

此端点支持以下精细令牌类型:

细粒度令牌必须具有以下权限集:

"Enterprise Licensing" enterprise permissions (write)

“”Add or update a Visual Studio subscription user match 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`visual_studio_subscription_id` string 必须 The ID of the Visual Studio subscription to add or update the match for. This is a GUID that comes from the Visual Studio management portal.
`enterprise` string 必须 The slug version of the enterprise name

主体参数
名称, 类型, 说明
`user_identifier` string The handle for the GitHub user account or a verified email associated with their account.

“Add or update a Visual Studio subscription user match”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

“Add or update a Visual Studio subscription user match”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

put/enterprises/{enterprise}/visual-studio-subscriptions/{visual_studio_subscription_id}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/enterprises/ENTERPRISE/visual-studio-subscriptions/VISUAL_STUDIO_SUBSCRIPTION_ID \
  -d '{"user_identifier":"monalisa"}'

Response

Status: 200

{
  "visual_studio_subscription_email": "test@example.com",
  "subscription_id": "00000000-0000-0000-0000-000000000000",
  "username": "gh-user",
  "manual_match": true
}

Delete a Visual Studio subscription user match

Deletes a manual match between a user and a Visual Studio subscription.

“Delete a Visual Studio subscription user match”的细粒度访问令牌

此端点支持以下精细令牌类型:

细粒度令牌必须具有以下权限集:

"Enterprise Licensing" enterprise permissions (write)

“”Delete a Visual Studio subscription user match 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`visual_studio_subscription_id` string 必须 The ID of the Visual Studio subscription to delete the match for. This is a GUID that comes from the visual studio management portal.
`enterprise` string 必须 The slug version of the enterprise name

“Delete a Visual Studio subscription user match”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

“Delete a Visual Studio subscription user match”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

delete/enterprises/{enterprise}/visual-studio-subscriptions/{visual_studio_subscription_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/enterprises/ENTERPRISE/visual-studio-subscriptions/VISUAL_STUDIO_SUBSCRIPTION_ID

Response

Status: 200

{
  "visual_studio_subscription_email": "test@example.com",
  "subscription_id": "00000000-0000-0000-0000-000000000000",
  "username": null,
  "manual_match": false
}