Skip to main content
Black Duck
Betav0.1.0
43 actions · 1 auth method
SecurityIAM

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

API Token · Connector Profile

Exchanges a long-lived API token for a short-lived Bearer token on every request. Requires creating an Access Token from…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

API Token · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

43 actions
Action
Description
List Code Locations
List every scan code location recorded on the instance.
Get Code Location
Get a single scan code location by id.
List Code Location Scan Summaries
List the scan summaries recorded under a code location.
Delete Code Location
Delete a scan code location from the instance.
Update Code Location
Rename a code location or change its mapped project version.
List Version Components
List the bill-of-materials components on a project version.
Remove Component From Version
Remove a component from a project version’s BOM.
Add Component To Version
Manually add a component to a project version’s BOM.
List Components
Search the global component knowledge base.
Get Component
Get a single component from the knowledge base by id.
Update Component
Update the description of a catalog component.
List Licenses
Search the global license knowledge base.
Get License
Get a single license from the knowledge base by id.
List Notifications
List system notifications within a date range.
Mark Notification Read
Mark a single notification as read.
Delete Notification
Delete a single notification.
List Policy Rules
List every policy rule configured on the instance.
Create Policy Rule
Create a new compliance policy rule.
Get Policy Rule
Get a single policy rule by id.
Update Policy Rule
Update an existing compliance policy rule.
Delete Policy Rule
Delete a compliance policy rule from the instance.
List Projects
List all projects in the Black Duck instance.
Create Project
Create a new project record to attach versions and scans to.
Get Project
Get a single project by id.
Update Project
Update a project’s name or description.
Delete Project
Permanently remove a project and its version history.
List Roles
List every role defined on the instance.
Assign Role To User
Assign an existing role to a user account.
Unassign Role From User
Revoke a previously assigned role from a user account.
List Users
List every user account on the Black Duck instance.
Get Current User
Get the user account the API token belongs to.
Reset User Password
Trigger a password reset for a user account.
Create User
Create a new user account on the instance.
Get User
Get a single user account by id.
Update User
Update a user’s name or active status.
Delete User
Delete a user account from the instance.
List Project Versions
List every version recorded under a project.
Create Project Version
Create a new version under an existing project.
Get Project Version
Get a single project version by id.
Update Project Version
Update a project version’s name, phase or distribution.
Delete Project Version
Delete a single version from a project.
List Component Vulnerabilities
List vulnerabilities known for a specific component.
Get Vulnerability
Get a single vulnerability record from the knowledge base.