Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
Info

NOTES:

  • API capability requires an additional WhiteSource license. Contact your CSM for more details.

  • For customers who have enabled vulnerability-based alerting, there are several changes to API version 1.3 -  refer here for details.

  • This page covers APIs for version 1.3. All version 1.3 APIs must include:

...

Code Block
{
    "projects": [
        {
            "projectName": "project_a",
            "projectToken": "project_a_token"
        },
        {
            "projectName": "project_b",
            "projectToken": "project_b_token"
        }
    ],
    "message": "Success"
}

Get

...

In-House Libraries

Get information regarding all in-house libraries on an organization, product, and project level.

...

Code Block
{
    "requestType" : "getOrganizationInHouseLibraries",
    "orgToken" : "organization_api_key",
    "userKey": "user_key"
}

Product Level

Code Block
{
    "requestType" : "getProductInHouseLibraries",
    "productToken" : "product_token",
    "userKey": "user_key"
}

Project Level

Code Block
{
    "requestType" : "getProjectInHouseLibraries",
    "projectToken" : "project_token",
    "userKey": "user_key"
}

...

Code Block
{
    "organizations": [
        {
            "orgName": "Org A",
            "orgToken": "Org_a_token"
        },
        {
            "orgName": "Org B",
            "orgToken": "Org_b_token"
        }
    ],
    "message": "Success"
}

Product Tags 

Get Product

...

Tags

Get product tags: key, value.

...

Request
Code Block
{
	"requestType": "getProductTags",
    "userKey": "user_key", 
	"productToken": productToken
}

...

Info

Products without tags are returned as well.

Save a Product Tag

Save a product tag: key, value.

...

Info

Products without tags are also returned.

Get Organizational Product Tags

Get organizational product tags: key, value.

...

Info

Products without tags are also returned.

Remove a Product Tag

Remove a product tag: key, value.

...

Code Block
{
    "message": "Successfully removed product tag"
}

Project Tags

Get Project Tags

Get project tags: key, value.

...

Info

Projects without tags are also returned.

Save a Project Tag

Save a project tag by key, value.

...

You can assign an Organization-level role to specific users or to a group of users using the below API calls. The following roles are supported:

Administrators

Administrators have control over the entire organization. They can create, invite and remove users, add products and projects and much more.
You can assign the Administrator role to a specific user or group.
Assigning the role of Administrator to individuals is not recommended. Instead, consider using only groups for simpler and easier user and role management.

...