Kaseya's DarkWebID
LAST UPDATED: AUG 15, 2025
Overview
Kaseya DarkWebID is a dark-web monitoring and threat intelligence platform designed to help organizations detect if their domains, email addresses, passwords, or other sensitive data have been exposed or compromised online.
D3 SOAR is providing REST operations to function with Kaseya's DarkWebID.
Kaseya's DarkWebID is available for use in:
Connection
To connect to Kaseya's DarkWebID from D3 SOAR, follow this part to collect the required information below:
Parameter | Description | Example |
Default | ||
Server URL | The base URL of the API server. | https://secure.darkwebid.com |
Authentication Type | The authentication method used for the connection. Supported types are Basic Authentication and API Key Authentication. By default, the authentication type is set to Basic Authentication. | Basic Authentication |
Basic Authentication | ||
Username | The username used to authenticate with Kaseya's DarkWebID platform. | No data in Database |
Password | The password used to authenticate with Kaseya's DarkWebID platform. | No data in Database |
API Key | ||
API Key | The API key used to authenticate the connection. | No data in Database |
Configuring Kaseya's DarkWebID to Work with D3 SOAR
Refer to Enabling API access for ID Agent to access Kaseya's DarkWebID API.
Refer to Adding users to your organization to add users and assign their roles for API access.
Configuring D3 SOAR to Work with Kaseya's DarkWebID
Log in to D3 SOAR.
Find the Kaseya's DarkWebID integration.
Navigate to Configuration on the top header menu.
Click on the Integration icon on the left sidebar.
Type Kaseya's DarkWebID in the search box to find the integration, then click it to select it.
Click on the + Connection button on the right side of the Connections section. A new connection window will appear.
Configure the following fields to create a connection to Kaseya's DarkWebID.
Connection Name: The desired name for the connection.
Site: The site on which to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.
Recipient site for events from connections Shared to Internal Sites: This field is displayed when Share to Internal Sites is selected for the Site field, allowing selection of the internal site for deploying the integration connection.
Agent Name (Optional): The proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.
Description (Optional): The description for the connection.
Tenant (Optional): When configuring the connection from a master tenant site, users can choose the specific tenant sites with which to share the connection. Once this setting is enabled, users can filter and select the desired tenant sites from the dropdowns to share the connection.
Active: The checkbox that enables the connection to be used when selected.
Configure User Permissions: Defines which users have access to the connection.
System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
1. Input the Server URL. The default value is https://secure.darkwebid.com.
2. Select the Authentication Type.
Authentication Type: Basic Authentication
3. Input the Username.
4. Input the Password.
Authentication Type: API Key
3. Input the API Key.
Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Refer to the password vault connection guide if needed.
Connection Health Check: Periodically checks the connection status by scheduling the Test Connection command at the specified interval (in minutes). Available only for active connections, this feature also allows configuring email notifications for failed attempts.
Test the connection.
Click on the Test Connection button to verify credentials and connectivity. A success alert displays Passed with a green checkmark. If the connection fails, review the parameters and retry.
Click OK to close the alert window.
Click + Add to create and add the configured connection.
Commands
Kaseya's DarkWebID includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command function, users can execute these commands independently for playbook troubleshooting.
Integration API Note
For more information about the Kaseya's DarkWebID API, refer to the Kaseya's DarkWebID API reference. It is accessible by clicking the Help icon (question mark) and selecting the API Documentation link.
Note for Time-related parameters
The input format of time-related parameters may vary based on user account settings, which may cause the sample data in commands to differ from what is displayed. To adjust the time format, follow these steps:
Navigate to Configuration > Application Settings. Select Date/Time Format.
Choose the desired date and time format, then click on the Save button.
The selected time format will now be visible when configuring Date/Time command input parameters.
Fetch Event
Retrieves events from the platform based on defined criteria.
READER NOTE
Organization UUIDs is an optional parameter to run this command.
Run the Get Organizations command to obtain the Organization UUIDs. Organization UUIDs can be found in the raw data at $.Results.list[*].uuid.
Input
Input Parameter | Required/Optional | Description | Example |
Start Time | Optional | The start of the time range for fetching events. The format is yyyy-MM-dd HH:mm:ss. | 2020-01-01 00:00:00 |
End Time | Optional | The end of the time range for fetching events. The format is yyyy-MM-dd HH:mm:ss. | 2020-10-01 00:00:00 |
Number of Event(s) Fetched | Optional | The maximum number of events to return up to a limit of 200. By default, all events matching the defined criteria are returned. | 20 |
Organization UUIDs | Optional | Filters the results by organization UUIDs. Only compromises associated with the specified organizations are returned. Organization UUIDs can be obtained using the Get Organizations command. |
JSON
|
RecordStatus | Optional | Filters the results by their status. Available options are:
| New/Unprocessed |
Output
To view the sample output data for all commands, refer to this article.
Fetch Event Field Mapping
Fetch Event commands require event field mapping. Field mapping plays a key role for data normalization within the event pipeline. Field mapping converts the original data fields from the different providers to standardized D3 fields as defined by the D3 Model. Refer to Event and Incident Intake Field Mapping for details.
To add a custom field, click on the + Add Field button. Users can also remove built-in field mappings by clicking x. Note that two underscore characters will automatically prefix the defined Field Name as the System Name for a custom field mapping. Additionally, if an input Field Name contains any spaces, they will automatically be replaced with underscores for the corresponding System Name.
As a system integration, the Kaseya's DarkWebID integration has some pre-configured field mappings for default field mapping.
Default Event Source
The Default Event Source is the default set of field mappings that are applied when this fetch event command is executed. For out-of-the-box integrations, users will find a set of field mappings provided by the system. Default event source provides field mappings for common fields from the fetched data. The default event source has a "Main Event JSON Path" (i.e. $.list) that is used to extract a batch of events from the response raw data. View the "Main Event JSON Path" by clicking on the Edit Event Source button.
Main Event JSON Path: $.list
The Main Event JSON Path determines the root path where the system starts parsing raw response data into D3 event data. The JSON path begins with $, representing the root element. The path is formed by appending a sequence of child elements to $, each separated by a dot (.). Square brackets with nested quotation marks ([‘...’]) should be used to separate child elements in JSON arrays.
For example, the root node of a JSON Path is list. The child node denoting the Unique Event Key field would be uuid. Putting it together, the JSON Path expression to extract the Unique Event Key is $.list.uuid.
The pre-configured field mappings are detailed below:
Field Name | Source Field |
Unique Event Key | .uuid |
Start Time | .detected |
Source vendor name | .source |
Organization | .organization |
Record Type | .record_type |
Record Status | .record_status |
Origin | .origin |
Compromise | .compromise |
Search Value | .search_value |
Search Record | .search_record |
Description | .description |
Source Locations | .source_locations |
Activity Title | .activity_title |
Known Attackers | .known_attackers |
Reliability Score | .reliability_score |
Record Number | .record_number |
Target Industries | .target_industries |
Hash Type | .hash_type |
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Fetch Event failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Kaseya's DarkWebID portal. Refer to the HTTP Status Code Registry for details. | Status Code: 403. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Forbidden. |
Error Sample Data Fetch Event failed. Status Code: 403. Message: Forbidden. |
Get Organization Compromises
Retrieves a list of compromises for specified organizations.
READER NOTE
Organization UUIDs is a required parameter to run this command.
Run the Get Organizations command to obtain the Organization UUIDs. Organization UUIDs can be found in the raw data at $.Results.list[*].uuid.
Input
Input Parameter | Required/Optional | Description | Example |
Organization UUIDs | Required | Filters the results by organization UUIDs. Only compromises associated with the specified organizations are returned. Organization UUIDs can be obtained using the Get Organizations command. |
JSON
|
Sort | Optional | The property used to sort the compromise results. Sorting is applied only when a field is specified. | detected |
Direction | Optional | The sorting order of the results. Valid values are "ASC" for ascending and "DESC" for descending. By default, the value is ASC. | ASC |
Page | Optional | The index of the results page to return. By default the value is 0, which is the first page. | 0 |
Limit | Optional | The number of results to return per page. The maximum is 200. By default, the value is 100. | 100 |
Record Status | Optional | Filters the results by their status. Available options are:
| New/Unprocessed |
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Get Organization Compromises failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Kaseya's DarkWebID portal. Refer to the HTTP Status Code Registry for details. | Status Code: 403. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Forbidden. |
Error Sample Data Get Organization Compromises failed. Status Code: 403. Message: Forbidden. |
Get Organizations
Retrieves a paginated list of organizations associated with the authenticated DarkWebID account.
Input
Input Parameter | Required/Optional | Description | Example |
Sort | Optional | The field by which the results are sorted. Accepted values include valid organization fields (e.g., "title", "uuid"). | title |
Direction | Optional | The sort order for the results. Valid values are "ASC" for ascending and "DESC" for descending order. By default, the value is ASC. | ASC |
Page | Optional | The index of the results page to return. By default the value is 0, which is the first page. | 0 |
Limit | Optional | The number of organizations to return per page. The maximum is 1000. By default, the value is 100. | 100 |
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Get Organizations failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Kaseya's DarkWebID portal. Refer to the HTTP Status Code Registry for details. | Status Code: 403. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Forbidden. |
Error Sample Data Get Organizations failed. Status Code: 403. Message: Forbidden. |
Get User Status
Retrieves detailed information about a specific user monitored by DarkWebID.
READER NOTE
User UUIDs is a required parameter to run this command.
Run the List Users command to obtain the User UUIDs. User UUIDs can be found in the raw data at $.Results.list[*].uuid.
Input
Input Parameter | Required/Optional | Description | Example |
User UUIDs | Required | The unique identifier of users. User UUIDs can be obtained using the List Users command. |
JSON
|
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Partially Successful or Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Get User Status failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Kaseya's DarkWebID portal. Refer to the HTTP Status Code Registry for details. | Status Code: 403. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Forbidden. |
Error Sample Data Get User Status failed. Status Code: 403. Message: Forbidden. |
List Users
Retrieves a list of users.
Input
Input Parameter | Required/Optional | Description | Example |
Sort | Optional | The field by which the results are sorted. | first_name |
Direction | Optional | The sort order for the results. Valid values are "ASC" for ascending and "DESC" for descending order. By default, the value is ASC. | ASC |
Page | Optional | The index of the results page to return. By default the value is 0, which is the first page. | 0 |
Limit | Optional | The number of organizations to return per page. The maximum is 1000. By default, the value is 100. | 100 |
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | List Users failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Kaseya's DarkWebID portal. Refer to the HTTP Status Code Registry for details. | Status Code: 403. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Forbidden. |
Error Sample Data List Users failed. Status Code: 403. Message: Forbidden. |
Live Data Search
Performs a real-time search against DarkWebID's live breach data. This command may be subject to subscription limits.
Input
Input Parameter | Required/Optional | Description | Example |
Search | Optional | The term (e.g., email or domain name) used to perform the live data search. | *****@*****.***** |
Compromised Passwords Only | Optional | Restricts results to only compromised passwords when set to True. | True |
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Live Data Search failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Kaseya's DarkWebID portal. Refer to the HTTP Status Code Registry for details. | Status Code: 403. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Forbidden. |
Error Sample Data Live Data Search failed. Status Code: 403. Message: Forbidden. |
Update User Status
Updates the status of a user in the DarkWebID platform.
READER NOTE
User UUID is a required parameter to run this command.
Run the List Users command to obtain the User UUIDs User UUIDs can be found in the raw data at $.Results.list[*].uuid.
Input
Input Parameter | Required/Optional | Description | Example |
User UUID | Required | The unique identifier of a user. User UUID can be obtained using the List Users command. | b8f4*****db6 |
Status | Required | The status to assign to the user. Available options are:
| Active |
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Update User Status failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Kaseya's DarkWebID portal. Refer to the HTTP Status Code Registry for details. | Status Code: 403. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Forbidden. |
Error Sample Data Update User Status failed. Status Code: 403. Message: Forbidden. |
Test Connection
Allows users to perform a health check on an integration connection. Users can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.
Input
N/A
Output
Output Type | Description | Return Data Type |
Return Data | Indicates one of the possible command execution states: Successful or Failed. The Failed state can be triggered by any of the following errors:
More details about an error can be viewed in the Error tab. | String |
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Test Connection failed. Failed to check the connector. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Kaseya's DarkWebID portal. Refer to the HTTP Status Code Registry for details. | Status Code: 403. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Forbidden. |
Error Sample Data Test Connection failed. Failed to check the connector. Status Code: 403. Message: Forbidden. |