Skip to main content

Black Duck Polaris Platform

Black Duck Polaris Platform is a cloud-based application security solution for detecting and managing software vulnerabilities through integrated code scans and security analysis. You can bring application, open source finding, and static code finding data from Black Duck into Brinqa to centralize your organization's attack surface, thus strengthening your cybersecurity posture.

This document details the information you must provide for the connector to authenticate with Black Duck Polaris Platform and how to obtain that information from Black Duck. See create a data integration for step-by-step instructions on setting up the integration.

Required connection settings

When setting up a data integration, select Black Duck Polaris Platform from the Connector drop-down list. You must provide the following information to authenticate Black Duck Polaris Platform with Brinqa:

  • Service URL: The Black Duck Polaris API URL. The default URL is https://polaris.blackduck.com.

  • API Key: The access token associated with the user or service account for Polaris, which must have permissions to log in to the API server and return data.

Generate a Polaris access token

For the Black Duck Polaris Platform connector to use the Polaris APIs, you must provide an access token. Since Black Duck prohibits retrieving access tokens for existing users, you'll need to generate a new one. To do so, follow these steps:

  1. Log in to your organization's Black Duck Polaris Platform account.

  2. Open your user profile and select Account.

  3. Click Access Tokens, and then Create New Token.

  4. Provide a name for the API token and click Save.

    The new API token displays. You cannot view the token again. Copy the token and save it in a secure location.

note

If you do not have the permissions to create an API token, contact your Black Duck Polaris Platform administrator. For additional information, see Black Duck documentation.

(Optional) Create a service account for Black Duck Polaris Platform

In addition to creating an access token from a user account, you can also create a service account for Polaris and assign it a global or application-level role. A service account is a dedicated account that is used for automated processes and integrations, such as the Black Duck Polaris Platform connector. Service accounts have their own set of tokens that can be used for authentication. For additional information, see Black Duck documentation on how to create a service account for Polaris.

Additional settings

The Black Duck Polaris Platform connector contains additional options for specific configuration:

  • Page size: The maximum number of records to get per API request. The default setting is 100. It is not recommended to go over 100.

  • Parallel requests: The maximum number of parallel API requests. The default setting is 4.

  • Maximum retries: The maximum number of times that the integration attempts to connect to the Polaris API before giving up and reporting a failure. The default setting is 5.

Types of data to retrieve

The Black Duck Polaris Platform connector can retrieve the following types of data from the Black Duck Polaris API:

Table 1: Data retrieved from Black Duck Polaris Platform

Connector ObjectRequiredMaps to Data Model
ApplicationYesApplication
Open Source FindingYesOpen Source Finding
Open Source Finding DefinitionYesOpen Source Finding Definition
ProjectYesCode Project
Static Code FindingYesStatic Code Finding
Static Code Finding DefinitionYesStatic Code Finding Definition
info

For detailed steps on how to view the data retrieved from Black Duck Polaris Platform in the Brinqa Platform, see How to view your data.

Attribute mappings

Expand the sections below to view the mappings between the source and the Brinqa data model attributes.

Application

Table 2: Application attribute mappings

Source ValueBrinqa Attribute
portfolio item createdAtSOURCE_CREATED_DATE
portfolio item descriptionDESCRIPTION
portfolio item idUID
portfolio item inTrashIN_TRASH
portfolio item name (or id if name is empty)NAME
portfolio item portfolioIdPORTFOLIO_ID
portfolio item subscriptionTypeUsedSUBSCRIPTION_TYPE_USED
portfolio item updatedAtSOURCE_LAST_MODIFIED
note

Black Duck Polaris Platform refers to Portfolio items as applications and Portfolio subitems as projects.

Open Source Finding

Table 3: Open Source Finding attribute mappings

Source ValueBrinqa Attribute
application idAPPLICATION
branch idBRANCH_ID
context.dateTESTED_ON
context.tenantIdTENANT_ID
context.toolIdTOOL_ID
context.toolTypeTOOL_TYPE
issueProperties.component-idCOMPONENT_ID
issueProperties.component-nameCOMPONENT
issueProperties.component-version-idCOMPONENT_VERSION_ID
issueProperties.component-version-nameCOMPONENT_VERSION
issueProperties.cweCWE_IDS, WEAKNESSES
issueProperties.descriptionDESCRIPTION
issueProperties.locationFILE_NAME
issueProperties.severitySOURCE_SEVERITY
issueProperties.vulnerability-idCVE_IDS, CVE_RECORDS
issueProperties.workaroundWORKAROUND
issueProperties.entrySet().streamISSUE_PROPERTIES
issueResource.firstDetectedOnFIRST_FOUND
issueResource.idISSUE_ID, NAME
issueTypeIdISSUE_TYPE_ID
MD5 of (issueResource.id, project id)UID
MD5 of (issueTypeId, cveId)TYPE
normalized issueProperties.severitySEVERITY
normalizedStatusSOURCE_STATUS, STATUS
other-branch idOTHER_BRANCH_IDS
project idPROJECT
concatenated summary of all component informationRESULTS
score from normalized issueProperties.severitySEVERITY_SCORE
status category from normalizedStatusSTATUS_CATEGORY
targetsTARGETS
test idTEST_ID
triageProperties.entrySet().streamTRIAGE_PROPERTIES
triageProperties.dismissal-reasonDISMISSAL_REASON
triageProperties.is-dismissedDISMISSED
triageProperties.statusPROVIDER_STATUS
Open Source Finding Definition

Table 4: Open Source Finding Definition attribute mappings

Source ValueBrinqa Attribute
description from localized details or issueProperties.descriptionDESCRIPTION
issueProperties.cweCWE_IDS
issueProperties.severitySOURCE_SEVERITY
issueProperties.vulnerability-idCVE_IDS, VULNERABILITY_ID, CVE_RECORDS
issueProperties.vulnerability-sourceVULNERABILITY_SOURCE
issueProperties.overall-scoreOVERALL_SCORE
issueProperties.linked-vulnerability-idLINKED_VULNERABILITY_ID
issueResource.weaknessIdWEAKNESSES
issueType.idISSUE_TYPE_ID
issueType.nameISSUE_TYPE_NAME
issueType.name localizedCATEGORIES, ISSUE_TYPE_LOCALIZED_NAME
normalized issueProperties.severitySEVERITY
remediation from localized details or issueProperties.solutionREMEDIATION
score from normalized finding severitySEVERITY_SCORE
subcategory from localized detailsSUBCATEGORY
uidNAME, UID
Project

Table 5: Project attribute mappings

Source ValueBrinqa Attribute
portfolio subitem createdAtSOURCE_CREATED_DATE
portfolio subitem descriptionDESCRIPTION
portfolio subitem idUID
portfolio subitem inTrashIN_TRASH
portfolio subitem name (or id if name is empty)NAME
portfolio subitem portfolioItemIdAPPLICATION
portfolio subitem updatedAtSOURCE_LAST_MODIFIED
note

Black Duck Polaris Platform refers to Portfolio items as applications and Portfolio subitems as projects.

Static Code Finding

Table 6: Static Code Finding attribute mappings

Source ValueBrinqa Attribute
application idAPPLICATION
branch idBRANCH_ID
context.dateTESTED_ON
context.tenantIdTENANT_ID
context.toolIdTOOL_ID
context.toolTypeTOOL_TYPE
issueProperties.coverity-eventsCOVERITY_EVENTS
issueProperties.cweCWE_IDS, WEAKNESSES
issueProperties.descriptionDESCRIPTION
issueProperties.filenameFILENAME
issueProperties.languageLANGUAGE
issueProperties.line-numberLINE_NUMBER
issueProperties.local-effectLOCAL_EFFECT
issueProperties.locationFILE_NAME, LOCATION
issueProperties.severitySOURCE_SEVERITY
issueProperties.vulnerability-idCVE_IDS, CVE_RECORDS
issueProperties.workaroundWORKAROUND
issueProperties.entrySet().streamISSUE_PROPERTIES
issueResource.firstDetectedOnFIRST_FOUND
issueResource.idISSUE_ID, NAME
issueTypeIdISSUE_TYPE_ID
MD5 of (issueResource.id, project id)UID
MD5 of (issueTypeId, cveId)TYPE
normalized issueProperties.severitySEVERITY
normalizedStatusSOURCE_STATUS, STATUS
other-branch idOTHER_BRANCH_IDS
project idPROJECT
concatenated summary of all code informationRESULTS
score from normalized issueProperties.severitySEVERITY_SCORE
status category from normalizedStatusSTATUS_CATEGORY
targetsTARGETS
test idTEST_ID
triageProperties.entrySet().streamTRIAGE_PROPERTIES
triageProperties.dismissal-reasonDISMISSAL_REASON
triageProperties.is-dismissedDISMISSED
triageProperties.statusPROVIDER_STATUS
Static Code Finding Definition

Table 7: Static Code Finding Definition attribute mappings

Source ValueBrinqa Attribute
description from localized details or issueProperties.descriptionDESCRIPTION
issueProperties.cweCWE_IDS
issueProperties.severitySOURCE_SEVERITY
issueProperties.vulnerability-idCVE_IDS
issueResource.weaknessIdWEAKNESSES
issueType.idISSUE_TYPE_ID
issueType.nameISSUE_TYPE_NAME
issueType.name localizedCATEGORIES, ISSUE_TYPE_LOCALIZED_NAME
normalized issueProperties.severitySEVERITY
remediation from localized details or issueProperties.solutionREMEDIATION
score from normalized finding severitySEVERITY_SCORE
subcategory from localized detailsSUBCATEGORY
uidNAME, UID

Operation options

The Black Duck Polaris Platform connector supports the following operation options. See connector operation options for information about how to apply them.

Table 8: Black Duck Polaris Platform connector operation options

Connector ObjectOptionAll Possible ValuesDescriptionExample
Open Source Findingseveritylow, medium, high, criticalA comma-separated list of finding severity. Retrieve open source findings based on the specified severity as determined by Black Duck.Key: severity Value: high,critical. This key and value combination only retrieves open source findings with a severity of high or critical.
statusnot-dismissed, to-be-fixed, dismissedA comma-separated list of finding statuses. Retrieve open source findings based on the specified status as determined by Black Duck.Key: status Value: not-dismissed. This key and value combination only retrieves open source findings with a status of not-dismissed.
Open Source Finding Definitionseveritylow, medium, high, criticalA comma-separated list of finding severity. Retrieve type data for open source findings based on the specified severity as determined by Black Duck.Key: severity Value: high,critical. This key and value combination only retrieves type data for open source findings with a severity of high or critical.
statusnot-dismissed, to-be-fixed, dismissedA comma-separated list of finding statuses. Retrieve type data for open source findings based on the specified status as determined by Black Duck.Key: status Value: not-dismissed. This key and value combination only retrieves type data for open source findings with a status of not-dismissed.
Static Code Findingseveritylow, medium, high, criticalA comma-separated list of finding severity. Retrieve static code findings based on the specified severity as determined by Black Duck.Key: severity Value: high,critical. This key and value combination only retrieves static code findings with a severity of high or critical.
statusnot-dismissed, to-be-fixed, dismissedA comma-separated list of finding statuses. Retrieve static code findings based on the specified status as determined by Black Duck.Key: status Value: not-dismissed. This key and value combination only retrieves static code findings with a status of not-dismissed.
Static Code Finding Definitionseveritylow, medium, high, criticalA comma-separated list of finding severity. Retrieve type data for static code findings based on the specified severity as determined by Black Duck.Key: severity Value: high,critical. This key and value combination only retrieves type data for static code findings with a severity of high or critical.
statusnot-dismissed, to-be-fixed, dismissedA comma-separated list of finding statuses. Retrieve type data for static code findings based on the specified status as determined by Black Duck.Key: status Value: not-dismissed. This key and value combination only retrieves type data for static code findings with a status of not-dismissed.
note

The option keys and values are case-sensitive as they are shown in this documentation.

APIs

The Black Duck Polaris Platform connector uses the Black Duck Polaris API. Specifically, it uses the following endpoints:

Table 9: Black Duck Polaris API Endpoints

Connector ObjectAPI Endpoint
ApplicationGET /api/portfolios/{portfolioId}/applications
Open Source FindingGET /api/findings/issues
Open Source Finding DefinitionGET /api/findings/issues
ProjectGET /api/portfolios/{portfolioId}/applications/{applicationId}/projects
Static Code FindingGET /api/findings/issues
Static Code Finding DefinitionGET /api/findings/issues

Changelog

The Black Duck Polaris Platform connector has undergone the following changes:

note

This connector is part of a bundled release with other connectors from the same vendor. If a version shows "No change", it means that the connector version was updated for consistency as part of the bundle, but no functional changes were made to this specific connector. You can update to or skip this version without affecting your existing configuration.

Table 10: Black Duck Polaris Platform connector changelog

VersionDescriptionDate Published
3.2.1No change.November 25th, 2025
3.2.0Initial Integration+ release.October 17th, 2025