Returns a specific license group | Dependency-Track unofficial

1 parameter

uuidstringrequired

The UUID of the license group to retrieve

3 status codes

200A specific license group

licensesarray<object>required

Licenses belonging to the license group

namestringrequired

Name of the license group

riskWeightintegerrequired

Risk weight assigned to violations of this group

uuidstringrequired

UUID of the license group

401Unauthorized

404The license group could not be found

Error handling

A 401 is returned: Unauthorized. A 404 is returned: The license group could not be found.

import { Client } from "dependency-track-unofficial-sdk";

const client = new Client({
  baseUrl: "http://localhost:8081/api",
  auth: { apiKey: process.env.API_KEY },
});

const result = await client.licenseGroup.get({ uuid: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "licenses": [
    {
      "isCustomLicense": true,
      "isDeprecatedLicenseId": true,
      "isFsfLibre": true,
      "isOsiApproved": true,
      "licenseComments": "example_value",
      "licenseGroups": [
        {
          "licenses": [
            {
              "isCustomLicense": null,
              "isDeprecatedLicenseId": null,
              "isFsfLibre": null,
              "isOsiApproved": null,
              "licenseComments": null,
              "licenseGroups": null,
              "licenseId": null,
              "licenseText": null,
              "name": null,
              "seeAlso": null,
              "standardLicenseHeader": null,
              "standardLicenseTemplate": null,
              "uuid": null
            }
          ],
          "name": "Example Name",
          "riskWeight": 1,
          "uuid": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "licenseId": "550e8400-e29b-41d4-a716-446655440000",
      "licenseText": "example_value",
      "name": "Example Name",
      "seeAlso": [
        "example_value"
      ],
      "standardLicenseHeader": "example_value",
      "standardLicenseTemplate": "example_value",
      "uuid": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "name": "Example Name",
  "riskWeight": 1,
  "uuid": "550e8400-e29b-41d4-a716-446655440000"
}

Request

Response

Errors