About the connector
Cisco Umbrella is a cloud security platform that provides the first line of defense against threats on the internet wherever users go. Cisco Umbrella Enforcement API allows partners and customers with their own SIEM/Threat Intelligence Platform (TIP) environments to inject events and threat intelligence into their Cisco Umbrella environment.
This document provides information about the Cisco Umbrella Enforcement Connector, which facilitates automated interactions, with a Cisco Umbrella Enforcement server using FortiSOAR™ playbooks. Add the Cisco Umbrella Enforcement Connector as a step in FortiSOAR™ playbooks and perform automated operations with Cisco Umbrella Enforcement.
Version information
Connector Version: 3.0.0
Authored By: Community
Certified: No
Release Notes for version 3.0.0
The following enhancements have been made to the Cisco Umbrella Enforcement Connector in version 3.0.0:
- Added Client ID and Client Secret as configuration parameters
- Removed the Customer Key parameter
- Added the following operations and playbooks:
- Add Destinations to Destination List
- Get All Destination List
- Get Destinations in Destination List
- Delete Destinations from the Destination List
- The following actions have been removed
- Block a Domain
- Get Blocked Domains
- Unblock Domain
Installing the connector
Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.
You can also use the following yum command as a root user to install connectors from an SSH session:
yum install cyops-connector-cisco-umbrella-enforcement
Prerequisites to configuring the connector
- You must have the URL of the Cisco Umbrella Enforcement server, to which you connect and perform automated operations, and credentials to access that server.
- The FortiSOAR™ server should have outbound connectivity to port 443 on the Cisco Umbrella Enforcement server.
Minimum Permissions Required
Configuring the connector
For the procedure to configure a connector, click here
Configuration parameters
In FortiSOAR™, on the Content Hub (or Connector Store) page, click the Manage tab, and then click the Cisco Umbrella Enforcement connector card. On the connector popup, click the Configurations tab to enter the required configuration details:
| Parameter |
Description |
| Server URL |
The service-based URL of the Cisco Umbrella Security Platform using the Enforcement API server to which you connect and perform the automated operations. |
| Client ID |
Unique ID of the Cisco Umbrella Security Platform that is used to create an authentication token required to access the API. |
| Client Secret |
Unique Client Secret of the Cisco Umbrella Security Platform that is used to create an authentication token required to access the API. |
| Verify SSL |
Specifies whether the SSL certificate for the server is to be verified.
By default, this option is set to True. |
Actions supported by the connector
The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™:
| Function |
Description |
Annotation and Category |
| Add Destinations to Destination List |
Adds destinations to a list in the Cisco Umbrella Security Platform using the Enforcement API based on the destination list ID, destinations, and other input parameters that you have specified. |
add_destination
Investigation |
| Get All Destination List |
Retrieves a list of all destinations from the Cisco Umbrella Security Platform using the Enforcement API. It does not accept any input parameters. |
get_destination_lists
Investigation |
| Get Destinations in Destination List |
Retrieves a list of all destinations in a destination list from the Cisco Umbrella Security Platform using Enforcement API based on the destination list ID that you have specified. |
list_destinations
Investigation |
| Delete Destinations from Destination List |
Delete a destination from a destination list in the Cisco Umbrella Security Platform using Enforcement API based on the destination list ID and the destination ID that you have specified. |
delete_destinations_from_list
Investigation |
operation: Add Destinations to Destination List
Input parameters
| Parameter |
Description |
| Destination List ID |
Specify the ID of the destination list to which the destinations are to be added in the Cisco Umbrella Security Platform using Enforcement API. |
| Destinations |
Specify a comma-separated list of destinations that you want to add to the Cisco Umbrella Security Platform using Enforcement API. |
| Comment |
(Optional) Specify a comment regarding the destination that you want to add to the Cisco Umbrella Security Platform using Enforcement API. |
Output
The output contains the following populated JSON schema:
{
"id": "",
"organizationId": "",
"access": "",
"isGlobal": "",
"name": "",
"thirdpartyCategoryId": "",
"createdAt": "",
"modifiedAt": "",
"isMspDefault": "",
"markedForDeletion": "",
"bundleTypeId": "",
"meta": {
"destinationCount": ""
}
}
operation: Get All Destination List
Input parameters
None.
Output
The output contains the following populated JSON schema:
{
"id": "",
"organizationId": "",
"access": "",
"isGlobal": "",
"name": "",
"thirdpartyCategoryId": "",
"createdAt": "",
"modifiedAt": "",
"isMspDefault": "",
"markedForDeletion": "",
"bundleTypeId": "",
"meta": {
"destinationCount": "",
"domainCount": "",
"urlCount": "",
"ipv4Count": ""
}
}
operation: Get Destinations in Destination List
Input parameters
| Parameter |
Description |
| Destination List ID |
Specify the ID of the destination list whose destinations you want to list. |
| Page Number |
(Optional) Specify the page number from which to retrieve results. Page numbering, by default, starts from page 1. |
| Limit |
(Optional) Specify the number of results, per page, that you want to include in the response of this operation. By default, this is set to 100. |
Output
The output contains the following populated JSON schema:
{
"id": "",
"destination": "",
"type": "",
"comment": "",
"createdAt": ""
}
operation: Delete Destinations from Destination List
Input parameters
| Parameter |
Description |
| Destination List ID |
Specify the ID of the destination list whose destinations you want to remove from the Cisco Umbrella Security Platform using Enforcement API. |
| Destinations ID |
Specify a comma-separated list of destination IDs you want to remove from the Cisco Umbrella Security Platform using Enforcement API. |
Output
The output contains the following populated JSON schema:
{
"id": "",
"organizationId": "",
"access": "",
"isGlobal": "",
"name": "",
"thirdpartyCategoryId": "",
"createdAt": "",
"modifiedAt": "",
"isMspDefault": "",
"markedForDeletion": "",
"bundleTypeId": "",
"meta": {
"destinationCount": ""
}
}
Included playbooks
The Sample - Cisco Umbrella Enforcement - 3.0.0 playbook collection comes bundled with the Cisco Umbrella Enforcement connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Cisco Umbrella Enforcement connector.
- Add Destinations to Destination List
- Delete Destinations from Destination List
- Get All Destination List
- Get Destinations in Destination List
Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during the connector upgrade and delete.
