ライセンス

ライセンスエンドポイントと対話するには、管理者として認証する必要があります。

現在のライセンスに関する情報の取得 

GET /license

{
  "id": 2,
  "plan": "gold",
  "created_at": "2018-02-27T23:21:58.674Z",
  "starts_at": "2018-01-27",
  "expires_at": "2022-01-27",
  "historical_max": 300,
  "maximum_user_count": 300,
  "expired": false,
  "overage": 200,
  "user_limit": 100,
  "active_users": 300,
  "licensee": {
    "Name": "John Doe1"
  },
  "add_ons": {
    "GitLab_FileLocks": 1,
    "GitLab_Auditor_User": 1
  }
}

すべてのライセンスの情報を取得 

GET /licenses

[
  {
    "id": 1,
    "plan": "silver",
    "created_at": "2018-02-27T23:21:58.674Z",
    "starts_at": "2018-01-27",
    "expires_at": "2022-01-27",
    "historical_max": 300,
    "maximum_user_count": 300,
    "expired": false,
    "overage": 200,
    "user_limit": 100,
    "licensee": {
      "Name": "John Doe1"
    },
    "add_ons": {
      "GitLab_FileLocks": 1,
      "GitLab_Auditor_User": 1
    }
  },
  {
    "id": 2,
    "plan": "gold",
    "created_at": "2018-02-27T23:21:58.674Z",
    "starts_at": "2018-01-27",
    "expires_at": "2022-01-27",
    "historical_max": 300,
    "maximum_user_count": 300,
    "expired": false,
    "overage": 200,
    "user_limit": 100,
    "licensee": {
      "Name": "Doe John"
    },
    "add_ons": {
      "GitLab_FileLocks": 1,
    }
  }
]

オーバレージとは、アクティブユーザー数とライセンスユーザー数の差のことです。 これは、ライセンスの有効期限が切れているかどうかによって計算方法が異なります。

  • ライセンスの有効期限が切れている場合は、過去の最大アクティブユーザー数 (historical_max) を使用します。
  • ライセンスの有効期限が切れていない場合は、現在のアクティブユーザー数を使用します。

リターンズ

  • 200 OK ライセンスがない場合は、空の JSON 配列となります。
  • 403 Forbidden 現在のユーザがライセンスの読み取りを許可されていない場合。

新しいライセンスの追加 

POST /license
属性 タイプ 必須 説明
license 列 はい ライセンス文字列 
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/license?license=eyJkYXRhIjoiMHM5Q...S01Udz09XG4ifQ=="

回答例 

{
  "id": 1,
  "plan": "gold",
  "created_at": "2018-02-27T23:21:58.674Z",
  "starts_at": "2018-01-27",
  "expires_at": "2022-01-27",
  "historical_max": 300,
  "maximum_user_count": 300,
  "expired": false,
  "overage": 200,
  "user_limit": 100,
  "active_users": 300,
  "licensee": {
    "Name": "John Doe1"
  },
  "add_ons": {
    "GitLab_FileLocks": 1,
    "GitLab_Auditor_User": 1
  }
}

リターンズ

  • 201 Created ライセンスが正常に追加された場合
  • 400 Bad Request ライセンスを追加できなかった場合は、理由を説明するエラーメッセージが表示されます。

ライセンスの削除 

DELETE /license/:id
属性 タイプ 必須 説明
id 整数 はい GitLabライセンスのID。 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/license/:id"

回答例 

{
  "id": 2,
  "plan": "gold",
  "created_at": "2018-02-27T23:21:58.674Z",
  "starts_at": "2018-01-27",
  "expires_at": "2022-01-27",
  "historical_max": 300,
  "maximum_user_count": 300,
  "expired": false,
  "overage": 200,
  "user_limit": 100,
  "licensee": {
    "Name": "John Doe"
  },
  "add_ons": {
    "GitLab_FileLocks": 1,
    "GitLab_Auditor_User": 1
  }
}

リターンズ

  • 204 No Content ライセンスが正常に削除された場合
  • 403 Forbidden 現在のユーザがライセンスの削除を許可されていない場合。
  • 404 Not Found 削除するライセンスが見つからない場合