AlienVault USM Anywhere
LAST UPDATED: 05/10/2024
Overview
AlienVault USM Anywhere automatically collects and analyzes data across the attack surface and helps users gain centralized security visibility without the complexity of multiple security technologies.
D3 SOAR is providing REST operations to function with AlienVault USM Anywhere.
AlienVault USM Anywhere is available for use in:
Connection
To connect to AlienVault USM Anywhere from D3 SOAR, please follow this part to collect the required information below:
Parameter | Description | Example |
Server URL | The server url of AlienVault USM Anywhere. | https://********.alienvault.cloud |
Username | The username of AlienVault USM Anywhere. | d3**** |
Password | The password of AlienVault USM Anywhere. | vIG*******GIG |
API Version | The version of the API. | 2.0 |
Configuring AlienVault USM Anywhere to Work with D3 SOAR
Please refer to https://cybersecurity.att.com/documentation/api/usm-anywhere-apis.htm?cshid=1182 to obtain your Username(Client ID) and Password(Secret Code).
Configuring D3 SOAR to Work with AlienVault USM Anywhere
Log in to D3 SOAR.
Find the AlienVault USM Anywhere integration.
Navigate to Configuration on the top header menu.
Click on the Integration icon on the left sidebar.
Type AlienVault USM Anywhere in the search box to find the integration, then click it to select it.
Click + Connection, on the right side of the Connections section. A new connection window will appear.
Configure the following fields to create a connection to AlienVault USM Anywhere.
Connection Name: The desired name for the connection.
Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as 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 appears if you selected Share to Internal Sites for Site to let you select the internal site to deploy the integration connection.
Agent Name (Optional): Specifies 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): Add your desired description for the connection.
Tenant (Optional): When configuring the connection from a master tenant site, you have the option to choose the specific tenant sites you want to share the connection with. Once you enable this setting, you can filter and select the desired tenant sites from the dropdowns to share the connection.
Configure User Permissions: Defines which users have access to the connection.
Active: Check the tick box to ensure the connection is available for use.
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.
2. Input Username.
3. Input Password from the AlienVault USM Anywhere platform.
4. Input the API Version. The default value is 2.0.Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Please refer to the password vault connection guide if needed.
Connection Health Check: Updates the connection status you have created. A connection health check is done by scheduling the Test Connection command of this integration. This can only be done when the connection is active.
To set up a connection health check, check the Connection Health Check tickbox. You can customize the interval (minutes) for scheduling the health check. An email notification can be set up after a specified number of failed connection attempts.
Test the connection.
Click Test Connection to verify the account credentials and network connection. If the Test Connection Passed alert window appears, the test connection is successful. You will see Passed with a green checkmark appear beside the Test Connection button. If the test connection fails, please check your connection parameters and try again.
Click OK to close the alert window.
Click + Add to create and add the configured connection.
Commands
AlienVault USM Anywhere includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command, you can execute these commands independently for playbook troubleshooting.
Integration API Note
For more information about the AlienVault USM Anywhere API, please refer to the AlienVault USM Anywhere API reference.
Note for Time-related parameters
The input format of time-related parameters may vary based on your account settings. As a result, the sample data provided in our commands is different from what you see. To set your preferred time format, follow these steps:
Navigate to Configuration Application Settings. Select Date/Time Format.
Choose your desired date and time format.
After that, you will be able to view your preferred time format when configuring the DateTime input parameters for commands.
Fetch Event
Returns events or alarms from the platform based on specified criteria.
Input
Input Parameter | Required/Optional | Description | Example |
Start Time | Optional | The Start Time of the specified time range for retrieving events or alarms, in UTC time. | 2020-08-20 00:00 |
End Time | Optional | The End Time of the specified time range for retrieving events or alarms, in UTC time. | 2020-08-21 00:00 |
Number of Event(s) Fetched | Optional | The number of the most recent events or alarms to fetch. | 5 |
Fetch Type | Required | The designated type of event to retrieve. | EVENTS |
Search Condition | Optional | The queries in JSON format to filter results. For fetch type is Event, available key names are "page", "account_name", "source_name", "event_name", "sensor_uuid", "source_username". Input sample like: {"event_name":"SMTP information"}; for fetch type is Alarms, available key names are "status", "rule_intent", "rule_method", "rule_strategy", "priority_label","alarm_sensor_sources". Input sample like: {"status":"open"}. | {"event_name":"SMTP information"} |
Output
Fetch Event Field Mapping
Please note that Fetch Event commands require event field mapping. Field mapping plays a key role in the data normalization process part of the event pipeline. Field mapping converts the original data fields from the different providers to the D3 fields which are standardized by the D3 Model. Please refer to Event and Incident Intake Field Mapping for details.
To customize field mapping, click + Add Field and add the custom field of your choice. You can also remove built-in field mappings by clicking x. Please 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 AlienVault USM Anywhere 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, you will find a set of field mapping provided by the system. Default event source provides field mappings for common fields from fetched detectors. The default event source has a “Main Event JSON Path” (i.e., $._embedded.eventResources) that is used to extract a batch of events from the response raw data. Click Edit Event Source to view the “Main Event JSON Path”.Main Event JSON Path: $._embedded.eventResources
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 _embedded.eventResources. 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 $._embedded.eventResources.uuid.
The pre-configured field mappings are detailed below:
Field Name | Source Field |
Start Time | .timestamp_occured |
Unique Event Key | .uuid |
Event Type | .event_type |
Event category | .event_category |
Event name | .event_name |
Description | .log |
Source IP address | .source_address |
Destination IP address | .destination_address |
SubEvent ID | .events.message.uuid |
SubEvent Type | .events.message.event_type |
SubEvent Name | .events.message.event_name |
SubEvent Category | .events.message.event_category |
SubEvent Source Address | .events.message.source_address |
SubEvent Destination Address | .events.message.destination_address |
Error Handling
If the Return Data is 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 you 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 AlienVault USM Anywhere portal. Refer to the HTTP Status Code Registry for details. | Status Code: 400. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: The value for parameter (Search Condition) is invalid. |
Error Sample Data Fetch Event failed. Status Code: 400. Message: The value for parameter (Search Condition) is invalid. |
Get Alarm By Alarm ID
Retrieves alarm(s) information based on alarm ID(s).
READER NOTE
The parameter Alarm IDs is required to run this command.
You should already have your desired Alarm IDs on hand to run this command. If you don’t, you can use the Fetch Event command with the Fetch Type parameter set to Alarms to retrieve Alarm IDs. Alarm IDs can be found in the raw data at the path $._embedded.eventResources[*].uuid.
Input
Input Parameter | Required/Optional | Description | Example |
Alarm IDs | Required | The unique identifier (ID) of the alarm(s) for alarm retrieval. Alarm IDs can be obtained using the Fetch Event command by selecting the Fetch Type parameter as Alarms. | ["a9f********4d2"] |
Output
Error Handling
If the Return Data is 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 you 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 Alarm By Alarm ID 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 AlienVault USM Anywhere portal. Refer to the HTTP Status Code Registry for details. | Status Code: 404. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Not Found. |
Error Sample Data Get Alarm By Alarm ID failed. Status Code: 404. Message: Not Found. |
Get Events By Alarm ID
Retrieves Event(s) information based on alarm ID(s).
READER NOTE
The parameter Alarm IDs is required to run this command.
You should already have your desired Alarm IDs on hand to run this command. If you don’t, you can use the Fetch Event command with the Fetch Type parameter set to Alarms to retrieve Alarm IDs. Alarm IDs can be found in the raw data at the path $._embedded.eventResources[*].uuid.
Input
Input Parameter | Required/Optional | Description | Example |
Alarm IDs | Optional | The unique identifier (ID) of the alarm(s) for event retrieval. Alarm IDs can be obtained using the Fetch Event command by selecting the Fetch Type parameter as Alarms. | ["a9f********4d2"] |
Output
Error Handling
If the Return Data is 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 you 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 Events By Alarm ID 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 AlienVault USM Anywhere portal. Refer to the HTTP Status Code Registry for details. | Status Code: 404. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Not Found. |
Error Sample Data Get Events By Alarm ID failed. Status Code: 404. Message: Not Found. |
Get Events by Event ID
Retrieves Event(s) information based on event ID(s).
READER NOTE
The parameter Event IDs is required to run this command.
You should already have your desired Event IDs on hand to run this command. If you don’t, you can use the Fetch Event command with the Fetch Type parameter set to Events to retrieve Event IDs. Event IDs can be found in the raw data at the path $._embedded.eventResources[*].uuid.
Input
Input Parameter | Required/Optional | Description | Example |
Event IDs | Optional | The unique identifier (ID) of the event(s) for event retrieval. Event IDs can be obtained using the Fetch Event command by selecting the Fetch Type parameter as Events. | ["84a********410"] |
Output
Error Handling
If the Return Data is 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 you 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 Events by Event ID 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 AlienVault USM Anywhere portal. Refer to the HTTP Status Code Registry for details. | Status Code: 404. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Not Found. |
Error Sample Data Get Events by Event ID failed. Status Code: 404. Message: Not Found. |
Test Connection
Allows you to perform a health check on an integration connection. You can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.
Input
N/A
Output
Error Handling
If the Return Data is 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 you 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 AlienVault USM Anywhere portal. Refer to the HTTP Status Code Registry for details. | Status Code: 400. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Server Url is not valid in format. |
Error Sample Data Test Connection failed. Failed to check the connector. Status Code: 400. Message: Server Url is not valid in format. |