Cisco Security Management Appliance (SMA)
App Vendor: Cisco Security Management Appliance (SMA)
App Category: Email Gateway
Connector version: 1.0.0
API Version: 1.0.0
About App
The Cisco Security Management Appliance (SMA) centralizes management and reporting functions across multiple Cisco Email Security Appliances and Cisco Web Security Appliances. This simplifies administration and planning, improves compliance monitoring, helps to enable consistent enforcement of the policy, and enhances threat protection. This also enables organizations to coordinate the management and administration of multiple security appliances across geographically dispersed teams using limited staff and budget.
Action Name | Description |
|---|---|
Add entries in the blocklist | This action adds recipient/sender blocklist entries in the Cisco Security Management Appliance (SMA). |
Search messages | This action searches messages in tracking APIs from the Cisco Security Management Appliance (SMA). |
Append entries in the blocklist | This action appends recipient/sender blocklist entries in the Cisco Security Management Appliance (SMA). |
Delete quarantined messages | This action deletes quarantine messages from the Cisco Security Management Appliance (SMA). |
Get message details | This action retrieves the details of a message in tracking APIs from the Cisco Security Management Appliance (SMA). |
Edit blocklist entries | This action edits recipient/sender blocklist entries in the Cisco Security Management Appliance (SMA). |
Get quarantined message details | This action retrieves the details of a quarantined message from the Cisco Security Management Appliance (SMA). |
Search quarantined message | This action searches quarantined messages in the Cisco Security Management Appliance (SMA). |
Configuration Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Server FQDN | Enter the FQDN for your Cisco SMA application. "https://<fqdn>:<port>" | Text | Required | |
Username | Enter the username. | Text | Required | |
Password | Enter the password. | Password | Required | |
SSL verify | Select whether or not to use the SSL verification. Example: "false" | Boolean | Optional | Allowed values:
Default value:
|
Two-factor authentication | Select whether or not to use two-factor authentication. Example: "true" | Boolean | Optional | Allowed values:
Default value:
|
Action: Add entries in the blocklist
This action adds recipient/sender blocklist entries in the Cisco Security Management Appliance (SMA).
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Email addresses | Enter the email addresses as a comma-separated list. Example: "[system@systemdefault.tld, user@systemdefault.tld]" | List | Required | |
Sender/recipient email addresses | Enter the sender/recipient email address as a comma-separated list. Example: "[system@systemdefault.tld, user@systemdefault.tld]" | Text | Required | |
Blocking type | Enter the blocking type for the entries. Example: "sender" | Text | Optional | Allowed values:
Default value:
|
Example Request
{
[
"email_addresses": "[system@systemdefault.tld, user@systemdefault.tld]",
"email_list": "[system@systemdefault.tld, user@systemdefault.tld]",
"block_type": "sender"
]
}Action: Search messages
This action searches messages in tracking APIs from the Cisco Security Management Appliance (SMA).
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Extra params | Enter the extra params as key-value pairs. | Key Value | Optional | Allowed values:
|
Example Request
[
{
"extra_params":
{
"startdate": "2018-01-01t00:00:00.000z",
"enddate": 2018-11-20t09:36:00.000z100,
"ciscohost": "all_hosts"
}
}
]Action: Append entries in blocklist
This action can be used to append recipient/sender blocklist entries in the cisco security management appliance (sma).
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Email addresses | Enter the email addresses as a comma-separated list. Example: "[system@systemdefault.tld, user@systemdefault.tld]" | List | Required | |
Sender/recipient email addresses | Enter the sender/recipient email address as a comma-separated list. Example: "[system@systemdefault.tld, user@systemdefault.tld]" | List | Required | |
Blocking type | Enter the blocking type for the entries. Example: "sender" | Text | Optional |
Example Request
{
[
"email_addresses": "[system@systemdefault.tld, user@systemdefault.tld]",
"email_list": "[system@systemdefault.tld, user@systemdefault.tld]",
"block_type": "sender"
]
}Action: Delete quarantined messages
This action deletes quarantine messages from the Cisco Security Management Appliance (SMA).
Action Input Parameters
uaParameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Messages ID | Enter the message ID. Example: "2341567" | Any | Required | |
Quarantine type | Specify the quarantine type for the deleted message. Example: "policy" | Text | Optional | Accepted values:
Default value:
|
Example Request
[
{
"messages_id": "2341567",
"quarantine_type": "policy"
}
]
Action: Get message details
This action retrieves the details of a message in tracking APIs from the Cisco Security Management Appliance (SMA).
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Message ID | Enter the message ID. Example: "1267564" | Text | Required | |
Extra params | Enter the extra parameters as key-value pairs. | Key Value | Optional | Allowed values:
|
Example Request
[
{
"message_id": "1267564",
"extra_params":
{
"startdate": "2018-01-01t00:00:00.000z",
"enddate": 2018-11-20t09:36:00.000z100,
}
}
]Action: Edit blocklist entries
This action edits recipient/sender blocklist entries in the Cisco Security Management Appliance (SMA).
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Email addresses | Enter the email addresses as a comma-separated list. Example: "[system@systemdefault.tld, user@systemdefault.tld]" | Text | Required | |
Sender/recipient email addresses | Enter the sender/recipient email address as a comma-separated list. Example: "[system@systemdefault.tld, user@systemdefault.tld]" | Text | Required | |
Blocking type | Enter the blocking type for the entries. Example: "sender" | Text | Optional | Allowed values:
Default value:
|
Example Request
{
[
"email_addresses": "[system@systemdefault.tld, user@systemdefault.tld]",
"email_list": "[system@systemdefault.tld, user@systemdefault.tld]",
"block_type": "sender"
]
}Action: Get quarantined message details
This action retrieves the details of a quarantined message from the Cisco Security Management Appliance (SMA).
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Message ID | Enter the message ID. Example: "1267546" | Text | Required | |
Quarantine type | Specify the quarantine type. | Text | Optional | Allowed values:
Default value:
|
Example Request
[
{
"message_id": "1267564",
"quarantine_type": "virus"
}
]Action: Search quarantined message
This action searches quarantined messages in the Cisco Security Management Appliance (SMA).
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Search query | Enter the search query as key-value pairs. | Key Value | Optional | Allowed keys:
|
Limit | Specify the limit. Example: "8" | Integer | Optional | Default value:
|
Quarantine type | Input the quarantine type. Example: "spam" | Text | Optional | Allowed values:
Default value:
|
Example Request
[
{
"quarantine_type": "virus",
"limit": "8",
"search_query":
{
"startdate": "2018-01-01t00:00:00.000z",
"enddate": 2018-11-20t09:36:00.000z100,
}
}
]