Skip to main content

SecurityScorecard

SecurityScorecard is a security rating services tool. You can bring company and security data from SecurityScorecard into Brinqa to gain insights into your cybersecurity posture and manage risks more effectively.

This document details the information you must provide for the connector to authenticate with SecurityScorecard and how to obtain that information from SecurityScorecard. 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 SecurityScorecard from the Connector dropdown. You must provide the following information to authenticate SecurityScorecard with Brinqa:

  • API URL: The SecurityScorecard API Server URL. The default URL is https://api.securityscorecard.io.

  • API key: The API token associated with the SecurityScorecard account, which must have permissions to log in to the API server and return data.

  • Portfolio ID (Optional): The unique identifier of the portfolio to which you want to limit data synchronization. If left empty, all portfolios are synchronized.

Generate a SecurityScorecard API key

For the SecurityScorecard connector to retrieve data from the SecurityScorecard REST API, you must provide an API key. To do so, follow these steps:

  1. Log in to your organization's SecurityScorecard portal as an administrator.

  2. Click your profile photo in the top-right corner and in the dropdown, click My Settings.

  3. Click API and then click Generate New API Token.

    SecurityScorecard generate new API token

  4. Click Confirm.

    Your new API key displays. You can't view the key again after this. Copy and save it to a secure location.

note

If you do not have permissions to generate a key, contact your SecurityScorecard administrator. For additional information, see SecurityScorecard documentation.

(Optional) Create a SecurityScorecard Bot user

In addition to using an API key tied to an existing user, you can also create a "Bot User" (also known as a service account) in SecurityScorecard. This account is specifically designed to access the SecurityScorecard API and retrieve data. For additional information, see SecurityScorecard documentation.

Types of data to retrieve

The SecurityScorecard connector can retrieve the following types of data from the SecurityScorecard REST API:

Table 1: Data retrieved from SecurityScorecard

Connector ObjectRequiredMaps to Data Model
CompanyYesSite
IssueYesViolation
Issue TypeYesViolation Definition
info

The SecurityScorecard connector does not currently support operation options for the types of data it retrieves.

For detailed steps on how to view the data retrieved from SecurityScorecard 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.

Company

Table 2: Company attribute mappings

Source Field NameMaps to Attribute
DOMAINLocal variable
GRADELocal variable
INDUSTRYLocal variable
LAST_30_DAYS_SCORE_CHANGELocal variable
LAST_CAPTUREDlastCaptured
NAMEname
SCORELocal variable
SIZELocal variable
SYS_IDuid
Issue

Table 3: Issue attribute mappings

Source Field NameMaps to Attribute
ANALYSISLocal variable
ANALYSIS_DESCRIPTIONLocal variable
ASSETSLocal variable
BANNERLocal variable
BROWSERLocal variable
COMPANY_IDtargets
COOKIE_NAMELocal variable
DESCRIPTIONdescription
DESTINATION_IPLocal variable
DOMAINLocal variable
EVIDENCELocal variable
FINAL_URLLocal variable
FIRST_SEENfirstSeen
FULL_NAMEname
HOST_NAMELocal variable
INITIAL_URLLocal variable
IP_ADDRESSipAddresses
LAST_CAPTUREDlastCaptured
LAST_SEENlastSeen
MALWARE_DETECTION_METHODLocal variable
MALWARE_FAMILYLocal variable
PORTSLocal variable
PRE_SCAN_STATUSLocal variable
PRODUCT_LATEST_VERSIONLocal variable
PRODUCT_MANUFACTURERLocal variable
PRODUCT_NAMELocal variable
PRODUCT_STATE_REFERENCELocal variable
PRODUCT_STATE_STATUSLocal variable
PRODUCT_TYPELocal variable
PRODUCT_VERSIONLocal variable
RAW_COOKIELocal variable
SCAN_STATUSLocal variable
SCHEMELocal variable
SERVICESLocal variable
SOURCE_IPLocal variable
STATE_EFFECTIVE_DATELocal variable
STATE_REFERENCELocal variable
SYS_IDuid
TARGETLocal variable
URLurl, reference
USER_AGENTLocal variable
VULNERABILITY_DESCRIPTIONLocal variable
VULNERABILITY_IDLocal variable
VULNERABILITY_PUBLISH_DATELocal variable
VULNERABILITY_URLLocal variable
YEARLocal variable
Issue Type

Table 4: Issue Type attribute mappings

Source Field NameMaps to Attribute
DESCRIPTIONdescription
FACTORtags
LAST_CAPTUREDlastCaptured
RECOMMENDATIONrecommendation
SEVERITYseverity
SUMMARYsummary
SYS_IDuid, category
TITLEname
info

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

APIs

The SecurityScorecard connector uses the SecurityScorecard API. Specifically, it uses the following endpoints:

Table 5: SecurityScorecard API endpoints

Connector ObjectAPI Endpoints
CompanyGET /companies/{company.domain}/factors
GET /portfolios
GET /portfolios/{portfolioID}/companies
IssueGET /companies/{company.domain}/factors
GET /companies/{company.domain}/issues/{factor.issueSummary.type}
GET /portfolios
GET /portfolios/{portfolioID}/companies
Issue TypeGET /metadata/issue-types
GET /metadata/issue-types/{issuetype.key}

Changelog

The SecurityScorecard connector has undergone the following changes:

Table 6: SecurityScorecard connector changelog

VersionDescriptionDate Published
3.0.2New Features
- Added optional Portfolio ID configuration property to limit sync to a specific portfolio scorecard instead of pulling all portfolios.
Improvements
- Added graceful error handling for Company and Issue sync: if a scorecard or company returns a permission error (e.g., HTTP 403 for private custom scorecards that are not shared), the connector logs a warning and proceeds with the remaining companies/portfolios instead of failing the entire sync.
- Added standard LAST_CAPTURED attribute to all models to record sync capture time.
- Added TAGS attribute to the Issue Type model.
- Refined Issue Type model mappings: mapped the issue type's human-readable title to NAME and the factor category to TAGS.
- Standardized custom attribute reflection by adopting the getCustomAttributeInfos() helper pattern across all models.
- Upgraded connectors-model version to 1.6.19.
No Migration
June 19th, 2026
3.0.1Improvements
- Connector-sourced attribute values now take precedence over non-connector data channels (manual edits, bulk imports, UI input) when the platform consolidates records, so SecurityScorecard data is no longer overridden by lower-priority sources.
Bug Fixes
- Corrected the Issue model's "Year" attribute to be stored as text (was a number), matching the value returned by the SecurityScorecard API.
Migration Required
- Issue: the "Year" attribute changed from a number to text. Re-sync the SecurityScorecard connector to repopulate issues with the corrected type.
June 7th, 2026
3.0.0Initial Integration+ release.January 29th, 2025