> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Black Duck

> How to set up the Black Duck connector, plus the actions that are available.

![Black Duck](https://stackone-logos.com/api/blackduck/filled/svg)

Betav0.1.0[See changelog](https://docs.stackone.com/connectors/blackduck/changelog.md)

[43 actions](#actions) · 1 auth method

Security
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Token · Connector Profile](https://docs.stackone.com/connectors/blackduck/guides/connector-profile/api-token.md)
>
> 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](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Token · Link Account](https://docs.stackone.com/connectors/blackduck/guides/link-account/api-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

43 actions

ActionDescription

List Code Locations`blackduck_codelocations_list`

List every scan code location recorded on the instance.

Get Code Location`blackduck_codelocations_get`

Get a single scan code location by id.

List Code Location Scan Summaries`blackduck_codelocations_scan_summaries_list`

List the scan summaries recorded under a code location.

Delete Code Location`blackduck_codelocations_delete`

Delete a scan code location from the instance.

Update Code Location`blackduck_codelocations_update`

Rename a code location or change its mapped project version.

List Version Components`blackduck_version_components_list`

List the bill-of-materials components on a project version.

Remove Component From Version`blackduck_delete_version_component`

Remove a component from a project version's BOM.

Add Component To Version`blackduck_version_components_add`

Manually add a component to a project version's BOM.

List Components`blackduck_components_list`

Search the global component knowledge base.

Get Component`blackduck_components_get`

Get a single component from the knowledge base by id.

Update Component`blackduck_components_update`

Update the description of a catalog component.

List Licenses`blackduck_licenses_list`

Search the global license knowledge base.

Get License`blackduck_licenses_get`

Get a single license from the knowledge base by id.

List Notifications`blackduck_notifications_list`

List system notifications within a date range.

Mark Notification Read`blackduck_notifications_mark_read`

Mark a single notification as read.

Delete Notification`blackduck_notifications_delete`

Delete a single notification.

List Policy Rules`blackduck_policy_rules_list`

List every policy rule configured on the instance.

Create Policy Rule`blackduck_policy_rules_create`

Create a new compliance policy rule.

Get Policy Rule`blackduck_policy_rules_get`

Get a single policy rule by id.

Update Policy Rule`blackduck_policy_rules_update`

Update an existing compliance policy rule.

Delete Policy Rule`blackduck_policy_rules_delete`

Delete a compliance policy rule from the instance.

List Projects`blackduck_projects_list`

List all projects in the Black Duck instance.

Create Project`blackduck_projects_create`

Create a new project record to attach versions and scans to.

Get Project`blackduck_projects_get`

Get a single project by id.

Update Project`blackduck_projects_update`

Update a project's name or description.

Delete Project`blackduck_projects_delete`

Permanently remove a project and its version history.

List Roles`blackduck_roles_list`

List every role defined on the instance.

Assign Role To User`blackduck_roles_assign`

Assign an existing role to a user account.

Unassign Role From User`blackduck_roles_unassign`

Revoke a previously assigned role from a user account.

List Users`blackduck_users_list`

List every user account on the Black Duck instance.

Get Current User`blackduck_users_get_current`

Get the user account the API token belongs to.

Reset User Password`blackduck_users_reset_password`

Trigger a password reset for a user account.

Create User`blackduck_users_create`

Create a new user account on the instance.

Get User`blackduck_users_get`

Get a single user account by id.

Update User`blackduck_users_update`

Update a user's name or active status.

Delete User`blackduck_users_delete`

Delete a user account from the instance.

List Project Versions`blackduck_project_versions_list`

List every version recorded under a project.

Create Project Version`blackduck_project_versions_create`

Create a new version under an existing project.

Get Project Version`blackduck_project_versions_get`

Get a single project version by id.

Update Project Version`blackduck_update_project_version`

Update a project version's name, phase or distribution.

Delete Project Version`blackduck_delete_project_version`

Delete a single version from a project.

List Component Vulnerabilities`blackduck_component_vulnerabilities_list`

List vulnerabilities known for a specific component.

Get Vulnerability`blackduck_get_vulnerability`

Get a single vulnerability record from the knowledge base.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.