Nucleus helps organizations centralize and manage vulnerability data from multiple security and infrastructure tools through a unified platform.  Refer to Nucleus Security official documentation.

Integration Method: API and S3

Tables: Device Inventory Info (5001), Software Inventory Info (5020), Assessment Finding (99402001), Vulnerability Finding Info (2002)

This integration supports the following events.

Note:

To ingest all event types, two separate feeds must be deployed. Vulnerability Findings is only available via S3 and other events are only available via API. For S3 ingestion configuration, refer to the linked datasource configuration documentation. First, configure the S3 ingestion datasource. Then, configure Vulnerability Findings data export and S3 bucket forwarding in Nucleus as described in the official documentation for all the projects of which Vulnerability Findings data is required to be forwarded. Only the default JSON-based forwarding format is supported. ZIP-compressed forwarding is not supported.

This integration supports the following versions.

Note:

The Nucleus API ingestion method supports only Projects, Assets, Softwares and Assessments data collection. The Nucleus S3 ingestion method supports only Vulnerability Findings data collection. To ingest all event types, at least two Nucleus feeds are needed.

Prerequisites

• The user should have org admin access role in the Nucleus to Create Custom Nucleus Role and API account with the role.

• The user should have access to the DataBee console.

Configuration Overview

1. Create Custom Nucleus Role with required permissions and generate API token using API account creation with mentioned custom role in Nucleus.

2. Add the Nucleus feed in the DataBee console with the below parameters.

   DataBee Parameter	Nucleus Parameter
   API Bearer Token	API Token
   API Base URL	Base URL for Nucleus API

Nucleus Configuration

Create Custom Nucleus Role

1. Log in to Nucleus Platform with Org Admin user.

   

2. Navigate to the left Navigation Menu > Administration > Roles.

   

3. Click on + Add Role button.
    

4. Select Organization in which role needs to be created, Name of the role and the Description. And keep the Name of role handy for creating API Account.

   

5. The following Permissions needs to be checked for a Role to fetch the data properly:

   Section	Permission
   API	API Access
   Assessments	View All Assessments
   Assets	View Assets
   Projects	Read Projects

6. Select API Access Permission.

   

7. Select View All Assessments Permission.

   

8. Select View Assets Permission.

   

9. Select Read Project Permission.

    

10. Click on the Save button.
     

Create API Account

1. Log in to Nucleus Platform with Org Admin user.

   

2. Navigate to the left Navigation Menu > Administration > Users.

   

3. Click on Add API Account button.

   

4. Select Organization in which the custom role was created and enter the API Account Username.

   

5. Select Project(s) for which the data needs to be ingested in DataBee.

    

6. For each selected project, select Role created earlier.

   

7. Click the Create Account button.

   

8. Once an API account is created, View API Key for Account action button for the created account.

   

9. Click on Show API Key.

   

10. Copy API key.

    

    Note:

    Keep the copied API key handy as it will be useful while configuring the Nucleus datasource in the Databee platform.

DataBee Configuration

1. Login to the DataBee UI, navigate to Data > Data Feeds and click the Add New Data Feed button.
    

2. Search for Nucleus and click it as shown below.
    

3. Click on the API Ingest option for the collection method.
    

4. Enter feed contact information.
    

5. In the next dialog, enter the following:

   • Authorization Method: Bearer Token

   • API Base URL: Replace <instance> with your Nucleus instance

   Note:

   Locate the Nucleus UI URL (for example, https://nucleus-test.nucleussec.com/). The <instance> value from the URL (nucleus-test in this example) should be entered in the API Base URL field.

   • Token: Paste the API Key

   • Event Types: Preselected for all the event types that integration pulls.

     

   Note:

   The Projects event type is mandatory for configuring all other event types (i.e. Asset, Software and Assessment) and is therefore non-editable in the UI.

6. Click on the Test Connection button once details are added.

   

7. Click on the Submit button once Test Connection is successful.

   

Troubleshooting Tips

• If you are facing 400 response code, this might be possibly due to an incorrect API token. Ensure the token is pasted correctly.

• If you are facing 403 response code, this might be possibly due to missing permissions. Check that Nucleus custom Role has the necessary permissions. If needed, update the Role permissions using the Nucleus platform, save the changes, and retry the integration.

• If you are not seeing data for any specific project even if it is available in the Nucleus, check for the project is added correctly with the required custom role.