IriusRisk
IriusRisk is a threat intelligence tool that helps organizations identify and mitigate security risks in their projects. You can bring component, counter measure, project, and threat data from IriusRisk into Brinqa to gain a unified view of your attack surface, thus strengthening your cybersecurity posture.
This document details the information you must provide for the connector to authenticate with IriusRisk and how to obtain that information from IriusRisk. 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 IriusRisk from the Connector drop-down. If you cannot find the connector in the drop-down, make sure that you have installed it first. You must provide the following information to authenticate IriusRisk with Brinqa:
-
URL: Your organization's IriusRisk portal URL. The default format is
https://<servername>/
-
API token: The API token associated with the IriusRisk account, which must have permissions to log in to the API server and return data.
Create read-only roles in IriusRisk
To ensure that the IriusRisk connector has the appropriate permissions to access and retrieve data from the IriusRisk API, it is recommended to create a dedicated API access and read-only roles in IriusRisk.
IriusRisk uses two role types:
-
Global roles: Provide system-wide permissions across all projects and business units.
-
Project roles: Apply to specific projects or business units and are automatically assigned when a user is added to a project.
The IriusRisk connector requires both role types. For additional information, see IriusRisk documentation on Assigning Global and Project Roles.
To create the read-only roles, follow these steps:
-
Log in to your IriusRisk portal as an administrator.
-
Navigate to Settings > User settings > Permissions.
-
Click the Global roles tab, and then click Create role.
The Create role dialog displays.
-
Provide a Name and Description, and then enable the following permissions:
-
API_ACCESS
-
COMPONENT_DEFINITION_VIEW
-
PRODUCTS_LIST_ALL
-
-
Click Create.
-
Click the Project roles tab, and then click Create role.
The Create role dialog displays.
-
Provide a Name and Description, and then enable the following permissions:
-
COUNTERMEASURE_VIEW
-
THREAT_VIEW
-
-
Click Create.
If you do not have permissions to create a new role, contact your IriusRisk administrator. For additional information, see IriusRisk documentation.
Assign the read-only roles to a new user
After creating the read-only roles, you can create a new IriusRisk user and assign those roles to the user. To do so, follow these steps:
-
Log in to your IriusRisk portal as an administrator.
-
Navigate to Settings > User settings > Users.
-
Click Create user.
The Create user dialog displays.
-
Provide a First name and Last name, Username, Email, and Password.
-
Click the Global roles drop-down and select the API access and read-only global role that you created earlier.
-
Click the Project roles drop-down and select the API access and read-only project role that you created earlier.
-
Click Create.
The new user displays in the list of users. The new user can now log in to the IriusRisk portal and generate an API token to use with the IriusRisk connector.
If you do not have permissions to create a new user, contact your IriusRisk administrator. For additional information, see IriusRisk documentation.
Create an IriusRisk API token
For the IriusRisk connector to use the IriusRisk API, you must provide an API token. To obtain an API token, follow these steps:
-
Log in to your organization's IriusRisk portal as the dedicated read-only user.
-
Click the user profile in the upper-right corner of the page, and then select User profile from the drop-down.
-
Locate the Authentication section on the page, and then click Generate API token.
Your new API token displays. You can't view the token again after this. Copy and save it to a secure location.
If you do not have permissions to create an API token, contact your IriusRisk administrator. For additional information, see IriusRisk documentation.
Additional settings
The IriusRisk connector contains additional options for specific configuration:
-
Maximum retries: The maximum number of times that the integration attempts to connect to the IriusRisk API before giving up and reporting a failure. The default setting is 5.
-
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.
Types of data to retrieve
The IriusRisk connector can retrieve the following types of data from the IriusRisk API:
Table 1: Data retrieved from IriusRisk
Connector Object | Required | Maps to Data Model |
---|---|---|
Component | Yes | Package |
Countermeasure | No | Not mapped |
Project | Yes | Application |
Threat | Yes | Violation |
Threat Definition | Yes | Violation Definition |
The IriusRisk 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 IriusRisk 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.
Component
Table 2: Component attribute mappings
Source Field Name | Maps to Attribute |
---|---|
Category | categories |
componentDefinition | Local variable |
description | description |
diagramComponentId | Local variable |
id | uid |
name | name |
parent | Local variable |
project | Local variable, target |
referenceId | Local variable |
tags | tags |
Project
Table 3: Project attribute mappings
Source Field Name | Maps to Attribute |
---|---|
Category | categories |
description | description |
id | uid |
isArchived | Local variable |
isBlueprint | Local variable |
isThreatModelLocked | Local variable |
modelUpdated | Local variable |
name | name |
operation | Local variable |
readOnly | Local variable |
referenceId | Local variable |
state | status |
tags | tags |
version | Local variable |
workflowState | Local variable |
Threat
Table 4: Threat attribute mappings
Source Field Name | Maps to Attribute |
---|---|
component | component, targets |
expiryDate | Local variable |
id | uid |
library | Local variable |
mitigation | Local variable |
name | type, uid, name |
owner | Local variable |
project | project, targets |
projectedRisk | Local variable |
source | Local variable |
state | Local variable, status, statusCategory, providerStatus |
Threat Definition
Table 5: Threat Definition attribute mappings
Source Field Name | Maps to Attribute |
---|---|
availability | Local variable |
confidentiality | Local variable |
description | description |
easeOfExploitation | Local variable |
edited | Local variable |
effectiveMitigation | Local variable |
id | uid |
inherentRisk | Local variable |
integrity | Local variable |
issueId | Local variable |
issueLink | Local variable |
issueState | Local variable |
name | type, uid, name |
referenceId | Local variable, tags |
risk | Local variable, sourceSeverity, severityScore |
useCase | Local variable |
APIs
The IriusRisk connector uses the IriusRisk API v2. Specifically, it uses the following endpoints:
Table 6: IriusRisk API Endpoints
Connector Object | API Endpoints |
---|---|
Component | GET /api/v2/projects/{projectId}/components |
Countermeasure | GET /api/v2/projects/{projectId}/countermeasures |
Project | GET /api/v2/projects |
Threat | GET /api/v2/projects/{projectId}/threats |
Threat Definition | GET /api/v2/projects/{projectId}/threats |
Changelog
The IriusRisk connector has undergone the following changes:
Table 7: IriusRisk connector changelog
Version | Description | Date Published |
---|---|---|
3.0.0 | Initial Integration+ release. | September 16th, 2025 |