Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

Cisco Spark is an app-centric cloud-based service that provides a complete collaboration suite for teams to create, meet, message, call, whiteboard, and share, regardless of their respective locations; in one continuous workstream before, during, and after meetings.

This document provides information about the Cisco Spark connector, which facilitates automated interactions, with a Cisco Spark server using FortiSOAR™ playbooks. Add the Cisco Spark connector as a step in FortiSOAR™ playbooks and perform automated operations, such as sending a message to a room on Cisco Spark or retrieving a list of users or rooms from Cisco Spark.

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-cisco-spark

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

Prerequisites to configuring the connector

  • You must have the URL of the Cisco Spark server to which you will connect and perform the automated operations and the credentials to access that server.
  • 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 Cisco Spark connector row, and in the Configuration tab enter the required configuration details.

Parameter Description
Server URL Server URL of the Cisco Spark to which you will connect and perform automated operations.
Client ID Client ID that is issued by Cisco Spark when you create your integration. For more information about authorization, see https://developer.webex.com/authentication.html.
Client Secret Client Secret that is issued by Cisco Spark when you create your integration. For more information about authorization, see https://developer.webex.com/authentication.html.
Authorization Code Authorization Code that is issued by Cisco Spark when you create your integration. For more information about authorization, see https://developer.webex.com/authentication.html.
Redirect URI Redirect URI that must match one of the URIs provided by Cisco Spark when you register your integration.
Access Token Access token that will be used when you are executing the majority of the connector operations. This will be automatically generated.
Refresh Token Refresh token that is used to keep the access token up-to-date. This will be automatically generated.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as 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™ release 4.10.0 onwards:

Function Description Annotation and Category
Send a Message Sends a message to a specific room on Cisco Spark, based on the room ID and other input parameters you have specified. send_message
Miscellaneous
Get Users Retrieves a list of users from Cisco Spark, based on the email address or display name prefix you have specified. get_users
Investigation
List Rooms Retrieves a list of all the rooms from Cisco Spark. get_rooms
Containment

operation: Send a Message

Input parameters

Parameter Description
Room ID ID of the room in Cisco Spark to which you want to send the message.
Recipient Email (Optional) Email address of the recipient, if you want to send a private message to a particular user in the room.
Message Message that you want to send.
Markdown Select this option, i.e., set it to True, if you want to send the message as markdown text.

Output

The output contains the following populated JSON schema:

operation: Get Users

Input parameters

Parameter Description
Email Email address of the users for who you want to search on Cisco Spark.
Note: You must specify either the email or display name prefix to search for users on Cisco Spark.
Display Name Prefix Prefix of the display name of the users for who you want to search on Cisco Spark, i.e., search for users who display name start with this value on Cisco Spark.

Output

The output contains the following populated JSON schema:

operation: List Rooms

Input parameters

None.

Output

The output contains the following populated JSON schema:

Included playbooks

The Sample - Cisco Spark - 1.0.0 playbook collection comes bundled with the Cisco Spark 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 Cisco Spark connector.

  • Get Users
  • List Rooms
  • Send a Message

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

Cisco Spark is an app-centric cloud-based service that provides a complete collaboration suite for teams to create, meet, message, call, whiteboard, and share, regardless of their respective locations; in one continuous workstream before, during, and after meetings.

This document provides information about the Cisco Spark connector, which facilitates automated interactions, with a Cisco Spark server using FortiSOAR™ playbooks. Add the Cisco Spark connector as a step in FortiSOAR™ playbooks and perform automated operations, such as sending a message to a room on Cisco Spark or retrieving a list of users or rooms from Cisco Spark.

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-cisco-spark

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 Cisco Spark connector row, and in the Configuration tab enter the required configuration details.

Parameter Description
Server URL Server URL of the Cisco Spark to which you will connect and perform automated operations.
Client ID Client ID that is issued by Cisco Spark when you create your integration. For more information about authorization, see https://developer.webex.com/authentication.html.
Client Secret Client Secret that is issued by Cisco Spark when you create your integration. For more information about authorization, see https://developer.webex.com/authentication.html.
Authorization Code Authorization Code that is issued by Cisco Spark when you create your integration. For more information about authorization, see https://developer.webex.com/authentication.html.
Redirect URI Redirect URI that must match one of the URIs provided by Cisco Spark when you register your integration.
Access Token Access token that will be used when you are executing the majority of the connector operations. This will be automatically generated.
Refresh Token Refresh token that is used to keep the access token up-to-date. This will be automatically generated.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as 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™ release 4.10.0 onwards:

Function Description Annotation and Category
Send a Message Sends a message to a specific room on Cisco Spark, based on the room ID and other input parameters you have specified. send_message
Miscellaneous
Get Users Retrieves a list of users from Cisco Spark, based on the email address or display name prefix you have specified. get_users
Investigation
List Rooms Retrieves a list of all the rooms from Cisco Spark. get_rooms
Containment

operation: Send a Message

Input parameters

Parameter Description
Room ID ID of the room in Cisco Spark to which you want to send the message.
Recipient Email (Optional) Email address of the recipient, if you want to send a private message to a particular user in the room.
Message Message that you want to send.
Markdown Select this option, i.e., set it to True, if you want to send the message as markdown text.

Output

The output contains the following populated JSON schema:

operation: Get Users

Input parameters

Parameter Description
Email Email address of the users for who you want to search on Cisco Spark.
Note: You must specify either the email or display name prefix to search for users on Cisco Spark.
Display Name Prefix Prefix of the display name of the users for who you want to search on Cisco Spark, i.e., search for users who display name start with this value on Cisco Spark.

Output

The output contains the following populated JSON schema:

operation: List Rooms

Input parameters

None.

Output

The output contains the following populated JSON schema:

Included playbooks

The Sample - Cisco Spark - 1.0.0 playbook collection comes bundled with the Cisco Spark 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 Cisco Spark 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.