Zoom
Overview
Use the Zoom integration manage your Zoom users and meetings.
This integration was integrated and tested with Zoom v4.1.28165.0716.
Configure the Zoom integration on Demisto
- Navigate to Settings > Integrations > Servers & Services .
- Search for Zoom.
-
Click
Add instance
to create and configure a new integration instance.
- Name : a textual name for the integration instance.
- apiKey : Zoom API key for a specific license
- apiSecret : Zoom API secret for a specific license
- Use system proxy settings
- Click Test to validate the URLs and connection.
Commands
You can execute these commands from the Demisto CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.
- Create a Zoom user: zoom-create-user
- Create a Zoom meeting: zoom-create-meeting
- Get a recorded Zoom meeting: zoom-fetch-recording
- Get a list of Zoom users: zoom-list-users
- Delete a Zoom user: zoom-delete-user
Create a Zoom user
Creates a single user in your Zoom account.
Base Command
zoom-create-user
Input
| Input Parameter | Description |
| first_name | First name of the user you are creating |
| last_name | Last name of the user you are creating |
| Email address of the user you are creating | |
| user_type |
Type of user account.
|
Context Output
| Path | Description |
|---|---|
| Zoom.User.id | The ID of the created user |
| Zoom.User.first_name | First name of the created user |
| Zoom.User.last_name | Last name for the created user |
| Zoom.User.email | Email of the created user |
| Zoom.User.type | The type of the user |
Command Example
!zoom-create-user email=mockmail@demistomock.com first_name=Mock last_name=Mockinson user_type=Basic
Raw Output
{
"Zoom": {
"User": {
"first_name": "Mock",
"last_name": "Email",
"type": 1,
"email": "mockmail@demistomock.com",
"id": "sqTVZy--R-yfdDgzF6Iciw"
}
}
}
War Room Output
Create a Zoom meeting
Creates a Zoom meeting, specifying meeting topic, invited users, meeting start time, and whether to record the meeting.
Base Command
zoom-create-meeting
Input
| Input Parameter | Description |
| type |
Meeting type.
|
| user | Email address or user ID of the user you want to invite to the meeting |
| topic | Meeting topic |
| auto-record-meeting | Whether to record the meeting |
| start-time | Meeting start time. When using a format like “yyyy-MM-dd’T'HH:mm:ss'Z’”, always use GMT time. When using a format like “yyyy-MM-dd’T'HH:mm:ss”, you should use local time and you will need to specify the time zone. Only used for scheduled meetings and recurring meetings with fixed time. |
| timezone | Timezone for the meeting start-time. For example, America/Los_Angeles. This is only for scheduled meetings. |
Context Output
| Path | Description |
|---|---|
| Zoom.Meeting.join_url | Join url for the meeting |
| Zoom.Meeting.id | Meeting id of the new meeting that is created |
| Zoom.Meeting.start_url | The URL to start the meeting |
Command Example
!zoom-create-meeting type=Instant topic="Increasing documentation" user=mockmail@demistomock.com
Raw Output
{
"Zoom": {
"Meeting": {
"topic": "Increasing documentation",
"uuid": "gsUjD/HxQmyVi5Oif4W2YQ==",
"settings": {
"use_pmi": false,
"cn_meeting": false,
"alternative_hosts": "",
"watermark": false,
"approval_type": 2,
"mute_upon_entry": false,
"enforce_login": false,
"enforce_login_domains": "",
"in_meeting": false,
"participant_video": true,
"join_before_host": true,
"host_video": true,
"audio": "both",
"auto_recording": "none"
},
"created_at": "2018-07-23T08:49:03Z",
"timezone": "Asia/Jerusalem",
"start_url": "https://zoom.us/s/367272161?zak=eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJjbGllbnQiLCJ1aWQiOiJ1SmlaTi1PN1JwNkpwXzk5NUZwWkdnIiwiaXNzIjoid2ViIiwic3R5IjoxMDAsImNsdCI6MCwic3RrIjoiWG8xOWpNc3dUZGgyMDZ1WlFXSXQ1bVc5TG5MMzVaUzNxT1p1X213Yk5HNC5CZ1FnZVRReE1ISXpWVTk2ZG5oSE9IZFdOVEV2U2pCc1JUWjNiek5KVERNemIwWkFOalJsWXpsbE5tSTNPR1l5TkRKak5XSmhOVFJpTW1SaU16VTJNbUUzWkdFNVpEVmtaRFU0TTJJMVkyUTFaRFkwWm1ZMk5qUmlOREEzTXpVek5qUXpZUUFNTTBOQ1FYVnZhVmxUTTNNOUFBIiwiZXhwIjoxNTMyMzQyOTQzLCJpYXQiOjE1MzIzMzU3NDMsImFpZCI6ImFlS0QyQkZKUkFTdDFRVlVSV285Q0EiLCJjaWQiOiIifQ.axfvrRPnM8ATYWECdOcjWm-nwMcjFBOhszKbjRCXiD8",
"duration": 0,
"host_id": "uJiZN-O7Rp6Jp_995FpZGg",
"join_url": "https://zoom.us/j/367272161",
"type": 1,
"id": 367272161
}
}
}
War Room Output
Get a recorded Zoom meeting
Retrieves a recorded Zoom meeting.
Base Command
zoom-fetch-recording
Input
| Input Parameter | Description |
| meeting_id |
Meeting ID of the meeting you want to get the recording for. |
Context Output
There is no context output for this command.
Command Example
!zoom-fetch-recording meeting_id=154107399
Raw Output
{
"File": [
{
"Info": "video/mp4",
"SHA1": "96f9ad9c50ace12a513de06078ad3f68114cebd8",
"Name": "recording_154107399_cd26753b-a192-40ee-b9c6-0360e9191bf7.mp4",
"Extension": "mp4",
"Size": 10272,
"EntryID": "1590@84a5132b-1001-4cb5-883e-fa82f693358d",
"SSDeep": "192:hX6hdPEInUOoYOBD2h6zE5ksSAEiVzMAyzsly/0/GCO3G:EE8p6D06KksfEiVQA/C3G",
"SHA256": "7691889f2786acdaea9d291c97f396ded33230986a9033cfbf2b45e3b5e3031b",
"Type": "ISO Media, MP4 v2 [ISO 14496-14]\n",
"MD5": "9a572f5f112aa257101f9c38bd75259b"
},
{
"Info": "video/mp4",
"SHA1": "92e705ea254b2a9dd34bd07c6cab971ba534eab8",
"Name": "recording_154107399_abe7e541-aee8-4a16-9226-66f6508f1ec7.mp4",
"Extension": "mp4",
"Size": 1888,
"EntryID": "1592@84a5132b-1001-4cb5-883e-fa82f693358d",
"SSDeep": "12:fEb/SDSkLlYwRkq4W+R4bj8/4Vz164Jgxlsk7vZ:fc/S9tz+R48411xJ2ek7x",
"SHA256": "035dd853a1eff20c52e5062458c37ca2aefc3436fc4a69bb7a17814d3e0e9963",
"Type": "ISO Media, MP4 v2 [ISO 14496-14]\n",
"MD5": "b03011f54c1f843ee153ecfa6ca45f65"
}
]
}
War Room Output
Get a list of Zoom users
Returns a list of all Zoom users.
Base Command
zoom-list-users
Input
| Input Parameter | Description |
| status |
Status of users you want to return a list of |
| page-size |
Number of users to return, maximum is 300 |
| page-number |
Page of results to return |
Context Output
| Path | Description |
|---|---|
| Zoom.Metadata.Count | Total page count available |
| Zoom.Metadata.Number | Current page number |
| Zoom.Metadata.Size | Number of results in current page |
| Zoom.Metadata.Total | Total number of records |
| Zoom.User.id | ID of the user |
| Zoom.User.first_name | First name of the user |
| Zoom.User.last_name | Last name of the user |
| Zoom.User.email | Email of the user |
| Zoom.User.type | Type of user |
| Zoom.User.created_at | Date when the user was created |
| Zoom.User.dept | Department for the user |
| Zoom.User.verified | Is the user verified |
| Zoom.User.last_login_time | Last login time of the user |
| Zoom.User.timezone | Default timezone for the user |
| Zoom.User.pmi | PMI of user |
| Zoom.User.group_ids | Groups user belongs to |
Command Example
!zoom-list-users
Raw Output
{
"Zoom": {
"User": [
{
"first_name": "admin",
"last_name": "zoom",
"verified": 1,
"last_login_time": "2018-07-23T08:31:34Z",
"created_at": "2018-07-19T05:54:18Z",
"email": "admin@demistodev.com",
"pmi": 9409768194,
"timezone": "Asia/Jerusalem",
"type": 2,
"id": "uJiZN-O7Rp6Jp_995FpZGg"
}
],
"Metadata": {
"Count": 1,
"Total": 1,
"Number": 1,
"Size": 30
}
}
}
War Room Output
Delete a Zoom user
Deletes a specified Zoom user.
Base Command
zoom-delete-user
Input
| Input Parameter | Description |
| status |
Status of users you want to return a list of |
| page-size |
Number of users to return, maximum is 300 |
| page-number |
Page of results to return |
Context Output
There is no context output for this command.
Command Example
!zoom-delete-user user="mockmail@demistomock.com" action="disassociate"
Raw Output
There is no raw output for this command
War Room Output
