Zoom
Zoom Pack.#
This Integration is part of theUse the Zoom integration manage your Zoom users and meetings This integration was integrated and tested with version 2.0.0 of Zoom
#
Configure Zoom on Cortex XSOARNavigate to Settings > Integrations > Servers & Services.
Search for Zoom.
Click Add instance to create and configure a new integration instance.
Parameter Description Required Server URL (e.g. 'https://api.zoom.us/v2/') False Account ID (OAuth) False Client ID (OAuth) False Client Secret (OAuth) False API Key (JWT-Deprecated.) This authentication method will be deprecated by Zoom in June 2023. False API Secret (JWT-Deprecated.) This authentication method will be deprecated by Zoom in June 2023. False API Key (JWT-Deprecated.) This authentication method will be deprecated by Zoom in June 2023. False API Secret (JWT-Deprecated.) This authentication method will be deprecated by Zoom in June 2023. False Use system proxy settings False Trust any certificate (not secure) False Click Test to validate the URLs, token, and connection.
#
CommandsYou can execute these commands from the Cortex XSOAR 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.
#
zoom-create-userCreate a new user in zoom account
#
Base Commandzoom-create-user
#
InputArgument Name | Description | Required |
---|---|---|
first_name | First name of the new user. | Required |
last_name | Last name of the new user. | Required |
The email of the new user. | Required | |
user_type | The type of the newly created user. Note: the old type "pro" in now called "Licensed", and the type "Corporate" is not sopprted in Zoom v2 and above. . Possible values are: Basic, Licensed, pro, Corporate. Default is Basic. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Zoom.User.id | string | The ID of the created user |
Zoom.User.first_name | string | First name of the created user |
Zoom.User.last_name | string | Last name for the created user |
Zoom.User.email | string | Email of the created user |
Zoom.User.created_at | date | Created date of the user. Note that this field does not appear in zoom v2 and above. |
Zoom.User.type | number | The type of the user |
#
Command example!zoom-create-user email=example@example.com first_name=john last_name=smith user_type=Basic
#
Context Example#
Human Readable OutputUser created successfully with ID: wSQafNLNSJWq_oBzmT7XOw
#
zoom-create-meetingCreate a new zoom meeting (scheduled ,instant, or recurring)
#
Base Commandzoom-create-meeting
#
InputArgument Name | Description | Required |
---|---|---|
type | The type of the meeting. Possible values are: Instant, Scheduled, Recurring meeting with fixed time. Default is Instant. | Required |
end_date_time | For recurring meetings only. Select the final date on which the meeting will recur before it is canceled For example: 2017-11-25T12:00:00Z . | Optional |
end_times | For recurring meetings only. Select how many times the meeting should recur before it is canceled. max = 365. Default = 1. . | Optional |
monthly_day | For recurring meetings with Monthly recurrence_type only. State the day in a month, the meeting should recur. The value range is from 1 to 31. Default = 1. . | Optional |
monthly_week | For recurring meetings with Monthly recurrence_type only. State the week of the month when the meeting should recur. If you use this field, you must also use the monthly_week_day field to state the day of the week when the meeting should recur. Allowed: -1 (for last week of the month) ┃1┃2┃3┃4 . | Optional |
monthly_week_day | For recurring meetings with Monthly recurrence_type only. State a specific day in a week when the monthly meeting should recur. Allowed: 1┃2┃3┃4┃5┃6┃7 To use this field, you must also use the monthly_week field. . | Optional |
repeat_interval | For recurring meeting with fixed time only. Define the interval at which the meeting should recur. For instance, if you would like to schedule a meeting that recurs every two months, you must set the value of this field as 2 and the value of the type parameter as Monthly. For a daily meeting, the maximum is 90 days. For a weekly meeting the maximum is of 12 weeks. For a monthly meeting, there is a maximum of 3 months. . | Optional |
recurrence_type | For recurring meetings only. Set the recurrence meeting types. . Possible values are: Daily, Weekly, Monthly. | Optional |
weekly_days | For recurring meetings with a Weekly recurrence_type only. State a specific day in a week when the weekly meeting should recur. Allowed: 1┃2┃3┃4┃5┃6┃7 Default = 1. . | Optional |
auto-record-meeting | The automatic recording settings. Note that the Cloud option is available for zoom paid customers only. . Possible values are: local, cloud, none. Default is none. | Optional |
encryption_type | The type of end-to-end (E2EE) encryption, enhanced_encryption or e2ee. Possible values are: enhanced_encryption, e2ee. Default is enhanced_encryption. | Optional |
host_video | start meetings with the host video on. Possible values are: true, false. Default is True. | Optional |
join_before_host_time | If the value of the join_before_host field is true, this field sets the time that a participant can join before the meeting's host. You can choose: 5 or 10 (minuts), or 0 for any time. . Possible values are: 0, 5, 10. | Optional |
join_before_host | Whether participants can join the meeting before its host. For scheduled or recurring meetings only. The default value is False. Possible values are: false, true. | Optional |
meeting_authentication | If true, only authenticated users can join the meeting. Possible values are: false, true. Default is false. | Optional |
user | email address or id of user for meeting. | Required |
topic | The topic of the meeting. | Required |
waiting_room | This allows the host to control when a participant joins the meeting. The default is False. Possible values are: false, true. | Optional |
start-time | Meeting start time. When using a format like “yyyy-MM-ddTHH:mm:ssZ”, always use GMT time. When using a format like “yyyy-MM-ddTHH: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. | Optional |
timezone | Timezone to format start_time. For example, “America/Los_Angeles”. For scheduled meetings only. . | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Zoom.Meeting.join_url | string | Join url for the meeting |
Zoom.Meeting.id | string | Meeting id of the new meeting that is created |
Zoom.Meeting.start_url | string | The URL to start the meeting |
Zoom.Meeting.uuid | string | Unique meeting ID of the new meeting that is created |
Zoom.Meeting.status | string | The status of the meeting |
Zoom.Meeting.start_time | Date | The time that the meeting will start at |
Zoom.Meeting.host email | string | The email of the host of this meeting |
Zoom.Meeting.topic | string | The topic of the meeting |
Zoom.Meeting.duration | number | The duratian of the meeting |
Zoom.Meeting.created_at | Date | The time that this meeting was created |
Zoom.Meeting.type | number | The type of the new meeting, Instant = 1, Scheduled =2,Recurring with fixed time = 8 |
#
Command example!zoom-create-meeting topic=test type=scheduled user=example@example.com start-time=2023-01-29T12:12:12Z
#
Context Example#
Human Readable Output#
Meeting details
uuid id host_id host_email topic type status start_time duration timezone created_at start_url join_url 4gbib+fjTFmz1wH1LoE7EQ== 88454393857 uJiZN-O7Rp6Jp_995FpZGg example@example.com test 2 waiting 2023-01-29T12:12:12Z 60 Asia/Jerusalem 2023-01-15T12:44:30Z https://us06web.zoom.us/s/88454393857?zak=eyJ0eXAiOiJKV1QiLCJzdiI6IjAwMDAwMSIsInptX3NrbSI6InptX28ybSIsImFsZyI6IkhTMjU2In0.eyJhdWQiOiJjbGllbnRzbSIsInVpZCI6InVKaVpOLU83UnA2SnBfOTk1RnBaR2ciLCJpc3MiOiJ3ZWIiLCJzayI6IjczMjU5NTExMTgxNDYyODc0NjciLCJzdHkiOjEwMCwid2NkIjoidXMwNiIsImNsdCI6MCwibW51bSI6Ijg4NDU0MzkzODU3IiwiZXhwIjoxNjczNzkzODcwLCJpYXQiOjE2NzM3ODY2NzAsImFpZCI6ImFlS0QyQkZKUkFTdDFRVlVSV285Q0EiLCJjaWQiOiIifQ.5vRJBkMbmODUD_7H3bkS7OjR-MuuLUzNMJ_KeCzWc_U https://us06web.zoom.us/j/88454393857?pwd=WkI1WnVEWUdvbHhnMlJuaXU1WDNPdz09
#
zoom-fetch-recordingGet meeting record and save as file in the warroom
#
Base Commandzoom-fetch-recording
#
InputArgument Name | Description | Required |
---|---|---|
meeting_id | Meeting ID of the recorded meeting. | Required |
delete_after | Whether to delete the recording from the cloud after downloading. Possible values are: false, true. Default is true. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
File.SHA256 | Unknown | Attachment's SHA256 |
File.SHA1 | Unknown | Attachment's SHA1 |
File.MD5 | Unknown | Attachment's MD5 |
File.Name | Unknown | Attachment's Name |
File.Info | Unknown | Attachment's Info |
File.Size | Unknown | Attachment's Size (In Bytes) |
File.Extension | Unknown | Attachment's Extension |
File.Type | Unknown | Attachment's Type |
File.EntryID | Unknown | Attachment's EntryID |
File.SSDeep | Unknown | Attachment's SSDeep hash |
#
Command example!zoom-fetch-recording meeting_id=83622325727 delete_after=false
#
Context Example#
Human Readable OutputThe Audio file recording_83622325727_19bf5f8a-e77c-4b75-b09e-13983521703c.M4A was downloaded successfully
#
zoom-list-usersList the existing users
#
Base Commandzoom-list-users
#
InputArgument Name | Description | Required |
---|---|---|
status | Which status of users to list. Possible values are: active, inactive, pending. Default is active. | Optional |
page-size | Number of users to return. Max 300. The default is 30. | Optional |
next_page_token | The next page token is used to get the next page. IMPORTENT: You must pass the same page size that you pased at the first call. . | Optional |
page-number | Which page of results to return. The default = 1. Note: This argument is in a deprecate process by the API. As an alternative use "next_page_token" or "limit". . | Optional |
limit | The total amunt of results to show. | Optional |
user_id | A user ID. this is for a singel user. | Optional |
role_id | Filter the response by a specific role. For example: role_id=0 (Owner), role_id=2 (Member) . | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Zoom.Metadata.Count | number | Total page count available |
Zoom.Metadata.Number | number | Current page number |
Zoom.Metadata.Size | number | Number of results in current page |
Zoom.Metadata.Total | number | Total number of records |
Zoom.User.id | string | ID of the user |
Zoom.User.first_name | string | First name of user |
Zoom.User.last_name | string | Last name of user |
Zoom.User.email | string | Email of user |
Zoom.User.type | number | Type of user |
Zoom.User.created_at | date | Date when user was created |
Zoom.User.dept | string | Department for user |
Zoom.User.verified | number | Is the user verified |
Zoom.User.last_login_time | date | Last login time of the user |
Zoom.User.timezone | string | Default timezone for the user |
Zoom.User.pmi | string | PMI of user |
Zoom.User.group_ids | string | Groups user belongs to |
#
Command example!zoom-list-users status=pending limit=10
#
Context Example#
Human Readable Output#
Users
id type pmi verified created_at status role_id example@example.com 1 0 0 2023-01-15T12:44:34Z pending 0 example@example.com 1 0 0 2023-01-15T12:44:34Z pending 0 example@example.com 1 0 0 2023-01-15T12:44:34Z pending 0 example@example.com 1 0 0 2023-01-15T12:44:34Z pending 0 example@example.com 1 0 0 2023-01-15T12:44:34Z pending 0 example@example.com 1 0 0 2023-01-15T12:44:34Z pending 0 example@example.com 1 0 0 2023-01-15T12:44:34Z pending 0 example@example.com 1 0 0 2023-01-15T12:44:34Z pending 0 example@example.com 1 0 0 2023-01-15T12:44:34Z pending 0 example@example.com 1 0 0 2023-01-15T12:44:34Z pending 0 #
Metadata
total_records 59
#
zoom-delete-userDelete a user from Zoom
#
Base Commandzoom-delete-user
#
InputArgument Name | Description | Required |
---|---|---|
user | The user ID or email to delete. | Required |
action | The action to take. Possible values are: disassociate, delete. Default is disassociate. | Optional |
#
Context OutputThere is no context output for this command.
#
zoom-meeting-getGet the information of an existing zoom meeting
#
Base Commandzoom-meeting-get
#
InputArgument Name | Description | Required |
---|---|---|
meeting_id | The id of the existing meeting. | Required |
occurrence_id | Provide this field to view meeting details of a particular occurrence of the recurring meeting. | Optional |
show_previous_occurrences | Set the value of this field to true if you would like to view meeting details of all previous occurrences of a recurring meeting. Possible values are: false, true. Default is True. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Zoom.Meeting.join_url | string | Join url for the meeting |
Zoom.Meeting.id | string | Meeting id of the new meeting that is created |
Zoom.Meeting.start_url | string | The URL to start the meeting |
Zoom.Meeting.uuid | string | Unique meeting ID of the new meeting that is created |
Zoom.Meeting.status | string | The status of the meeting |
Zoom.Meeting.start_time | Date | The time that the meeting will start at |
Zoom.Meeting.host email | string | The email of the host of this meeting |
Zoom.Meeting.topic | string | The topic of the meeting |
Zoom.Meeting.duration | number | The duratian of the meeting |
Zoom.Meeting.created_at | Date | The time that this meeting was created |
Zoom.Meeting.type | number | The type of the new meeting, Instant = 1, Scheduled =2,Recurring with fixed time = 8 |
#
Command example!zoom-meeting-get meeting_id=88949894296
#
Context Example#
Human Readable Output#
Meeting details
uuid id host_id host_email topic type status start_time duration timezone agenda created_at start_url join_url anhEx2x6QWG7TREn71MmoA== 88949894296 uJiZN-O7Rp6Jp_995FpZGg example@example.com test 2 waiting 2022-12-29T12:12:12Z 60 Asia/Jerusalem 2022-12-29T08:10:13Z https://us06web.zoom.us/s/88949894296?zak=eyJ0eXAiOiJKV1QiLCJzdiI6IjAwMDAwMSIsInptX3NrbSI6InptX28ybSIsImFsZyI6IkhTMjU2In0.eyJhdWQiOiJjbGllbnRzbSIsInVpZCI6InVKaVpOLU83UnA2SnBfOTk1RnBaR2ciLCJpc3MiOiJ3ZWIiLCJzayI6IjczMjU5NTExMTgxNDYyODc0NjciLCJzdHkiOjEwMCwid2NkIjoidXMwNiIsImNsdCI6MCwibW51bSI6Ijg4OTQ5ODk0Mjk2IiwiZXhwIjoxNjczNzkzODc2LCJpYXQiOjE2NzM3ODY2NzYsImFpZCI6ImFlS0QyQkZKUkFTdDFRVlVSV285Q0EiLCJjaWQiOiIifQ.BTOeH_-MZRm7A5sACnDJrP_zKbzaDCWZ5orvtH4rVb0 https://us06web.zoom.us/j/88949894296?pwd=b3dzT1pzWGdrSDBBNU1FYTVRVmdadz09
#
zoom-meeting-listShow all the meetings of a given user. Note: only scheduled and unexpired meetings will appear.
#
Base Commandzoom-meeting-list
#
InputArgument Name | Description | Required |
---|---|---|
user_id | The user ID of the meetings owner. | Required |
page_size | Number of users to return. Default = 30. Max = 300. | Optional |
page_number | Which page of results to return. The default = 1. Note: This argument is in a deprecate process by the API. As an alternative use "next_page_token" or "limit". . | Optional |
next_page_token | The next page token is used to paginate te the next page. IMPORTENT: You must pass the same page size that you pased at the first call. . | Optional |
limit | The total amunt of results to show. | Optional |
type | Filter the results by searching specific types. Possible values are: all, scheduled, live, upcoming, upcoming_meetings, previous_meetings. Default is "scheduled". | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Zoom.Metadata.Total | number | Total number of records |
Zoom.Meeting.page_size | number | The size of the page returned from the API |
Zoom.Meeting.total_records | number | The total records in the API for this request. |
Zoom.Meeting.join_url | string | Join url for the meeting |
Zoom.Meeting.id | string | Meeting id of the new meeting that is created |
Zoom.Meeting.start_url | string | The URL to start the meeting |
Zoom.Meeting.uuid | string | Unique meeting ID of the new meeting that is created |
Zoom.Meeting.status | string | The status of the meeting |
Zoom.Meeting.start_time | Date | The time that the meeting will start at |
Zoom.Meeting.host email | string | The email of the host of this meeting |
Zoom.Meeting.topic | string | The topic of the meeting |
Zoom.Meeting.duration | number | The duratian of the meeting |
Zoom.Meeting.created_at | Date | The time that this meeting was created |
Zoom.Meeting.type | unknown | The ty pe of this meeting |
#
Command example!zoom-meeting-list user_id=example@example.com type=scheduled limit=7
#
Context Example#
Human Readable Output#
Meeting list
uuid id host_id topic type start time duration timezone created_at join_url z93Dc6KjSo20Wr3jx+zaYg== 83810397585 uJiZN-O7Rp6Jp_995FpZGg 2 8 60 Asia/Jerusalem 2022-12-04T10:41:27Z https://us06web.zoom.us/j/83810397585?pwd=OGFiZjRYNGhwWkVvMWZzdDBoaXlLdz09 4kZQ+Hl2RFOAz0VBPHoCYg== 84540166459 uJiZN-O7Rp6Jp_995FpZGg My recurring Meeting -Dima 8 60 Asia/Jerusalem 2022-12-06T07:59:02Z https://us06web.zoom.us/j/84540166459?pwd=ZzdmUEJ5QkZaaUZaaVpFYlBVYnFoUT09 RABXyk81T02D4hA1rgpDgQ== 89824497327 uJiZN-O7Rp6Jp_995FpZGg efe 8 60 Asia/Jerusalem 2022-12-27T21:05:41Z https://us06web.zoom.us/j/89824497327?pwd=SWpvK0I0L3pQcTNnWlF3b3VDRVhmQT09 qOXvlLOoSamJjjFaFgniTA== 83245658341 uJiZN-O7Rp6Jp_995FpZGg efe 8 60 Asia/Jerusalem 2022-12-27T21:11:01Z https://us06web.zoom.us/j/83245658341?pwd=SmNGMHI0R1hndnNlRXRDNkZ2Yms3Zz09 yHzCvl4USry+C9LnCwdnwQ== 88468901206 uJiZN-O7Rp6Jp_995FpZGg efe 8 60 Asia/Jerusalem 2022-12-27T21:25:54Z https://us06web.zoom.us/j/88468901206?pwd=RXZYQlhVbWJKZ1pLWCtpS3l1MHUxZz09 Sblh/I34S1W+rTKUcojJjw== 87525048161 uJiZN-O7Rp6Jp_995FpZGg efe 8 60 Asia/Jerusalem 2022-12-28T06:39:48Z https://us06web.zoom.us/j/87525048161?pwd=ZXlXdXl0QWlLOFVyV3U0OUxxSlBkdz09 iLXDe4HsR6uMb+x8GyybTA== 83877839723 uJiZN-O7Rp6Jp_995FpZGg efe 8 60 Asia/Jerusalem 2022-12-28T06:42:25Z https://us06web.zoom.us/j/83877839723?pwd=WU9xNmp5RW5KRDhsZ1RySkY4Zkc4Zz09 #
Metadata
total_records 60