Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

Alexa is a virtual assistant developed by Amazon, which is capable of voice interaction, music playback, making to-do lists, setting alarms, streaming podcasts, playing audiobooks, and providing weather, traffic, sports, and other real-time information, such as news. Alexa can also control several smart devices using itself as a home automation system. Users can extend the Alexa capabilities by installing "skills" (additional functionality developed by third-party vendors, in other settings more commonly called apps such as weather programs and audio features). The Alexa Skills Kit (ASK) is a collection of self-service APIs, tools, documentation, and code samples that makes it fast and easy for you to add skills to Alexa.

This document provides information about the Amazon Alexa connector, which facilitates automated interactions with the Alexa API using FortiSOAR™ playbooks. Add the Amazon Alexa connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving a looking up a URL using the Alexa API.

Version information

Connector Version: 1.0.0

Authored By: Fortinet.

Certified: No

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-amazon-alexa

For the detailed procedure to install a connector, click here.

Prerequisites to configuring the connector

  • You must have the access ID and secret key to the Alexa application to which you will connect and perform the automated operations.
  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Amazon Alexa connector row, and in the Configuration tab enter the required configuration details.

Parameter Description
Access ID Access ID of the Alexa application to which you will connect and perform the automated operations.
Secret Key Secret Key of the Alexa application to which you will connect and perform the automated operations

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™ release 4.10.0 onwards:

Function Description Annotation and Category
URL Lookup Looks up a URL using the Alexa API. url_lookup
Investigation

operation: URL Lookup

Input parameters

Parameter Description
URL URL that you want to look up using the Alexa API.

Output

The output contains the following populated JSON schema:

{   "aws:UrlInfoResponse": {
     "@xmlns:aws": "http://awis.amazonaws.com/doc/2005-10-05",
      "Response": {
         "OperationRequest": {
         "RequestId": "ddbbfafd-6369-11e8-a66c-1dfb182a93bb"
       },
       "UrlInfoResult": {
         "Alexa": {
           "Request": {
             "Arguments": {
               "Argument": [ 
                {                   
                        "Name": "url",

                        "Value": "www.cybersponse.com"
                 },
                 {       
                        "Name": "responsegroup",
                           "Value": "RelatedLinks,Categories,Rank,ContactInfo,RankByCountry,UsageStats,Speed,Language,OwnedDomains,LinksInCount,                                                  SiteData,AdultContent"
                 } 
              ] 
            } 
          },
           "ContactInfo": {
             "DataUrl": {
                "@type": "canonical",
                "#text": "cybersponse.com"
             },
             "PhoneNumbers": {
                "PhoneNumber": null
             },
             "OwnerName": null,
             "Email": null,
             "PhysicalAddress": null,
             "CompanyStockTicker": null
           },
           "ContentData": {
             "DataUrl": {
               "@type": "canonical",
               "#text": "cybersponse.com"
             },
             "SiteData": {
               "Title": "cybersponse.com/"
             },
             "Speed": {
               "MedianLoadTime": "1306",
               "Percentile": "60"
             },
             "AdultContent": null,
             "Language": null, 
            "LinksInCount": "14",
             "OwnedDomains": null
           },
           "Related": {
             "DataUrl": {
               "@type": "canonical",
               "#text": "cybersponse.com"
             },
             "RelatedLinks": null
           }, 
          "TrafficData": {
             "DataUrl": {
               "@type": "canonical",
               "#text": "cybersponse.com"
             },
             "Rank": "1947438",
             "RankByCountry": {
               "Country": [
                 {
                   "@Code": "US",
                   "Rank": "622051",
                   "Contribution": {
                     "PageViews": "43.8%",
                     "Users": "48.4%"
                   }
                 },
                 {
                   "@Code": "IN",
                   "Rank": "236213",
                   "Contribution": {
                     "PageViews": "37.7%",
                     "Users": "30.1%"
                   } 
                },
                 {
                   "@Code": "O",
                   "Rank": null,
                   "Contribution": {
                     "PageViews": "17.7%",
                     "Users": "20.4%"
                   }
                 } 
              ] 
            },
             "UsageStatistics": {
               "UsageStatistic": [
                 {
                   "TimeRange": {
                     "Months": "3"
                   },
                   "Rank": {
                     "Value": "1947438",
                     "Delta": "-359659"
                   },
                   "Reach": {
                     "Rank": {
                       "Value": "1729170",
                       "Delta": "-453032" 
                    },
                     "PerMillion": { 
                      "Value": "0.19",
                       "Delta": "+30%"
                     }
                   },
                   "PageViews": {
                     "PerMillion": {
                       "Value": "0.01",
                       "Delta": "+10%"
                     },
                     "Rank": {
                       "Value": "2612707",
                       "Delta": "-226810"
                     },
                     "PerUser": {
                       "Value": "1.3",
                       "Delta": "-18.01%"
                     }
                   }
                 },
                 {
                   "TimeRange": {
                     "Months": "1"
                   },
                   "Rank": {
                     "Value": "1643230",
                     "Delta": "-36680"
                   },
                   "Reach": {
                     "Rank": {
                       "Value": "1544160",
                       "Delta": "+79884"
                     },
                     "PerMillion": {
                       "Value": "0.24",
                       "Delta": "-4.12%"
                     }
                   },
                   "PageViews": {
                     "PerMillion": {
                       "Value": "0.01",
                       "Delta": "+7%"
                     },
                     "Rank": {
                       "Value": "2096106",
                       "Delta": "-165302"
                     },
                     "PerUser": {
                       "Value": "1",
                       "Delta": "+10%"
                     }
                   }
                 },
                 {
                   "TimeRange": {
                     "Days": "7"
                   },
                   "Rank": {
                     "Value": "4213230",
                    "Delta": "+3158974"
                   },
                   "Reach": {
                     "Rank": {
                       "Value": "4019579",
                       "Delta": "+2957716"
                     },
                     "PerMillion": {
                       "Value": "0.07",
                       "Delta": "-82.781%"
                     }
                   },
                   "PageViews": {
                     "PerMillion": {
                       "Value": "0",
                       "Delta": "-91.531%"
                     },
                     "Rank": {
                       "Value": "4541328",
                       "Delta": "3346234"
                     },
                     "PerUser": {
                       "Value": "1",
                       "Delta": "-50.980%"
                    }
                   }
                 }
               ]
             },
             "ContributingSubdomains": {
               "ContributingSubdomain": {
                 "DataUrl": "cybersponse.com",
                "TimeRange": {
                   "Months": "1"
                 },
                 "Reach": {
                   "Percentage": "100.00%"
                 },
                 "PageViews": {
                   "Percentage": "100.00%",
                   "PerUser": "1"
                 }
               }
             }
           }
         }
       },
       "ResponseStatus": {
         "StatusCode": "Success"       
        }     
    }   
  } 
}

Included playbooks

The Sample - Amazon Alexa - 1.0.0 playbook collection comes bundled with the Amazon Alexa connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Amazon Alexa connector.

  • URL Lookup

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 connector upgrade and delete.

About the connector

Alexa is a virtual assistant developed by Amazon, which is capable of voice interaction, music playback, making to-do lists, setting alarms, streaming podcasts, playing audiobooks, and providing weather, traffic, sports, and other real-time information, such as news. Alexa can also control several smart devices using itself as a home automation system. Users can extend the Alexa capabilities by installing "skills" (additional functionality developed by third-party vendors, in other settings more commonly called apps such as weather programs and audio features). The Alexa Skills Kit (ASK) is a collection of self-service APIs, tools, documentation, and code samples that makes it fast and easy for you to add skills to Alexa.

This document provides information about the Amazon Alexa connector, which facilitates automated interactions with the Alexa API using FortiSOAR™ playbooks. Add the Amazon Alexa connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving a looking up a URL using the Alexa API.

Version information

Connector Version: 1.0.0

Authored By: Fortinet.

Certified: No

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-amazon-alexa

For the detailed procedure to install a connector, click here.

Prerequisites to configuring the connector

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Amazon Alexa connector row, and in the Configuration tab enter the required configuration details.

Parameter Description
Access ID Access ID of the Alexa application to which you will connect and perform the automated operations.
Secret Key Secret Key of the Alexa application to which you will connect and perform the automated operations

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™ release 4.10.0 onwards:

Function Description Annotation and Category
URL Lookup Looks up a URL using the Alexa API. url_lookup
Investigation

operation: URL Lookup

Input parameters

Parameter Description
URL URL that you want to look up using the Alexa API.

Output

The output contains the following populated JSON schema:

{   "aws:UrlInfoResponse": {
     "@xmlns:aws": "http://awis.amazonaws.com/doc/2005-10-05",
      "Response": {
         "OperationRequest": {
         "RequestId": "ddbbfafd-6369-11e8-a66c-1dfb182a93bb"
       },
       "UrlInfoResult": {
         "Alexa": {
           "Request": {
             "Arguments": {
               "Argument": [ 
                {                   
                        "Name": "url",

                        "Value": "www.cybersponse.com"
                 },
                 {       
                        "Name": "responsegroup",
                           "Value": "RelatedLinks,Categories,Rank,ContactInfo,RankByCountry,UsageStats,Speed,Language,OwnedDomains,LinksInCount,                                                  SiteData,AdultContent"
                 } 
              ] 
            } 
          },
           "ContactInfo": {
             "DataUrl": {
                "@type": "canonical",
                "#text": "cybersponse.com"
             },
             "PhoneNumbers": {
                "PhoneNumber": null
             },
             "OwnerName": null,
             "Email": null,
             "PhysicalAddress": null,
             "CompanyStockTicker": null
           },
           "ContentData": {
             "DataUrl": {
               "@type": "canonical",
               "#text": "cybersponse.com"
             },
             "SiteData": {
               "Title": "cybersponse.com/"
             },
             "Speed": {
               "MedianLoadTime": "1306",
               "Percentile": "60"
             },
             "AdultContent": null,
             "Language": null, 
            "LinksInCount": "14",
             "OwnedDomains": null
           },
           "Related": {
             "DataUrl": {
               "@type": "canonical",
               "#text": "cybersponse.com"
             },
             "RelatedLinks": null
           }, 
          "TrafficData": {
             "DataUrl": {
               "@type": "canonical",
               "#text": "cybersponse.com"
             },
             "Rank": "1947438",
             "RankByCountry": {
               "Country": [
                 {
                   "@Code": "US",
                   "Rank": "622051",
                   "Contribution": {
                     "PageViews": "43.8%",
                     "Users": "48.4%"
                   }
                 },
                 {
                   "@Code": "IN",
                   "Rank": "236213",
                   "Contribution": {
                     "PageViews": "37.7%",
                     "Users": "30.1%"
                   } 
                },
                 {
                   "@Code": "O",
                   "Rank": null,
                   "Contribution": {
                     "PageViews": "17.7%",
                     "Users": "20.4%"
                   }
                 } 
              ] 
            },
             "UsageStatistics": {
               "UsageStatistic": [
                 {
                   "TimeRange": {
                     "Months": "3"
                   },
                   "Rank": {
                     "Value": "1947438",
                     "Delta": "-359659"
                   },
                   "Reach": {
                     "Rank": {
                       "Value": "1729170",
                       "Delta": "-453032" 
                    },
                     "PerMillion": { 
                      "Value": "0.19",
                       "Delta": "+30%"
                     }
                   },
                   "PageViews": {
                     "PerMillion": {
                       "Value": "0.01",
                       "Delta": "+10%"
                     },
                     "Rank": {
                       "Value": "2612707",
                       "Delta": "-226810"
                     },
                     "PerUser": {
                       "Value": "1.3",
                       "Delta": "-18.01%"
                     }
                   }
                 },
                 {
                   "TimeRange": {
                     "Months": "1"
                   },
                   "Rank": {
                     "Value": "1643230",
                     "Delta": "-36680"
                   },
                   "Reach": {
                     "Rank": {
                       "Value": "1544160",
                       "Delta": "+79884"
                     },
                     "PerMillion": {
                       "Value": "0.24",
                       "Delta": "-4.12%"
                     }
                   },
                   "PageViews": {
                     "PerMillion": {
                       "Value": "0.01",
                       "Delta": "+7%"
                     },
                     "Rank": {
                       "Value": "2096106",
                       "Delta": "-165302"
                     },
                     "PerUser": {
                       "Value": "1",
                       "Delta": "+10%"
                     }
                   }
                 },
                 {
                   "TimeRange": {
                     "Days": "7"
                   },
                   "Rank": {
                     "Value": "4213230",
                    "Delta": "+3158974"
                   },
                   "Reach": {
                     "Rank": {
                       "Value": "4019579",
                       "Delta": "+2957716"
                     },
                     "PerMillion": {
                       "Value": "0.07",
                       "Delta": "-82.781%"
                     }
                   },
                   "PageViews": {
                     "PerMillion": {
                       "Value": "0",
                       "Delta": "-91.531%"
                     },
                     "Rank": {
                       "Value": "4541328",
                       "Delta": "3346234"
                     },
                     "PerUser": {
                       "Value": "1",
                       "Delta": "-50.980%"
                    }
                   }
                 }
               ]
             },
             "ContributingSubdomains": {
               "ContributingSubdomain": {
                 "DataUrl": "cybersponse.com",
                "TimeRange": {
                   "Months": "1"
                 },
                 "Reach": {
                   "Percentage": "100.00%"
                 },
                 "PageViews": {
                   "Percentage": "100.00%",
                   "PerUser": "1"
                 }
               }
             }
           }
         }
       },
       "ResponseStatus": {
         "StatusCode": "Success"       
        }     
    }   
  } 
}

Included playbooks

The Sample - Amazon Alexa - 1.0.0 playbook collection comes bundled with the Amazon Alexa connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Amazon Alexa connector.

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 connector upgrade and delete.