ライセンスコンプライアンスのための REST API エンドポイント

Get the license compliance policy for an enterprise

Gets the license compliance policy for an enterprise.

Currently, only the policy with the ID default is supported.

The authenticated user must be an enterprise owner, or have the "View enterprise license policy" or "Edit enterprise license policy" fine-grained permission on the enterprise.

"Get the license compliance policy for an enterprise" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

"Enterprise license policy" enterprise permissions (read)

"Get the license compliance policy for an enterprise" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`policy_id` string 必須 The unique identifier of the policy within the enterprise. Currently, only `default` is supported.

"Get the license compliance policy for an enterprise" の HTTP 応答状態コード

状態コード	説明
`200`	OK
`404`	Resource not found
`503`	Service unavailable

"Get the license compliance policy for an enterprise" のコードサンプル

GHE.com でGitHubにアクセスする場合は、api.github.com を、api.SUBDOMAIN.ghe.com にある企業の専用サブドメインに置き換えます。

要求の例

get/enterprises/{enterprise}/license-compliance/policies/{policy_id}

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-compliance/policies/POLICY_ID

Response

Status: 200

{
  "created_at": "2026-09-22T12:00:00Z",
  "licenses": {
    "allowed": [
      {
        "spdx_id": "MIT",
        "added_at": "2026-09-22T12:00:00Z"
      }
    ]
  },
  "packages": [
    {
      "package_manager": "npm",
      "name": "example-package",
      "action": "allowed",
      "reason": "Approved exception.",
      "extra_allowed_spdx_ids": [
        "MIT"
      ],
      "added_at": "2026-09-22T12:00:00Z"
    }
  ]
}

Set the license compliance policy for an enterprise

Sets the license compliance policy for an enterprise.

Currently, only the policy with the ID default is supported.

The authenticated user must be an enterprise owner, or have the "Edit enterprise license policy" fine-grained permission on the enterprise.

"Set the license compliance policy for an enterprise" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

"Enterprise license policy" enterprise permissions (write)

"Set the license compliance policy for an enterprise" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`policy_id` string 必須 The unique identifier of the policy within the enterprise. Currently, only `default` is supported.

名前, タイプ, 説明

licenses object 必須

Properties of licenses

名前, タイプ, 説明

allowed array of objects 必須

The licenses allowed by this policy.

Properties of allowed

名前, タイプ, 説明
`spdx_id` string 必須 The SPDX identifier of the license.
`added_at` string or null 必須 The time the license was added to the policy.

packages array of objects 必須

The package-level exceptions in this policy.

Properties of packages

名前, タイプ, 説明
`package_manager` string 必須 The package manager the package belongs to. 次のいずれかにできます: `unknown`, `rubygems`, `npm`, `pip`, `maven`, `nuget`, `composer`, `gomod`, `rust`, `actions`, `pub`, `swift`
`name` string 必須 The name of the package.
`action` string 必須 How the package is treated by the policy. 次のいずれかにできます: `unknown`, `allowed`, `private`
`reason` string 必須 The reason the exception was added.
`extra_allowed_spdx_ids` array of strings 必須 Additional SPDX identifiers allowed for this package.
`added_at` string or null 必須 The time the exception was added to the policy.

"Set the license compliance policy for an enterprise" の HTTP 応答状態コード

状態コード	説明
`204`	A header with no content is returned.
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`503`	Service unavailable

"Set the license compliance policy for an enterprise" のコードサンプル

GHE.com でGitHubにアクセスする場合は、api.github.com を、api.SUBDOMAIN.ghe.com にある企業の専用サブドメインに置き換えます。

要求の例

put/enterprises/{enterprise}/license-compliance/policies/{policy_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/license-compliance/policies/POLICY_ID \
  -d '{"licenses":{"allowed":[{"spdx_id":"MIT","added_at":"2026-09-22T12:00:00Z"}]},"packages":[{"package_manager":"npm","name":"example-package","action":"allowed","reason":"Approved exception.","extra_allowed_spdx_ids":["MIT"],"added_at":"2026-09-22T12:00:00Z"}]}'

A header with no content is returned.

Status: 204

Check license compliance for packages

Checks whether packages identified by the supplied package URLs (PURLs) are allowed by the repository's license compliance policy.

For requests made on behalf of a user, that user must have write access to the repository or the "View repository license policy" permission. OAuth apps and classic personal access tokens require the repo scope.

"Check license compliance for packages" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

"Repository license policy" repository permissions (read)

"Check license compliance for packages" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`owner` string 必須 The account owner of the repository. The name is not case sensitive.
`repo` string 必須 The name of the repository without the `.git` extension. The name is not case sensitive.

ボディパラメータ
名前, タイプ, 説明
`purls` array of strings 必須 Up to 40 package URLs to check against the license compliance policy. Duplicate package URLs count toward the limit but are checked once.

"Check license compliance for packages" の HTTP 応答状態コード

状態コード	説明
`200`	Package license compliance results.
`403`	Forbidden
`404`	License compliance policy not found.
`422`	Validation failed, or the endpoint has been spammed.
`503`	Service unavailable

"Check license compliance for packages" のコードサンプル

GHE.com でGitHubにアクセスする場合は、api.github.com を、api.SUBDOMAIN.ghe.com にある企業の専用サブドメインに置き換えます。

リクエスト例

Select the example type

post/repos/{owner}/{repo}/license-compliance/package-checks

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/repos/OWNER/REPO/license-compliance/package-checks \
  -d '{"purls":["pkg:npm/lodash@4.17.21"]}'

Package license compliance results.

Status: 200

{
  "purls": {
    "pkg:npm/lodash@4.17.21": {
      "status": "allowed",
      "license": "MIT",
      "reason": "allowed_license"
    }
  }
}

ライセンスコンプライアンスのための REST API エンドポイント

Get the license compliance policy for an enterprise

"Get the license compliance policy for an enterprise" のきめ細かいアクセストークン

"Get the license compliance policy for an enterprise" のパラメーター

"Get the license compliance policy for an enterprise" の HTTP 応答状態コード

"Get the license compliance policy for an enterprise" のコードサンプル

要求の例

Response

Set the license compliance policy for an enterprise

"Set the license compliance policy for an enterprise" のきめ細かいアクセストークン

"Set the license compliance policy for an enterprise" のパラメーター

"Set the license compliance policy for an enterprise" の HTTP 応答状態コード

"Set the license compliance policy for an enterprise" のコードサンプル

要求の例

A header with no content is returned.

Check license compliance for packages

"Check license compliance for packages" のきめ細かいアクセストークン

"Check license compliance for packages" のパラメーター

"Check license compliance for packages" の HTTP 応答状態コード

"Check license compliance for packages" のコードサンプル

リクエスト例

Package license compliance results.

このドキュメントは役に立ちましたか?

まだ助けが必要ですか？

ライセンス コンプライアンスのための REST API エンドポイント

要求の例

Response

要求の例

A header with no content is returned.

リクエスト例

Package license compliance results.

ライセンスコンプライアンスのための REST API エンドポイント