Zoom¶
Table of Contents¶
Release Notes¶
Version |
Date |
Notes |
---|---|---|
1.0.0 |
09/2018 |
Initial Release |
1.1.0 |
10/2021 |
Add App Host Support, Section header in app.config has been changed to |
2.0.0 |
3/2023 |
Change App type to Server-to-Server OAuth |
Overview¶
Functions to create Zoom meetings as part of a security incident response workflow/playbook.
Key Features¶
This SOAR Function package can be used to create a Zoom meeting from a workflow using the Functions feature of the Resilient Circuits integration framework.
This SOAR Function package can be used to create a Zoom meeting from a workflow/playbook using the Functions feature of the SOAR Circuits integration framework.
Requirements¶
A Zoom developers account and a Server-to-Server OAuth app.
This app supports the IBM Security QRadar SOAR Platform and the IBM Security QRadar SOAR for IBM Cloud Pak for Security.
SOAR platform¶
The SOAR platform supports two app deployment mechanisms, Edge Gateway (formerly App Host) and integration server.
If deploying to a SOAR platform with an Edge Gateway, the requirements are:
SOAR platform >=
45.0.7899
.The app is in a container-based format (available from the AppExchange as a
zip
file).
If deploying to a SOAR platform with an integration server, the requirements are:
SOAR platform >=
45.0.7899
.The app is in the older integration format (available from the AppExchange as a
zip
file which contains atar.gz
file).Integration server is running
resilient_circuits>=42.0.0
.If using an API key account, make sure the account provides the following minimum permissions:
Name
Permissions
Org Data
Read
Function
Read
The following SOAR platform guides provide additional information:
Edge Gateway Deployment Guide or App Host Deployment Guide: provides installation, configuration, and troubleshooting information, including proxy server settings.
Integration Server Guide: provides installation, configuration, and troubleshooting information, including proxy server settings.
System Administrator Guide: provides the procedure to install, configure and deploy apps.
The above guides are available on the IBM Documentation website at ibm.biz/soar-docs. On this web page, select your SOAR platform version. On the follow-on page, you can find the Edge Gateway Deployment Guide, App Host Deployment Guide, or Integration Server Guide by expanding Apps in the Table of Contents pane. The System Administrator Guide is available by expanding System Administrator.
Cloud Pak for Security¶
If you are deploying to IBM Cloud Pak for Security, the requirements are:
IBM Cloud Pak for Security >=
1.8
.Cloud Pak is configured with an Edge Gateway.
The app is in a container-based format (available from the AppExchange as a
zip
file).
The following Cloud Pak guides provide additional information:
Edge Gateway Deployment Guide or App Host Deployment Guide: provides installation, configuration, and troubleshooting information, including proxy server settings. From the Table of Contents, select Case Management and Orchestration & Automation > Orchestration and Automation Apps.
System Administrator Guide: provides information to install, configure, and deploy apps. From the IBM Cloud Pak for Security IBM Documentation table of contents, select Case Management and Orchestration & Automation > System administrator.
These guides are available on the IBM Documentation website at ibm.biz/cp4s-docs. From this web page, select your IBM Cloud Pak for Security version. From the version-specific IBM Documentation page, select Case Management and Orchestration & Automation.
Proxy Server¶
The app does support a proxy server.
Python Environment¶
Python 3.6 and Python 3.9 are supported. Additional package dependencies may exist for each of these packages:
bs4
pytz
resilient_circuits>=42.0.0
Development Version¶
This app has been implemented using:
Product Name |
Product Version |
API URL |
API Version |
---|---|---|---|
Zoom |
5.13.11 |
https://api.zoom.us/v |
v2 |
Configuration¶
Click the develop drop down menu and select build app
Choose the Server-to-Server app type
Use the Account ID, Client ID, and Client Secret to fill out the variables in the app.config. The email variable in the app.config will be the email used for the app marketplace account.
Fill in Information page
Add View and manage all user meetings and View all user information scopes
Activate the app
Installation¶
Install¶
To install or uninstall an App or Integration on the SOAR platform, see the documentation at ibm.biz/soar-docs.
To install or uninstall an App on IBM Cloud Pak for Security, see the documentation at ibm.biz/cp4s-docs and follow the instructions above to navigate to Orchestration and Automation.
App Configuration¶
The following table provides the settings you need to configure the app. These settings are made in the app.config file. See the documentation discussed in the Requirements section for the procedure.
Config |
Required |
Example |
Description |
---|---|---|---|
zoom_api_url |
Yes |
|
- |
zoom_client_id |
Yes |
|
Client ID from the app marketplace |
zoom_account_id |
Yes |
|
Account ID from the app marketplace |
zoom_marketplace_account_email |
Yes |
|
Host email |
zoom_client_secret |
Yes |
|
Client secret from the app marketplace |
zoom_api_timezone |
Yes |
|
pytz.timezone |
Function - Create Zoom Meeting¶
This will return a meeting URL to connect to a zoom meeting
Inputs:
Name |
Type |
Required |
Example |
Tooltip |
---|---|---|---|---|
|
|
No |
|
Agenda for this meeting |
|
|
No |
|
Meeting password |
|
|
No |
|
Check this to record the meeting |
|
|
Yes |
|
Meeting topic |
Outputs:
NOTE: This example might be in JSON format, but
results
is a Python Dictionary on the SOAR platform.
results = {
"attendee_url": "https://us05web.zoom.us/j/89922216709",
"attendee_url_with_pass": "https://us05web.zoom.us/j/89922216709?pwd=UTlEYWRrbUV4SHBacStvQUkvcHVPQT09",
"date_created": "03/27/2023 17:41:22",
"host_url": "https://us05web.zoom.us/s/89922216709?zak=eyJ0eXAiOiJKV1QiLCJzdiI6IjAwMDAwMSIsInptX3NrbSI6InptX28ybSIsImFsZyI6IkhTMjU2In0.eyJhdWQiOiJjbGllbnRzbSIsInVpZCI6InhWdnpidFpjU29hVkVUSXE2VHhqSlEiLCJpc3MiOiJ3ZWIiLCJzayI6IjAiLCJzdHkiOjEwMCwid2NkIjoidXMwNSIsImNsdCI6MCwibW51bSI6Ijg5OTIyMjE2NzA5IiwiZXhwIjoxNjc5OTYwNDgzLCJpYXQiOjE2Nzk5NTMyODMsImFpZCI6IkxTVjJvSHZVU3Ftd0NmeVpTcXpPcWciLCJjaWQiOiIifQ.Ka_DeS7RecJbEj-jatJS90I7TSbXKY7PBcYXlCPfrCM"
}
Example Pre-Process Script:
inputs.zoom_topic = rule.properties.zoom_topic
inputs.zoom_password = hasattr(inputs, 'zoom_password') if rule.properties.zoom_password is None else rule.properties.zoom_password
if rule.properties.zoom_agenda is not None:
inputs.zoom_agenda = rule.properties.zoom_agenda
else:
if hasattr(inputs, 'zoom_agenda') is None and incident.description is not None and incident.description.content is not None:
inputs.zoom_agenda = incident.description.content
inputs.zoom_record_meeting = hasattr(inputs, 'zoom_record_meeting') if rule.properties.zoom_record_meeting is None else rule.properties.zoom_record_meeting
Example Post-Process Script:
# results:
# {
# "host_url": "https://zoom.us/s/x?zak=x",
# "attendee_url": "https://zoom.us/j/x",
# "date_created": "01/01/1971 12:00:00",
# "attendee_url_with_pass": 'https://us05web.zoom.us/j/89922216709?pwd=UTlEYWRrbUV4SHBacStvQUkvcHVPQT09'
# }
if results.host_url is not None and results.attendee_url is not None:
host_url = results.host_url
attendee_url = results.attendee_url
if host_url is None:
host_url = ""
if attendee_url is None:
attendee_url = ""
text = """<b>Zoom Meeting:</b>
<b>Host URL:</b> <a href='{0}'>{0}</a>
<b>Attendee URL:</b> <a href='{1}'>{1}</a>""".format(results.host_url, results.attendee_url)
incident.addNote(helper.createRichText(text))
Rules¶
Rule Name |
Object |
Workflow Triggered |
---|---|---|
Example: Create Zoom Meeting: Incident |
incident |
|
Troubleshooting & Support¶
Refer to the documentation listed in the Requirements section for troubleshooting information.
For Support¶
This is a IBM Community provided App. Please search the Community ibm.biz/soarcommunity for assistance.