Cisco Umbrella
App Vendor: Cisco
App Category: Network Security
Connector Version: 1.0.1
API Version: 1.0.0
About App
Cisco Umbrella offers flexible, cloud-delivered security by combining multiple security functions into one solution, so you can extend protection to devices, remote users, and distributed locations anywhere. This collectively enables more sophisticated capabilities for increased flexibility, visibility, and control of your organization's network.
The Cisco Umbrella app built for the Orchestrate application helps security teams to perform network security-related actions on the Cisco Umbrella application and enable security orchestration workflows. You can execute the following actions using the app.
Action Name | Description |
|---|---|
Get details of internal domain | This action retrieves internal domain details for the current organization. |
Get a list of internal domains | This action retrieves all internal domains for the current organization. |
Get a list of virtual appliances | This action retrieves all virtual appliances for the current organization. |
Get details of a virtual appliance | This action retrieves virtual appliance details for the current organization. |
Get a list of sites | This action retrieves all sites for the current organization. |
Get details of a site | This action retrieves site details for the current organization. |
Get list of users | This action retrieves all users for the current organization. |
Get details of a user | This action retrieves user details for the current organization. |
Get a list of roles | This action retrieves all roles for the current organization. |
Get list of internal network policies | This action retrieves internal network policies for the current organization. |
Get a list of internal networks | This action retrieves all internal networks for the current organization. |
Get details of internal network | This action retrieves internal network details for the current organization. |
Get list of network policies | This action retrieves network policies for the current organization. |
Get details of a network | This action retrieves network details for the current organization. |
Get a list of networks | This action retrieves all networks for the current organization. |
Create a network device | This action creates a network device in the current organization. |
Get a list of network devices for an organization | This action retrieves a list of all network devices for the current organization. |
Get details of a network device | This action retrieves details of an existing network device. |
Remove an existing network device | This action removes an existing network device. |
Get a list of policies associated with a network device | This action retrieves a list of policies associated with a network device. |
Remove a policy from a network device | This action removes an identity to a directly applied DNS or web policy in the network device. |
Add a policy in network device | This action adds a policy to network devices. |
Get a list of organization policies | This action retrieves a list of organization policies. |
Get a list of organizations | This action retrieves a list of organizations. Currently, a single organization is returned. |
Configuration Parameters
The following configuration parameters are required for the Cisco Umbrella App to communicate with the Cisco Umbrella application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Your Key | Enter the authentication key for your Cisco Umbrella application. Example: "XXXXX76676be4514a49a79908941c6cb" | Text | Required | |
Your Secret | Enter the client secret key for your Cisco Umbrella application. Example: "XXXX44b22a8e48a6b6c5167a2ab6f85b" | Text | Required |
Get details of internal domain
This action retrieves internal domain details for the current organization.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "812056" | Integer | ||
Internal domain ID | Enter the unique ID for the internal domain. Example: "4518726" | Integer |
Example Input
[
{
"org_id": 4518726,
"internal_domain_id": 812056
}
]Get a list of internal domains
This action retrieves all internal domains for the current organization.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "812056" | Integer | Required | |
Additional query parameters | Enter the additional query parameters to filter the list of internal domains. | Key-Value | Optional | Allowed Values:
|
Example Input
[
{
"org_id": 4518726,
"query_params": {
"page": "5"
}
}
]Get a list of virtual appliances
This action retrieves all virtual appliances for the current organization.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "123345" | Integer | Required | |
Additional query parameters | Enter the additional query parameters to filter the list. | Key-Value | Optional | Allowed values:
|
Example Input
[
{
"org_id": 4518726,
"query_params": {
"page": "5"
}
}
]Get details of a virtual appliance
This action retrieves virtual appliance details for the current organization.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "567843" | Integer | Required | |
Origin ID | Enter the unique ID for the appliance origin. Example: "132324" | Integer | Required |
Example Request
[
{
"org_id": 4518726,
"origin_id": 471284038
}
]Get a list of sites
This action retrieves all sites for the current organization.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. | Integer | Required | |
Additional query parameters | Enter the additional query parameters to filter the list. | Key-Value | Optional | Allowed values:
|
Example Input
[
{
"org_id": 4518726,
"query_params": {
"page": "5"
}
}
]Get details of a site
This action retrieves site details for the current organization.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "234675" | Integer | Required | |
Site ID | Enter the site ID to get the details. Example: "897876" | Integer | Required |
Example Input
[
{
"org_id": 4518726,
"site_id": 2778334
}
]Get list of users
This action retrieves all users for the current organization.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "569739" | Integer | Required | |
Additional query parameters | Enter the additional query parameters to filter the list. | Key-Value | Optional | Allowed values:
|
Example Input
[
{
"org_id": 4518726,
"query_params": {
"page": "5"
}
}
]Get details of a user
This action retrieves user details for the current organization.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "692356" | Integer | Required | |
User ID | Enter the unique user ID to get the details. Example: "495734" | Key-Value | Required |
Example Input
[
{
"org_id": 4518726,
"user_id": 11477474
}
]Get a list of roles
This action retrieves all roles for the current organization.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "856784" | Integer | Required |
Example Input
[
{
"org_id": 4518726
}
]Get list of internal network policies
This action retrieves internal network policies for the current organization.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "123345" | Integer | Required | |
Internal Network ID | Enter the unique ID for the network policy. Example: "546789" | Integer | Required | |
Additional query parameters | Enter the additional parameters to filter the list. | Key-Value | Optional | Allowed values:
|
Example Input
[
{
"org_id": 4518726,
"network_id": 470330958,
"query_params": {
"page": "5"
}
}
]Get a list of internal networks
This action retrieves all internal networks for the current organization.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "386298" | Integer | Required | |
Additional query parameters | Enter the additional query parameters to filter the list. | Key-Value | Optional | Allowed values:
|
Example Input
[
{
"org_id": 4518726,
"query_params": {
"page": "5"
}
}
]Get details of internal network
This action retrieves internal network details for the current organization.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "756788" | Integer | Required | |
Internal network ID | Enter the unique network ID to get details of the network. Example: "114565" | Integer | Required |
Example Input
[
{
"org_id": 4518726,
"internal_network_id": 471284100
}
]Get list of network policies
This action retrieves network policies for the current organization.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "893566" | Integer | Required | |
Network ID | Enter the unique network ID to get the policy details. Example: "123487" | Integer | Required | |
Additional query parameters | Enter the additional query parameters to filter the list. | Key-Value | Optional |
Example Input
[
{
"org_id": 4518726,
"network_id": 470330958,
"query_params": {}
}
]Get details of a network
This action retrieves network details for the current organization.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "674983" | Integer | Required | |
Network ID | Enter the unique network ID to get the details of the network. | Integer | Required |
Example Input
[
{
"org_id": 4518726,
"network_id": 470330958
}
]Get a list of networks
This action retrieves all networks for the current organization.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "893467" | Integer | Required | |
Additional query parameters | Enter the additional parameters to filter the list. | Key-Value | Optional |
Example Input
[
{
"org_id": 4518726,
"query_params": {
"page": "5"
}
}
]Create a network device
This action creates a network device in the current organization.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "784123" | Integer | Required | |
Device name | Enter a name for the device. Example: "Cisco-98YB-Router1" | Text | Required | |
Device model | Enter the device model. Example: "Cisco-98YB" | Text | Required | |
Mac address | Enter the mac address for the device. Example: "F16DDC26ABBC" | Text | Required | |
Device serial number | Enter the device serial number. Example: "ABCD60E" | Text | Required | |
Tag | Enter the text tag that describes the device or the origin assigned to the device. Example: "router" | Text | Required |
Example Input
[
{
"tag": "router",
"name": "Cisco-7QP9-Router-1",
"model": "Cisco-7QP9",
"org_id": 4518726,
"mac_address": "F16DDC26ABBC",
"serial_number": "ABCD60E"
}
]Get a list of network devices for an organization
This action retrieves a list of all network devices for the current organization.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "123345" | Integer | Required |
Example Input
[
{
"org_id": 4518726
}
]Get details of a network device
This action retrieves details of an existing network device.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "563892" | Integer | Required | |
Origin ID | Enter the unique ID for the device origin. Example: "676878" | Integer | Required |
Example Input
[
{
"org_id": 4518726,
"origin_id": 471294
}
]Remove an existing network device
This action removes an existing network device.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "873423" | Integer | Required | |
Origin ID | Enter the unique ID for the network device. Example: "673234" | Integer | Required |
Example Input
[
{
"org_id": 4518726,
"origin_id": 537425612
}
]Add a policy in network device
This action adds a policy to network devices.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "237656" | Integer | Required | |
Policy ID | Enter the unique ID for the policy. Example: "345634" | Integer | Required | |
Origin ID | Enter the origin ID for the network device. Example: "129878" | Integer | Required |
Example Input
[
{
"org_id": 4518726,
"origin_id": 471290994,
"policy_id": 6250778
}
]Get a list of organization policies
This action retrieves a list of organization policies.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the unique ID of your organization. Example: "567384" | Integer | Required | |
Additional query parameters | Enter the additional query parameters to get the list. | Key-Value | Optional | Allowed values:
|
Example Input
[
{
"org_id": 4518726,
"query_params": {
"page": "5",
"limit": "10"
}
}
]Get a list of organizations
This action retrieves a list of organizations. Currently, a single organization is returned.
Input Parameters
Input parameters are not required for this action.