{"openapi":"3.1.0","info":{"title":"Ferrule Zoom Users API","version":"1.0.0","description":"REST API for Zoom Users via the Ferrule gateway.","contact":{"name":"Ferrule","url":"https://ferrule.io"}},"servers":[{"url":"https://0.0.0.0:3000","description":"Ferrule gateway"}],"paths":{"/api/v1/zoom-users/contact-groups":{"get":{"operationId":"zoom-users.list_contact_groups","description":"List all contact groups for the authenticated user's account.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"next_page_token","schema":{"description":"Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"Number of records per page. Defaults and maximums vary by endpoint.","type":"number"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"groups":{"type":"array","items":{"type":"object","properties":{"group_id":{"type":"string"},"group_name":{"type":"string"},"group_privacy":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"description":{"type":"string"}},"additionalProperties":{}}},"next_page_token":{"type":"string"},"page_size":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/contact-groups/{groupId}":{"get":{"operationId":"zoom-users.get_contact_group","description":"Get a single contact group by ID. Returns group name and member count.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"groupId","schema":{"type":"string","description":"Contact group ID"},"required":true,"description":"Contact group ID"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"group_id":{"type":"string"},"group_name":{"type":"string"},"total_members":{"type":"number"},"group_privacy":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"description":{"type":"string"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/contact-groups/{groupId}/members":{"get":{"operationId":"zoom-users.list_contact_group_members","description":"List members of a specific contact group.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"groupId","schema":{"type":"string","description":"Contact group ID"},"required":true,"description":"Contact group ID"},{"in":"query","name":"next_page_token","schema":{"description":"Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"Number of records per page. Defaults and maximums vary by endpoint.","type":"number"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"group_members":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}},"next_page_token":{"type":"string"},"page_size":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/divisions":{"get":{"operationId":"zoom-users.list_divisions","description":"List all divisions in the account.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"next_page_token","schema":{"description":"Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"Number of records per page. Defaults and maximums vary by endpoint.","type":"number"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"page_size":{"type":"number"},"total_records":{"type":"number"},"divisions":{"maxItems":300,"type":"array","items":{"type":"object","properties":{"division_id":{"type":"string"},"division_name":{"type":"string"},"division_description":{"type":"string"},"is_main_division":{"type":"boolean"},"total_members":{"type":"number"}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/divisions/{divisionId}":{"get":{"operationId":"zoom-users.get_division","description":"Get a single division by ID.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"divisionId","schema":{"type":"string","description":"Division ID"},"required":true,"description":"Division ID"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"division_id":{"type":"string"},"division_name":{"type":"string"},"division_description":{"type":"string"},"is_main_division":{"type":"boolean"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/divisions/{divisionId}/members":{"get":{"operationId":"zoom-users.list_division_members","description":"List members of a specific division.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"divisionId","schema":{"type":"string","description":"Division ID"},"required":true,"description":"Division ID"},{"in":"query","name":"next_page_token","schema":{"description":"Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"Number of records per page. Defaults and maximums vary by endpoint.","type":"number"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"page_size":{"type":"number"},"total_records":{"type":"number"},"users":{"maxItems":300,"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string"},"user_display_name":{"type":"string"},"user_email":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/groups":{"get":{"operationId":"zoom-users.list_groups","description":"List all groups in the account.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"next_page_token","schema":{"description":"Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"Number of records per page. Defaults and maximums vary by endpoint.","type":"number"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"groups":{"maxItems":300,"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string"}},"additionalProperties":{}},{"type":"object","properties":{"name":{"type":"string"},"total_members":{"type":"number"}},"additionalProperties":{}}]}},"total_records":{"type":"number"},"next_page_token":{"type":"string"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/groups/{groupId}":{"get":{"operationId":"zoom-users.get_group","description":"Get a single group by ID. Returns group name, member count, and total members.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"groupId","schema":{"type":"string","description":"Group ID"},"required":true,"description":"Group ID"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"total_members":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/groups/{groupId}/admins":{"get":{"operationId":"zoom-users.list_group_admins","description":"List admins of a specific group.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"groupId","schema":{"type":"string","description":"Group ID"},"required":true,"description":"Group ID"},{"in":"query","name":"next_page_token","schema":{"description":"Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"Number of records per page. Defaults and maximums vary by endpoint.","type":"number"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"admins":{"maxItems":300,"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}},"next_page_token":{"type":"string"},"page_size":{"type":"number"},"total_records":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/groups/{groupId}/channels":{"get":{"operationId":"zoom-users.list_group_channels","description":"List channels of a specific group.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"groupId","schema":{"type":"string","description":"Group ID"},"required":true,"description":"Group ID"},{"in":"query","name":"next_page_token","schema":{"description":"Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"Number of records per page. Defaults and maximums vary by endpoint.","type":"number"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"channels":{"type":"array","items":{"type":"object","properties":{"channel_id":{"type":"string"},"channel_name":{"type":"string"},"member_count":{"type":"number"}},"required":["channel_id","channel_name","member_count"],"additionalProperties":{}}},"group_id":{"type":"string"}},"required":["channels","group_id"],"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/groups/{groupId}/lock-settings":{"get":{"operationId":"zoom-users.get_group_lock_settings","description":"Get locked settings for a group. Shows which settings are locked by admin.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"groupId","schema":{"type":"string","description":"Group ID"},"required":true,"description":"Group ID"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"audio_conferencing":{"type":"object","properties":{"toll_free_and_fee_based_toll_call":{"type":"boolean"},"toll_call":{"type":"boolean"},"call_me_and_invite_by_phone":{"type":"boolean"},"personal_audio_conference":{"type":"boolean"},"participant_phone_masking":{"type":"boolean"}},"additionalProperties":{}},"email_notification":{"type":"object","properties":{"alternative_host_reminder":{"type":"boolean"},"cancel_meeting_reminder":{"type":"boolean"},"cloud_recording_available_reminder":{"type":"boolean"},"jbh_reminder":{"type":"boolean"},"schedule_for_reminder":{"type":"boolean"}},"additionalProperties":{}},"in_meeting":{"type":"object","properties":{"alert_guest_join":{"type":"boolean"},"allow_users_to_delete_messages_in_meeting_chat":{"type":"boolean"},"allow_live_streaming":{"type":"boolean"},"allow_show_zoom_windows":{"type":"boolean"},"annotation":{"type":"boolean"},"attendee_on_hold":{"default":false,"type":"boolean"},"auto_answer":{"type":"boolean"},"auto_generated_captions":{"type":"boolean"},"auto_saving_chat":{"type":"boolean"},"breakout_room":{"type":"boolean"},"chat":{"type":"boolean"},"meeting_question_answer":{"type":"boolean"},"closed_caption":{"type":"boolean"},"co_host":{"type":"boolean"},"custom_data_center_regions":{"type":"boolean"},"disable_screen_sharing_for_host_meetings":{"type":"boolean"},"disable_screen_sharing_for_in_meeting_guests":{"type":"boolean"},"e2e_encryption":{"type":"boolean"},"entry_exit_chime":{"type":"string"},"far_end_camera_control":{"type":"boolean"},"feedback":{"type":"boolean"},"file_transfer":{"type":"boolean"},"full_transcript":{"type":"boolean"},"group_hd":{"type":"boolean"},"webinar_group_hd":{"type":"boolean"},"language_interpretation":{"type":"boolean"},"sign_language_interpretation":{"type":"boolean"},"manual_captions":{"type":"boolean"},"meeting_reactions":{"type":"boolean"},"webinar_reactions":{"type":"boolean"},"meeting_survey":{"type":"boolean"},"non_verbal_feedback":{"type":"boolean"},"original_audio":{"type":"boolean"},"polling":{"type":"boolean"},"post_meeting_feedback":{"type":"boolean"},"private_chat":{"type":"boolean"},"remote_control":{"type":"boolean"},"remote_support":{"type":"boolean"},"request_permission_to_unmute_participants":{"type":"boolean"},"save_caption":{"type":"boolean"},"save_captions":{"type":"boolean"},"screen_sharing":{"type":"boolean"},"sending_default_email_invites":{"type":"boolean"},"show_a_join_from_your_browser_link":{"type":"boolean"},"show_browser_join_link":{"type":"boolean"},"show_meeting_control_toolbar":{"type":"boolean"},"slide_control":{"type":"boolean"},"stereo_audio":{"type":"boolean"},"use_html_format_email":{"type":"boolean"},"virtual_background":{"type":"boolean"},"waiting_room":{"type":"boolean"},"webinar_chat":{"type":"boolean"},"webinar_live_streaming":{"type":"boolean"},"webinar_polling":{"type":"boolean"},"webinar_question_answer":{"type":"boolean"},"webinar_survey":{"type":"boolean"},"whiteboard":{"type":"boolean"}},"required":["attendee_on_hold"],"additionalProperties":{}},"other_options":{"type":"object","properties":{"blur_snapshot":{"type":"boolean"}},"additionalProperties":{}},"recording":{"type":"object","properties":{"account_user_access_recording":{"type":"boolean"},"auto_delete_cmr":{"type":"boolean"},"auto_recording":{"type":"boolean"},"cloud_recording":{"type":"boolean"},"cloud_recording_download":{"type":"boolean"},"host_delete_cloud_recording":{"type":"boolean"},"ip_address_access_control":{"type":"object","properties":{"enable":{"type":"boolean"},"ip_addresses_or_ranges":{"type":"string"}},"additionalProperties":{}},"local_recording":{"type":"boolean"},"prevent_host_access_recording":{"type":"boolean"},"recording_authentication":{"type":"boolean"},"archive":{"type":"boolean"}},"additionalProperties":{}},"schedule_meeting":{"type":"object","properties":{"audio_type":{"type":"boolean"},"embed_password_in_join_link":{"type":"boolean"},"force_pmi_jbh_password":{"type":"boolean"},"host_video":{"type":"boolean"},"join_before_host":{"type":"boolean"},"meeting_authentication":{"type":"boolean"},"mute_upon_entry":{"type":"boolean"},"participant_video":{"type":"boolean"},"pstn_password_protected":{"type":"boolean"},"require_password_for_instant_meetings":{"type":"boolean"},"require_password_for_pmi_meetings":{"type":"boolean"},"require_password_for_scheduling_new_meetings":{"type":"boolean"},"upcoming_meeting_reminder":{"type":"boolean"},"continuous_meeting_chat":{"type":"boolean"}},"additionalProperties":{}},"telephony":{"type":"object","properties":{"telephony_regions":{"type":"boolean"},"third_party_audio":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}},{"type":"object","properties":{"meeting_security":{"type":"object","properties":{"approved_or_denied_countries_or_regions":{"type":"boolean"},"auto_security":{"type":"boolean"},"block_user_domain":{"type":"boolean"},"embed_password_in_join_link":{"type":"boolean"},"encryption_type":{"anyOf":[{"type":"string","enum":["enhanced_encryption","e2ee"]},{"type":"string"}]},"end_to_end_encrypted_meetings":{"type":"boolean"},"meeting_password":{"type":"boolean"},"only_authenticated_can_join_from_webclient":{"type":"boolean"},"phone_password":{"type":"boolean"},"pmi_password":{"type":"boolean"},"waiting_room":{"type":"boolean"},"webinar_password":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/groups/{groupId}/members":{"get":{"operationId":"zoom-users.list_group_members","description":"List members of a specific group.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"groupId","schema":{"type":"string","description":"Group ID"},"required":true,"description":"Group ID"},{"in":"query","name":"next_page_token","schema":{"description":"Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"Number of records per page. Defaults and maximums vary by endpoint.","type":"number"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"maxItems":2000,"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"first_name":{"type":"string"},"id":{"type":"string"},"last_name":{"type":"string"},"type":{"type":"number"}},"additionalProperties":{}}},"next_page_token":{"type":"string"},"page_count":{"type":"number"},"page_number":{"type":"number"},"page_size":{"type":"number"},"total_records":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/groups/{groupId}/settings":{"get":{"operationId":"zoom-users.get_group_settings","description":"Get settings for a group. Returns meeting, recording, and telephony settings.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"groupId","schema":{"type":"string","description":"Group ID"},"required":true,"description":"Group ID"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"audio_conferencing":{"type":"object","properties":{"toll_free_and_fee_based_toll_call":{"type":"object","properties":{"allow_webinar_attendees_dial":{"type":"boolean"},"enable":{"type":"boolean"},"numbers":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"country_code":{"type":"string"},"country_name":{"type":"string"},"display_number":{"type":"string"},"number":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}},"toll_call":{"type":"object","properties":{"enable":{"type":"boolean"},"numbers":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"country_code":{"type":"string"},"country_name":{"type":"string"},"display_number":{"type":"string"},"number":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}},"call_me_and_invite_by_phone":{"type":"object","properties":{"enable":{"type":"boolean"},"require_press_1_for_call_me":{"anyOf":[{"type":"string","enum":["auto","always","never"]},{"type":"string"}]},"allow_webinar_attendees_call_me":{"type":"boolean"},"call_out_countries":{"type":"object","properties":{"allowed_countries":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}},"selected_countries":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}}},"additionalProperties":{}},"personal_audio_conference":{"type":"boolean"},"participant_phone_masking":{"type":"object","properties":{"enable":{"type":"boolean"},"masking_type":{"anyOf":[{"type":"string","enum":["mask_default","mask_first_5","mask_except_last_4"]},{"type":"string"}]}},"additionalProperties":{}},"global_dial_in_countries":{"type":"object","properties":{"allowed_countries":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}},"selected_countries":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}},"include_toll_free":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}},"email_notification":{"type":"object","properties":{"alternative_host_reminder":{"type":"boolean"},"cancel_meeting_reminder":{"type":"boolean"},"cloud_recording_available_reminder":{"type":"boolean"},"jbh_reminder":{"type":"boolean"},"recording_available_reminder_alternative_hosts":{"type":"boolean"},"recording_available_reminder_schedulers":{"type":"boolean"},"schedule_for_reminder":{"type":"boolean"}},"additionalProperties":{}},"in_meeting":{"type":"object","properties":{"alert_guest_join":{"type":"boolean"},"allow_users_to_delete_messages_in_meeting_chat":{"type":"boolean"},"allow_live_streaming":{"type":"boolean"},"allow_participants_chat_with":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4}]},"allow_show_zoom_windows":{"type":"boolean"},"allow_users_save_chats":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"annotation":{"type":"boolean"},"attendee_on_hold":{"default":false,"type":"boolean"},"auto_answer":{"type":"boolean"},"auto_saving_chat":{"type":"boolean"},"breakout_room":{"type":"boolean"},"breakout_room_schedule":{"type":"boolean"},"chat":{"type":"boolean"},"meeting_question_answer":{"type":"boolean"},"closed_caption":{"type":"boolean"},"closed_captioning":{"type":"object","properties":{"auto_transcribing":{"type":"boolean"},"enable":{"type":"boolean"},"save_caption":{"type":"boolean"},"third_party_captioning_service":{"type":"boolean"},"view_full_transcript":{"type":"boolean"}},"additionalProperties":{}},"co_host":{"type":"boolean"},"custom_data_center_regions":{"type":"boolean"},"custom_live_streaming_service":{"type":"boolean"},"custom_service_instructions":{"type":"string"},"data_center_regions":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"]},{"type":"string"}]}},"disable_screen_sharing_for_host_meetings":{"type":"boolean"},"disable_screen_sharing_for_in_meeting_guests":{"type":"boolean"},"e2e_encryption":{"type":"boolean"},"entry_exit_chime":{"type":"string"},"far_end_camera_control":{"type":"boolean"},"feedback":{"type":"boolean"},"file_transfer":{"type":"boolean"},"group_hd":{"type":"boolean"},"webinar_group_hd":{"type":"boolean"},"join_from_desktop":{"type":"boolean"},"join_from_mobile":{"type":"boolean"},"auto_generated_translation":{"type":"object","properties":{"language_item_pairList":{"type":"object","properties":{"trans_lang_config":{"type":"array","items":{"type":"object","properties":{"speak_language":{"type":"object","properties":{"name":{"anyOf":[{"type":"string","enum":["Chinese (Simplified)","Dutch","English","French","German","Italian","Japanese","Korean","Portuguese","Russian","Spanish","Ukrainian"]},{"type":"string"}]},"code":{"anyOf":[{"type":"string","enum":["zh","nl","en","fr","de","it","ja","ko","pt","ru","es","uk"]},{"type":"string"}]}},"additionalProperties":{}},"translate_to":{"type":"object","properties":{"all":{"type":"boolean"},"language_config":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string","enum":["English"]},{"type":"string"}]},"code":{"anyOf":[{"type":"string","enum":["en"]},{"type":"string"}]}},"additionalProperties":{}}}},"additionalProperties":{}}},"additionalProperties":{}}},"all":{"type":"boolean"}},"additionalProperties":{}},"enable":{"type":"boolean"}},"additionalProperties":{}},"language_interpretation":{"type":"object","properties":{"custom_languages":{"type":"array","items":{"type":"string"}},"enable_language_interpretation_by_default":{"type":"boolean"},"allow_participants_to_speak_in_listening_channel":{"type":"boolean"},"allow_up_to_25_custom_languages_when_scheduling_meetings":{"type":"boolean"},"enable":{"type":"boolean"},"languages":{"anyOf":[{"type":"string","enum":["English","Chinese","Japanese","German","French","Russian","Portuguese","Spanish","Korean"]},{"type":"string"}]}},"additionalProperties":{}},"sign_language_interpretation":{"type":"object","properties":{"enable":{"type":"boolean"},"enable_sign_language_interpretation_by_default":{"type":"boolean"},"languages":{"type":"array","items":{"anyOf":[{"type":"string","enum":["American","Chinese","French","German","Japanese","Russian","Brazilian","Spanish","Mexican","British"]},{"type":"string"}]}},"custom_languages":{"type":"array","items":{"type":"string"}}},"additionalProperties":{}},"live_streaming_facebook":{"type":"boolean"},"live_streaming_youtube":{"type":"boolean"},"manual_captioning":{"type":"object","properties":{"allow_to_type":{"type":"boolean"},"auto_generated_captions":{"type":"boolean"},"full_transcript":{"type":"boolean"},"manual_captions":{"type":"boolean"},"save_captions":{"type":"boolean"},"third_party_captioning_service":{"type":"boolean"}},"additionalProperties":{}},"meeting_reactions":{"type":"boolean"},"meeting_reactions_emojis":{"anyOf":[{"type":"string","enum":["all","selected"]},{"type":"string"}]},"allow_host_panelists_to_use_audible_clap":{"type":"boolean"},"webinar_reactions":{"type":"boolean"},"meeting_survey":{"type":"boolean"},"non_verbal_feedback":{"type":"boolean"},"only_host_view_device_list":{"type":"boolean"},"original_audio":{"type":"boolean"},"polling":{"type":"boolean"},"post_meeting_feedback":{"type":"boolean"},"private_chat":{"type":"boolean"},"record_play_own_voice":{"type":"boolean"},"remote_control":{"type":"boolean"},"remote_support":{"type":"boolean"},"request_permission_to_unmute_participants":{"type":"boolean"},"screen_sharing":{"type":"boolean"},"sending_default_email_invites":{"type":"boolean"},"show_a_join_from_your_browser_link":{"type":"boolean"},"show_browser_join_link":{"type":"boolean"},"show_device_list":{"type":"boolean"},"show_meeting_control_toolbar":{"type":"boolean"},"slide_control":{"type":"boolean"},"stereo_audio":{"type":"boolean"},"unchecked_data_center_regions":{"anyOf":[{"type":"string","enum":["EU","HK","AU","IN","TY","CN","US","CA","DE","NL","LA"]},{"type":"string"}]},"use_html_format_email":{"type":"boolean"},"virtual_background":{"type":"boolean"},"virtual_background_settings":{"type":"object","properties":{"allow_upload_custom":{"type":"boolean"},"allow_videos":{"type":"boolean"},"enable":{"type":"boolean"},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"is_default":{"type":"boolean"},"name":{"type":"string"},"size":{"type":"number"},"type":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}},"waiting_room":{"type":"boolean"},"webinar_chat":{"type":"object","properties":{"allow_attendees_chat_with":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"allow_auto_save_local_chat_file":{"type":"boolean"},"allow_panelists_chat_with":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"allow_panelists_send_direct_message":{"type":"boolean"},"allow_users_save_chats":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1},{"type":"number","const":2}]},"default_attendees_chat_with":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"enable":{"type":"boolean"}},"additionalProperties":{}},"webinar_live_streaming":{"type":"object","properties":{"custom_service_instructions":{"type":"string"},"enable":{"type":"boolean"},"live_streaming_reminder":{"type":"boolean"},"live_streaming_service":{"type":"array","items":{"anyOf":[{"type":"string","enum":["facebook","workplace_by_facebook","youtube","custom_live_streaming_service"]},{"type":"string"}]}}},"additionalProperties":{}},"meeting_polling":{"type":"object","properties":{"enable":{"type":"boolean"},"advanced_polls":{"type":"boolean"},"manage_saved_polls_and_quizzes":{"type":"boolean"},"require_answers_to_be_anonymous":{"type":"boolean"},"allow_alternative_host_to_add_edit":{"type":"boolean"},"allow_host_to_upload_image":{"type":"boolean"}},"additionalProperties":{}},"webinar_polling":{"type":"object","properties":{"enable":{"type":"boolean"},"advanced_polls":{"type":"boolean"},"manage_saved_polls_and_quizzes":{"type":"boolean"},"require_answers_to_be_anonymous":{"type":"boolean"},"allow_host_to_upload_image":{"type":"boolean"},"allow_alternative_host_to_add_edit":{"type":"boolean"}},"additionalProperties":{}},"webinar_question_answer":{"type":"boolean"},"webinar_survey":{"type":"boolean"},"whiteboard":{"type":"boolean"},"who_can_share_screen":{"anyOf":[{"type":"string","enum":["host","all"]},{"type":"string"}]},"who_can_share_screen_when_someone_is_sharing":{"anyOf":[{"type":"string","enum":["host","all"]},{"type":"string"}]},"participants_share_simultaneously":{"anyOf":[{"type":"string","enum":["multiple","one"]},{"type":"string"}]},"workplace_by_facebook":{"type":"boolean"}},"required":["attendee_on_hold"],"additionalProperties":{}},"other_options":{"type":"object","properties":{"allow_users_contact_support_via_chat":{"type":"boolean"},"blur_snapshot":{"type":"boolean"},"webinar_registration_options":{"type":"object","properties":{"allow_host_to_enable_join_info":{"type":"boolean"},"allow_host_to_enable_social_share_buttons":{"type":"boolean"},"enable_custom_questions":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}},"profile":{"type":"object","properties":{"recording_storage_location":{"type":"object","properties":{"allowed_values":{"type":"array","items":{"type":"string"}},"value":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}},"recording":{"type":"object","properties":{"account_user_access_recording":{"type":"boolean"},"archive":{"type":"object","properties":{"enable":{"type":"boolean"},"settings":{"type":"object","properties":{"audio_file":{"type":"boolean"},"cc_transcript_file":{"type":"boolean"},"chat_file":{"type":"boolean"},"chat_with_sender_email":{"type":"boolean"},"video_file":{"type":"boolean"},"chat_with_direct_message":{"type":"boolean"},"archive_retention":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"number","const":7},{"type":"number","const":8},{"type":"number","const":9},{"type":"number","const":10},{"type":"number","const":11},{"type":"number","const":12},{"type":"number","const":13},{"type":"number","const":14},{"type":"number","const":15},{"type":"number","const":16},{"type":"number","const":17},{"type":"number","const":18},{"type":"number","const":19},{"type":"number","const":20},{"type":"number","const":21},{"type":"number","const":22},{"type":"number","const":23},{"type":"number","const":24},{"type":"number","const":25},{"type":"number","const":26},{"type":"number","const":27},{"type":"number","const":28},{"type":"number","const":29},{"type":"number","const":30}]},"action_when_archive_failed":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"notification_when_archiving_starts":{"anyOf":[{"type":"string","enum":["participants","guest"]},{"type":"string"}]},"play_voice_prompt_when_archiving_starts":{"anyOf":[{"type":"string","enum":["participants","guest","none"]},{"type":"string"}]}},"additionalProperties":{}},"type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]}},"additionalProperties":{}},"auto_recording":{"type":"string"},"cloud_recording":{"type":"boolean"},"cloud_recording_download":{"type":"boolean"},"cloud_recording_download_host":{"type":"boolean"},"host_delete_cloud_recording":{"type":"boolean"},"record_files_separately":{"type":"object","properties":{"active_speaker":{"type":"boolean"},"gallery_view":{"type":"boolean"},"shared_screen":{"type":"boolean"}},"additionalProperties":{}},"display_participant_name":{"type":"boolean"},"recording_thumbnails":{"type":"boolean"},"optimize_recording_for_3rd_party_video_editor":{"type":"boolean"},"recording_highlight":{"type":"boolean"},"save_panelist_chat":{"type":"boolean"},"save_poll_results":{"type":"boolean"},"save_close_caption":{"type":"boolean"},"ip_address_access_control":{"type":"object","properties":{"enable":{"type":"boolean"},"ip_addresses_or_ranges":{"type":"string"}},"additionalProperties":{}},"local_recording":{"type":"boolean"},"prevent_host_access_recording":{"type":"boolean"},"record_audio_file":{"type":"boolean"},"record_gallery_view":{"type":"boolean"},"record_speaker_view":{"type":"boolean"},"recording_audio_transcript":{"type":"boolean"},"smart_recording":{"type":"object","properties":{"create_recording_highlights":{"type":"boolean"},"create_smart_chapters":{"type":"boolean"},"create_next_steps":{"type":"boolean"}},"additionalProperties":{}},"save_chat_text":{"type":"boolean"},"show_timestamp":{"type":"boolean"},"recording_notification_for_zoom_client":{"type":"object","properties":{"disclaimer_to_participants":{"type":"string"},"play_voice_prompt":{"type":"string"},"ask_host_to_confirm":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}},"schedule_meeting":{"type":"object","properties":{"audio_type":{"type":"string"},"embed_password_in_join_link":{"type":"boolean"},"force_pmi_jbh_password":{"type":"boolean"},"host_video":{"type":"boolean"},"join_before_host":{"type":"boolean"},"mute_upon_entry":{"type":"boolean"},"participant_video":{"type":"boolean"},"personal_meeting":{"type":"boolean"},"pstn_password_protected":{"type":"boolean"},"require_password_for_instant_meetings":{"type":"boolean"},"require_password_for_pmi_meetings":{"anyOf":[{"type":"string","enum":["all","jbh_only","none"]},{"type":"string"}]},"require_password_for_scheduled_meetings":{"type":"boolean"},"require_password_for_scheduling_new_meetings":{"type":"boolean"},"upcoming_meeting_reminder":{"type":"boolean"},"use_pmi_for_instant_meetings":{"type":"boolean"},"use_pmi_for_schedule_meetings":{"type":"boolean"},"always_display_zoom_meeting_as_topic":{"type":"object","properties":{"enable":{"type":"boolean"},"display_topic_for_scheduled_meetings":{"type":"boolean"}},"additionalProperties":{}},"always_display_zoom_webinar_as_topic":{"type":"object","properties":{"enable":{"type":"boolean"},"display_topic_for_scheduled_webinars":{"type":"boolean"}},"additionalProperties":{}},"continuous_meeting_chat":{"type":"object","properties":{"enable":{"type":"boolean"},"can_add_external_users":{"type":"boolean"},"auto_add_invited_external_users":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}},"telephony":{"type":"object","properties":{"audio_conference_info":{"type":"string"},"telephony_regions":{"type":"object","properties":{"selection_values":{"type":"string"}},"additionalProperties":{}},"third_party_audio":{"type":"boolean"}},"additionalProperties":{}},"chat":{"type":"object","properties":{"share_files":{"type":"object","properties":{"enable":{"type":"boolean"},"share_option":{"anyOf":[{"type":"string","enum":["anyone","account","organization"]},{"type":"string"}]}},"additionalProperties":{}},"chat_emojis":{"type":"object","properties":{"enable":{"type":"boolean"},"emojis_option":{"anyOf":[{"type":"string","enum":["all","selected"]},{"type":"string"}]}},"additionalProperties":{}},"record_voice_messages":{"type":"boolean"},"record_video_messages":{"type":"boolean"},"screen_capture":{"type":"boolean"},"create_public_channels":{"type":"boolean"},"create_private_channels":{"type":"boolean"},"share_links_in_chat":{"type":"boolean"},"schedule_meetings_in_chat":{"type":"boolean"},"set_retention_period_in_cloud":{"type":"object","properties":{"enable":{"type":"boolean"},"retention_period_of_direct_messages_and_group_conversation":{"type":"string"},"retention_period_of_channels":{"type":"string"}},"additionalProperties":{}},"set_retention_period_in_local":{"type":"object","properties":{"enable":{"type":"boolean"},"retention_period_of_direct_messages_and_group_conversation":{"type":"string"},"retention_period_of_channels":{"type":"string"}},"additionalProperties":{}},"allow_users_to_search_others_options":{"type":"string"},"allow_users_to_add_contacts":{"type":"object","properties":{"enable":{"type":"boolean"},"selected_option":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4}]},"user_email_addresses":{"type":"string"}},"additionalProperties":{}},"allow_users_to_chat_with_others":{"type":"object","properties":{"enable":{"type":"boolean"},"selected_option":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4}]},"user_email_addresses":{"type":"string"}},"additionalProperties":{}},"chat_etiquette_tool":{"type":"object","properties":{"enable":{"type":"boolean"},"policies":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"is_locked":{"type":"boolean"},"keywords":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"regular_expression":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["activated","deactivated"]},{"type":"string"}]},"trigger_action":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]}},"additionalProperties":{}}}},"additionalProperties":{}},"send_data_to_third_party_archiving_service":{"type":"object","properties":{"enable":{"type":"boolean"}},"additionalProperties":{}},"translate_messages":{"type":"boolean"},"search_and_send_animated_gif_images":{"type":"object","properties":{"enable":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}}},"additionalProperties":{}},{"type":"object","properties":{"allow_authentication_exception":{"type":"boolean"},"authentication_options":{"type":"array","items":{"type":"object","properties":{"default_option":{"type":"boolean"},"domains":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["enforce_login","enforce_login_with_same_account","enforce_login_with_domains"]},{"type":"string"}]},"visible":{"type":"boolean"}},"additionalProperties":{}}},"meeting_authentication":{"type":"boolean"}},"additionalProperties":{}},{"type":"object","properties":{"authentication_options":{"type":"array","items":{"type":"object","properties":{"default_option":{"type":"boolean"},"domains":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["internally","enforce_login","enforce_login_with_domains"]},{"type":"string"}]},"visible":{"type":"boolean"}},"additionalProperties":{}}},"recording_authentication":{"type":"boolean"}},"additionalProperties":{}},{"type":"object","properties":{"meeting_security":{"type":"object","properties":{"auto_security":{"type":"boolean"},"block_user_domain":{"type":"boolean"},"block_user_domain_list":{"maxItems":20,"type":"array","items":{"type":"string"}},"chat_etiquette_tool":{"type":"object","properties":{"enable":{"type":"boolean"},"policies":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"is_locked":{"type":"boolean"},"keywords":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"regular_expression":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["activated","deactivated"]},{"type":"string"}]},"trigger_action":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]}},"additionalProperties":{}}}},"additionalProperties":{}},"embed_password_in_join_link":{"type":"boolean"},"encryption_type":{"anyOf":[{"type":"string","enum":["enhanced_encryption","e2ee"]},{"type":"string"}]},"end_to_end_encrypted_meetings":{"type":"boolean"},"meeting_password":{"type":"boolean"},"meeting_password_requirement":{"type":"object","properties":{"consecutive_characters_length":{"anyOf":[{"type":"number","const":0},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"number","const":7},{"type":"number","const":8}]},"have_letter":{"type":"boolean"},"have_number":{"type":"boolean"},"have_special_character":{"type":"boolean"},"have_upper_and_lower_characters":{"type":"boolean"},"length":{"type":"number"},"only_allow_numeric":{"type":"boolean"},"weak_enhance_detection":{"type":"boolean"}},"additionalProperties":{}},"only_authenticated_can_join_from_webclient":{"type":"boolean"},"phone_password":{"type":"boolean"},"pmi_password":{"type":"boolean"},"require_password_for_scheduled_meeting":{"type":"boolean"},"require_password_for_scheduled_webinar":{"type":"boolean"},"waiting_room":{"type":"boolean"},"waiting_room_settings":{"type":"object","properties":{"participants_to_place_in_waiting_room":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1},{"type":"number","const":2}]},"users_who_can_admit_participants_from_waiting_room":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1}]},"whitelisted_domains_for_waiting_room":{"type":"string"}},"additionalProperties":{}},"webinar_password":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/groups/{groupId}/settings/registration":{"get":{"operationId":"zoom-users.get_group_webinar_registration_settings","description":"Get webinar registration settings for a group.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"groupId","schema":{"type":"string","description":"Group ID"},"required":true,"description":"Group ID"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"options":{"type":"object","properties":{"host_email_notification":{"type":"boolean"},"close_registration":{"type":"boolean"},"allow_participants_to_join_from_multiple_devices":{"type":"boolean"},"show_social_share_buttons":{"type":"boolean"}},"additionalProperties":{}},"questions":{"type":"array","items":{"type":"object","properties":{"field_name":{"anyOf":[{"type":"string","enum":["last_name","address","city","country","zip","state","phone","industry","org","job_title","purchasing_time_frame","role_in_purchase_process","no_of_employees","comments"]},{"type":"string"}]},"required":{"type":"boolean"},"selected":{"type":"boolean"}},"additionalProperties":{}}},"approve_type":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1}]},"custom_questions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["short","single_dropdown","single_radio","multiple"]},{"type":"string"}]},"required":{"type":"boolean"},"selected":{"type":"boolean"},"answers":{"type":"array","items":{"type":"string"}}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/users":{"get":{"operationId":"zoom-users.list_users","description":"List users in the account with optional filters by status, page size, or role.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"next_page_token","schema":{"description":"Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"Number of records per page. Defaults and maximums vary by endpoint.","type":"number"}},{"in":"query","name":"status","schema":{"description":"Filter by user status","type":"string","enum":["active","inactive","pending"]}},{"in":"query","name":"role_id","schema":{"description":"Filter by role ID","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"page_count":{"type":"number"},"page_number":{"default":1,"type":"number"},"page_size":{"default":30,"type":"number"},"total_records":{"type":"number"},"users":{"maxItems":2000,"type":"array","items":{"type":"object","properties":{"user_created_at":{"type":"string"},"created_at":{"type":"string"},"custom_attributes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":{}}},"dept":{"type":"string"},"email":{"type":"string"},"employee_unique_id":{"type":"string"},"first_name":{"type":"string"},"group_ids":{"type":"array","items":{"type":"string"}},"division_ids":{"type":"array","items":{"type":"string"}},"host_key":{"type":"string"},"id":{"type":"string"},"im_group_ids":{"type":"array","items":{"type":"string"}},"last_client_version":{"type":"string"},"last_login_time":{"type":"string"},"last_name":{"type":"string"},"plan_united_type":{"anyOf":[{"type":"string","enum":["1","2","4","8","16","32","64","128","256","512","1024","2048","4096","8192","16384","32768","65536","131072"]},{"type":"string"}]},"pmi":{"type":"number"},"role_id":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["active","inactive","pending"]},{"type":"string"}]},"timezone":{"type":"string"},"type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":4},{"type":"number","const":99}]},"verified":{"anyOf":[{"type":"number","const":1},{"type":"number","const":0}]},"display_name":{"type":"string"},"license_info_list":{"type":"array","items":{"type":"object","properties":{"license_type":{"anyOf":[{"type":"string","enum":["MEETING","ZOOM_WORKPLACE_BUNDLE"]},{"type":"string"}]},"license_option":{"anyOf":[{"type":"number","const":2},{"type":"number","const":4},{"type":"number","const":8},{"type":"number","const":16},{"type":"number","const":32},{"type":"number","const":64},{"type":"number","const":128},{"type":"number","const":33554432},{"type":"number","const":134217728},{"type":"number","const":1073741824},{"type":"number","const":536870912},{"type":"number","const":268435456},{"type":"number","const":4398046511104},{"type":"number","const":18014398509481984},{"type":"number","const":72057594037927940},{"type":"number","const":576460752303423500},{"type":"number","const":144115188075855870},{"type":"number","const":137438953472},{"type":"number","const":1099511627776},{"type":"number","const":549755813888},{"type":"number","const":274877906944},{"type":"number","const":2199023255552},{"type":"number","const":4294967296},{"type":"number","const":34359738368},{"type":"number","const":17179869184},{"type":"number","const":8589934592},{"type":"number","const":68719476736}]},"subscription_id":{"type":"string"}},"additionalProperties":{}}}},"required":["email","type"],"additionalProperties":{}}}},"required":["page_number","page_size"],"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/users/email":{"get":{"operationId":"zoom-users.check_user_email","description":"Check if an email address is registered with Zoom. Returns whether the email exists.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"email","schema":{"type":"string","description":"Email address to check"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"existed_email":{"type":"boolean"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/users/me/zak":{"get":{"operationId":"zoom-users.get_user_zak","description":"Get the authenticated user's Zoom Access Key (ZAK) token for starting meetings.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/users/summary":{"get":{"operationId":"zoom-users.get_user_summary","description":"Get a summary of user counts by status (active, inactive, pending) for the account.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"licensed_users_count":{"type":"number"},"basic_users_count":{"type":"number"},"on_prem_users_count":{"type":"number"},"room_users_count":{"type":"number"},"pending_users_count":{"type":"number"},"join_only_users_count":{"type":"number"},"total_users_count":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/users/vanity-name":{"get":{"operationId":"zoom-users.check_user_pm_room","description":"Check if a personal meeting room name (vanity URL) is available.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"vanity_name","schema":{"type":"string","description":"Personal meeting room name to check"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"existed":{"type":"boolean"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/users/{userId}":{"get":{"operationId":"zoom-users.get_user","description":"Get a single user by ID or email. Returns profile, plan, and feature details. Use 'me' for authenticated user.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"User ID or email. Use 'me' for authenticated user."},"required":true,"description":"User ID or email. Use 'me' for authenticated user."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string"}},"additionalProperties":{}},{"type":"object","properties":{"created_at":{"type":"string"},"dept":{"type":"string"},"email":{"type":"string"},"first_name":{"type":"string"},"last_client_version":{"type":"string"},"last_login_time":{"type":"string"},"last_name":{"type":"string"},"pmi":{"type":"number"},"role_name":{"type":"string"},"timezone":{"type":"string"},"type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":4},{"type":"number","const":99}]},"use_pmi":{"default":false,"type":"boolean"},"display_name":{"type":"string"}},"required":["type","use_pmi"],"additionalProperties":{}},{"type":"object","properties":{"account_id":{"type":"string"},"account_number":{"type":"number"},"cms_user_id":{"type":"string"},"company":{"type":"string"},"created_at":{"type":"string"},"user_created_at":{"type":"string"},"custom_attributes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":{}}},"employee_unique_id":{"type":"string"},"group_ids":{"type":"array","items":{"type":"string"}},"division_ids":{"type":"array","items":{"type":"string"}},"im_group_ids":{"type":"array","items":{"type":"string"}},"jid":{"type":"string"},"job_title":{"type":"string"},"cost_center":{"type":"string"},"language":{"type":"string"},"location":{"type":"string"},"login_types":{"type":"array","items":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1},{"type":"number","const":11},{"type":"number","const":21},{"type":"number","const":23},{"type":"number","const":24},{"type":"number","const":27},{"type":"number","const":97},{"type":"number","const":98},{"type":"number","const":99},{"type":"number","const":100},{"type":"number","const":101}]}},"manager":{"type":"string"},"personal_meeting_url":{"type":"string"},"phone_country":{"type":"string"},"phone_number":{"type":"string"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"country":{"type":"string"},"label":{"anyOf":[{"type":"string","enum":["Mobile","Office","Home","Fax"]},{"type":"string"}]},"number":{"type":"string"},"verified":{"type":"boolean"}},"additionalProperties":{}}},"pic_url":{"type":"string"},"plan_united_type":{"anyOf":[{"type":"string","enum":["1","2","4","8","16","32","64","128","256","512","1024","2048","4096","8192","16384","32768","65536","131072"]},{"type":"string"}]},"pronouns":{"type":"string"},"pronouns_option":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"role_id":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["pending","active","inactive"]},{"type":"string"}]},"use_pmi":{"default":false,"type":"boolean"},"vanity_url":{"type":"string"},"verified":{"type":"number"},"cluster":{"type":"string"},"zoom_one_type":{"type":"number"},"license_info_list":{"type":"array","items":{"type":"object","properties":{"license_type":{"anyOf":[{"type":"string","enum":["MEETING","ZOOM_WORKPLACE_BUNDLE"]},{"type":"string"}]},"license_option":{"anyOf":[{"type":"number","const":2},{"type":"number","const":4},{"type":"number","const":8},{"type":"number","const":16},{"type":"number","const":32},{"type":"number","const":64},{"type":"number","const":128},{"type":"number","const":33554432},{"type":"number","const":134217728},{"type":"number","const":1073741824},{"type":"number","const":536870912},{"type":"number","const":268435456},{"type":"number","const":4398046511104},{"type":"number","const":18014398509481984},{"type":"number","const":72057594037927940},{"type":"number","const":576460752303423500},{"type":"number","const":144115188075855870},{"type":"number","const":137438953472},{"type":"number","const":1099511627776},{"type":"number","const":549755813888},{"type":"number","const":274877906944},{"type":"number","const":2199023255552},{"type":"number","const":4294967296},{"type":"number","const":34359738368},{"type":"number","const":17179869184},{"type":"number","const":8589934592},{"type":"number","const":68719476736}]},"subscription_id":{"type":"string"}},"additionalProperties":{}}}},"required":["use_pmi"],"additionalProperties":{}}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/users/{userId}/assistants":{"get":{"operationId":"zoom-users.list_user_assistants","description":"List assistants assigned to a user.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"User ID or email"},"required":true,"description":"User ID or email"},{"in":"query","name":"next_page_token","schema":{"description":"Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"Number of records per page. Defaults and maximums vary by endpoint.","type":"number"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"assistants":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"id":{"type":"string"},"can_manage_host_private_event":{"type":"boolean"}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/users/{userId}/collaboration-devices":{"get":{"operationId":"zoom-users.list_user_collaboration_devices","description":"List collaboration devices assigned to a user.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"User ID or email"},"required":true,"description":"User ID or email"},{"in":"query","name":"next_page_token","schema":{"description":"Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"Number of records per page. Defaults and maximums vary by endpoint.","type":"number"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"total_records":{"type":"number"},"collaboration_devices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"device_name":{"type":"string"},"room_name":{"type":"string"},"room_user_id":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["Online","Offline"]},{"type":"string"}]}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/users/{userId}/collaboration-devices/{collaborationDeviceId}":{"get":{"operationId":"zoom-users.get_user_collaboration_device","description":"Get a specific collaboration device for a user.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"User ID or email"},"required":true,"description":"User ID or email"},{"in":"path","name":"collaborationDeviceId","schema":{"type":"string","description":"Collaboration device ID"},"required":true,"description":"Collaboration device ID"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"device_name":{"type":"string"},"room_name":{"type":"string"},"room_user_id":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["Online","Offline"]},{"type":"string"}]}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/users/{userId}/meeting-summary-templates":{"get":{"operationId":"zoom-users.get_user_meeting_summary_templates","description":"Get meeting summary templates for a user.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"User ID or email"},"required":true,"description":"User ID or email"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"meeting_summary_template_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}},"required":["meeting_summary_template_id","name","description"],"additionalProperties":{}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/users/{userId}/meeting-templates/{meetingTemplateId}":{"get":{"operationId":"zoom-users.get_user_meeting_template","description":"Get a specific meeting template for a user.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"User ID or email"},"required":true,"description":"User ID or email"},{"in":"path","name":"meetingTemplateId","schema":{"type":"string","description":"Meeting template ID"},"required":true,"description":"Meeting template ID"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"settings":{"type":"object","properties":{"in_meeting":{"type":"object","properties":{"entry_exit_chime":{"anyOf":[{"type":"string","enum":["host","all","none"]},{"type":"string"}]},"feedback":{"type":"boolean"},"polling":{"type":"boolean"},"post_meeting_feedback":{"type":"boolean"},"screen_sharing":{"type":"boolean"},"who_can_share_screen":{"anyOf":[{"type":"string","enum":["host","all"]},{"type":"string"}]},"who_can_share_screen_when_someone_is_sharing":{"anyOf":[{"type":"string","enum":["host","all"]},{"type":"string"}]},"disable_screen_sharing_for_host_meetings":{"type":"boolean"},"annotation":{"type":"boolean"},"whiteboard":{"type":"boolean"},"remote_control":{"type":"boolean"},"non_verbal_feedback":{"type":"boolean"},"allow_participants_to_rename":{"type":"boolean"},"breakout_room":{"type":"boolean"},"remote_support":{"type":"boolean"},"manual_captioning":{"type":"object","properties":{"auto_generated_captions":{"type":"boolean"},"allow_to_type":{"type":"boolean"},"manual_captions":{"type":"boolean"},"save_captions":{"type":"boolean"}},"additionalProperties":{}},"closed_captioning":{"type":"object","properties":{"auto_transcribing":{"type":"boolean"},"enable":{"type":"boolean"},"save_caption":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}},"recording":{"type":"object","properties":{"auto_recording":{"anyOf":[{"type":"string","enum":["local","cloud","none"]},{"type":"string"}]}},"additionalProperties":{}},"schedule_meeting":{"type":"object","properties":{"host_video":{"type":"boolean"},"participant_video":{"type":"boolean"},"mute_upon_entry":{"default":false,"type":"boolean"}},"required":["mute_upon_entry"],"additionalProperties":{}},"meeting_security":{"type":"object","properties":{"waiting_room":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/users/{userId}/permissions":{"get":{"operationId":"zoom-users.get_user_permissions","description":"Get permissions assigned to a user. Returns list of permission strings.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"User ID or email"},"required":true,"description":"User ID or email"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"permissions":{"type":"array","items":{"type":"string"}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/users/{userId}/presence-status":{"get":{"operationId":"zoom-users.get_user_presence_status","description":"Get a user's presence status (available, away, do not disturb, etc.).","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"User ID or email"},"required":true,"description":"User ID or email"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"status":{"anyOf":[{"type":"string","enum":["Do_No_Disturb"]},{"type":"string"}]},"end_time":{"type":"string"},"remaining_time":{"type":"number"}},"required":["status","end_time","remaining_time"],"additionalProperties":{}},{"type":"object","properties":{"status":{"anyOf":[{"type":"string","enum":["Away","Do_Not_Disturb","Available","In_Calendar_Event","Presenting","In_A_Zoom_Meeting","On_A_Call","Out_of_Office","Busy"]},{"type":"string"}]}},"required":["status"],"additionalProperties":{}}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/users/{userId}/schedulers":{"get":{"operationId":"zoom-users.list_user_schedulers","description":"List schedulers assigned to a user. Schedulers can schedule meetings on behalf of the user.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"User ID or email"},"required":true,"description":"User ID or email"},{"in":"query","name":"next_page_token","schema":{"description":"Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"Number of records per page. Defaults and maximums vary by endpoint.","type":"number"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"schedulers":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"id":{"type":"string"},"pmi":{"type":"number"}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/users/{userId}/settings":{"get":{"operationId":"zoom-users.get_user_settings","description":"Get settings for a user. Returns meeting, recording, telephony, and feature settings.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"User ID or email"},"required":true,"description":"User ID or email"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"audio_conferencing":{"type":"object","properties":{"toll_free_and_fee_based_toll_call":{"type":"object","properties":{"allow_webinar_attendees_dial":{"type":"boolean"},"enable":{"type":"boolean"},"numbers":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"country_code":{"type":"string"},"country_name":{"type":"string"},"display_number":{"type":"string"},"number":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}},"toll_call":{"type":"object","properties":{"enable":{"type":"boolean"},"numbers":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"country_code":{"type":"string"},"country_name":{"type":"string"},"display_number":{"type":"string"},"number":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}},"call_me_and_invite_by_phone":{"type":"object","properties":{"enable":{"type":"boolean"},"require_press_1_for_call_me":{"anyOf":[{"type":"string","enum":["auto","always","never"]},{"type":"string"}]},"allow_webinar_attendees_call_me":{"type":"boolean"},"call_out_countries":{"type":"object","properties":{"allowed_countries":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}},"selected_countries":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}}},"additionalProperties":{}},"personal_audio_conference":{"type":"boolean"},"participant_phone_masking":{"type":"object","properties":{"enable":{"type":"boolean"},"masking_type":{"anyOf":[{"type":"string","enum":["mask_default","mask_first_5","mask_except_last_4"]},{"type":"string"}]}},"additionalProperties":{}},"global_dial_in_countries":{"type":"object","properties":{"allowed_countries":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}},"selected_countries":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}},"include_toll_free":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}},"email_notification":{"type":"object","properties":{"alternative_host_reminder":{"default":false,"type":"boolean"},"cancel_meeting_reminder":{"default":false,"type":"boolean"},"cloud_recording_available_reminder":{"type":"boolean"},"jbh_reminder":{"default":false,"type":"boolean"},"recording_available_reminder_alternative_hosts":{"type":"boolean"},"recording_available_reminder_schedulers":{"type":"boolean"},"schedule_for_reminder":{"default":false,"type":"boolean"}},"required":["alternative_host_reminder","cancel_meeting_reminder","jbh_reminder","schedule_for_reminder"],"additionalProperties":{}},"feature":{"type":"object","properties":{"cn_meeting":{"type":"boolean"},"concurrent_meeting":{"anyOf":[{"type":"string","enum":["Basic","Plus","None"]},{"type":"string"}]},"in_meeting":{"type":"boolean"},"large_meeting":{"type":"boolean"},"large_meeting_capacity":{"type":"number"},"meeting_capacity":{"type":"number"},"webinar":{"type":"boolean"},"webinar_capacity":{"type":"number"},"zoom_events":{"type":"boolean"},"zoom_events_capacity":{"anyOf":[{"type":"number","const":500},{"type":"number","const":1000},{"type":"number","const":3000},{"type":"number","const":5000},{"type":"number","const":10000},{"type":"number","const":20000},{"type":"number","const":30000},{"type":"number","const":50000}]},"zoom_events_unlimited":{"type":"boolean"},"zoom_events_unlimited_capacities":{"maxItems":9,"type":"array","items":{"anyOf":[{"type":"number","const":100},{"type":"number","const":500},{"type":"number","const":1000},{"type":"number","const":3000},{"type":"number","const":5000},{"type":"number","const":10000},{"type":"number","const":20000},{"type":"number","const":30000},{"type":"number","const":50000}]}},"zoom_sessions_unlimited":{"type":"boolean"},"zoom_sessions_unlimited_capacities":{"maxItems":9,"type":"array","items":{"anyOf":[{"type":"number","const":100},{"type":"number","const":500},{"type":"number","const":1000},{"type":"number","const":3000},{"type":"number","const":5000},{"type":"number","const":10000},{"type":"number","const":20000},{"type":"number","const":30000},{"type":"number","const":50000}]}},"zoom_events_pay_per_attendee":{"type":"boolean"},"zoom_sessions_pay_per_attendee":{"type":"boolean"},"zoom_phone":{"type":"boolean"},"zoom_iq_for_sales":{"type":"boolean"},"zoom_revenue_accelerator":{"type":"boolean"},"zoom_whiteboard":{"type":"boolean"},"zoom_whiteboard_plus":{"type":"boolean"},"zoom_translated_captions":{"type":"boolean"},"zoom_customer_managed_key":{"type":"boolean"},"zoom_huddles":{"type":"boolean"},"zoom_quality_management":{"type":"boolean"},"zoom_workforce_management":{"type":"boolean"},"zoom_scheduler":{"type":"boolean"},"zoom_clips_plus":{"type":"boolean"},"zoom_mail_calendar":{"type":"boolean"},"zoom_compliance_management":{"type":"boolean"},"zoom_docs":{"type":"boolean"},"license_info_list":{"type":"array","items":{"type":"object","properties":{"license_type":{"anyOf":[{"type":"string","enum":["ZOOM_WHITEBOARD","ZOOM_TRANSLATED_CAPTIONS","ZOOM_SCHEDULER","ZOOM_CLIPS","ZOOM_VISITOR_MANAGEMENT","ZOOM_CMK","ZOOM_DOCS","ZOOM_REVENUE_ACCELERATOR","ZOOM_COMPLIANCE_MANAGEMENT","ZOOM_WORKFORCE_MANAGEMENT","ZOOM_QUALITY_MANAGEMENT","ZOOM_HEALTHCARE_CLINICAL_NOTES","ZOOM_EVENTS_NEW_SAAS","ZOOM_EVENTS_CONSUMPTION","ZOOM_WEBINARS_PLUS","ZOOM_WEBINARS_PLUS_CONSUMPTION"]},{"type":"string"}]},"license_option":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":4},{"type":"number","const":8},{"type":"number","const":16},{"type":"number","const":32},{"type":"number","const":64},{"type":"number","const":128},{"type":"number","const":256},{"type":"number","const":512},{"type":"number","const":1024},{"type":"number","const":2048},{"type":"number","const":4086},{"type":"number","const":8192},{"type":"number","const":16384},{"type":"number","const":32768},{"type":"number","const":65536},{"type":"number","const":131072},{"type":"number","const":262144},{"type":"number","const":524288},{"type":"number","const":2147483648},{"type":"number","const":549755813888},{"type":"number","const":1099511627776},{"type":"number","const":2199023255552},{"type":"number","const":8796093022208},{"type":"number","const":17592186044416},{"type":"number","const":281474976710656},{"type":"number","const":4503599627370496}]},"subscription_id":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}},"in_meeting":{"type":"object","properties":{"allow_host_to_enable_focus_mode":{"type":"boolean"},"allow_users_to_delete_messages_in_meeting_chat":{"type":"boolean"},"allow_live_streaming":{"type":"boolean"},"post_meeting_feedback":{"type":"boolean"},"whiteboard":{"type":"boolean"},"allow_participants_chat_with":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4}]},"allow_users_save_chats":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"annotation":{"default":false,"type":"boolean"},"attendee_on_hold":{"default":false,"type":"boolean"},"attention_mode_focus_mode":{"default":false,"type":"boolean"},"auto_saving_chat":{"default":false,"type":"boolean"},"breakout_room":{"default":false,"type":"boolean"},"breakout_room_schedule":{"type":"boolean"},"chat":{"default":false,"type":"boolean"},"meeting_question_answer":{"type":"boolean"},"closed_caption":{"default":false,"type":"boolean"},"closed_captioning":{"type":"object","properties":{"auto_transcribing":{"type":"boolean"},"enable":{"type":"boolean"},"save_caption":{"type":"boolean"},"third_party_captioning_service":{"type":"boolean"},"view_full_transcript":{"type":"boolean"}},"additionalProperties":{}},"co_host":{"default":false,"type":"boolean"},"custom_data_center_regions":{"type":"boolean"},"custom_live_streaming_service":{"type":"boolean"},"custom_service_instructions":{"type":"string"},"data_center_regions":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"]},{"type":"string"}]}},"disable_screen_sharing_for_host_meetings":{"type":"boolean"},"disable_screen_sharing_for_in_meeting_guests":{"type":"boolean"},"e2e_encryption":{"type":"boolean"},"entry_exit_chime":{"anyOf":[{"type":"string","enum":["host","all","none"]},{"type":"string"}]},"far_end_camera_control":{"default":false,"type":"boolean"},"feedback":{"default":false,"type":"boolean"},"file_transfer":{"type":"boolean"},"group_hd":{"default":false,"type":"boolean"},"webinar_group_hd":{"default":false,"type":"boolean"},"join_from_desktop":{"type":"boolean"},"join_from_mobile":{"type":"boolean"},"language_interpretation":{"type":"object","properties":{"custom_languages":{"type":"array","items":{"type":"string"}},"enable_language_interpretation_by_default":{"type":"boolean"},"allow_participants_to_speak_in_listening_channel":{"type":"boolean"},"allow_up_to_25_custom_languages_when_scheduling_meetings":{"type":"boolean"},"enable":{"type":"boolean"},"languages":{"type":"array","items":{"anyOf":[{"type":"string","enum":["English","Chinese","Japanese","German","French","Russian","Portuguese","Spanish","Korean"]},{"type":"string"}]}}},"additionalProperties":{}},"sign_language_interpretation":{"type":"object","properties":{"enable":{"type":"boolean"},"enable_sign_language_interpretation_by_default":{"type":"boolean"},"languages":{"type":"array","items":{"anyOf":[{"type":"string","enum":["American","Chinese","French","German","Japanese","Russian","Brazilian","Spanish","Mexican","British"]},{"type":"string"}]}},"custom_languages":{"type":"array","items":{"type":"string"}}},"additionalProperties":{}},"live_streaming_facebook":{"type":"boolean"},"live_streaming_youtube":{"type":"boolean"},"manual_captioning":{"type":"object","properties":{"allow_to_type":{"type":"boolean"},"auto_generated_captions":{"type":"boolean"},"full_transcript":{"type":"boolean"},"manual_captions":{"type":"boolean"},"save_captions":{"type":"boolean"},"third_party_captioning_service":{"type":"boolean"}},"additionalProperties":{}},"meeting_reactions":{"type":"boolean"},"meeting_reactions_emojis":{"anyOf":[{"type":"string","enum":["all","selected"]},{"type":"string"}]},"allow_host_panelists_to_use_audible_clap":{"type":"boolean"},"webinar_reactions":{"type":"boolean"},"meeting_survey":{"type":"boolean"},"non_verbal_feedback":{"default":false,"type":"boolean"},"polling":{"default":false,"type":"boolean"},"private_chat":{"default":false,"type":"boolean"},"record_play_voice":{"type":"boolean"},"remote_control":{"default":false,"type":"boolean"},"remote_support":{"default":false,"type":"boolean"},"request_permission_to_unmute_participants":{"type":"boolean"},"screen_sharing":{"type":"boolean"},"share_dual_camera":{"default":false,"type":"boolean"},"show_a_join_from_your_browser_link":{"type":"boolean"},"show_meeting_control_toolbar":{"type":"boolean"},"slide_control":{"type":"boolean"},"unchecked_data_center_regions":{"type":"array","items":{"anyOf":[{"type":"string","enum":["EU","HK","AU","IN","TY","CN","US","CA","DE","NL","LA"]},{"type":"string"}]}},"virtual_background":{"default":false,"type":"boolean"},"virtual_background_settings":{"type":"object","properties":{"allow_upload_custom":{"type":"boolean"},"allow_videos":{"type":"boolean"},"enable":{"type":"boolean"},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"is_default":{"type":"boolean"},"name":{"type":"string"},"size":{"type":"number"},"type":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}},"waiting_room":{"default":false,"type":"boolean"},"webinar_chat":{"type":"object","properties":{"allow_attendees_chat_with":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"allow_auto_save_local_chat_file":{"type":"boolean"},"allow_panelists_chat_with":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"allow_panelists_send_direct_message":{"type":"boolean"},"allow_users_save_chats":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1},{"type":"number","const":2}]},"default_attendees_chat_with":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"enable":{"type":"boolean"}},"additionalProperties":{}},"webinar_live_streaming":{"type":"object","properties":{"custom_service_instructions":{"type":"string"},"enable":{"type":"boolean"},"live_streaming_reminder":{"type":"boolean"},"live_streaming_service":{"type":"array","items":{"anyOf":[{"type":"string","enum":["facebook","workplace_by_facebook","youtube","custom_live_streaming_service"]},{"type":"string"}]}}},"additionalProperties":{}},"meeting_polling":{"type":"object","properties":{"advanced_polls":{"type":"boolean"},"allow_alternative_host_to_add_edit":{"type":"boolean"},"require_answers_to_be_anonymous":{"type":"boolean"},"allow_host_to_upload_image":{"type":"boolean"},"enable":{"type":"boolean"}},"additionalProperties":{}},"webinar_polling":{"type":"object","properties":{"advanced_polls":{"type":"boolean"},"allow_alternative_host_to_add_edit":{"type":"boolean"},"require_answers_to_be_anonymous":{"type":"boolean"},"allow_host_to_upload_image":{"type":"boolean"},"enable":{"type":"boolean"}},"additionalProperties":{}},"webinar_survey":{"type":"boolean"},"who_can_share_screen":{"anyOf":[{"type":"string","enum":["host","all"]},{"type":"string"}]},"who_can_share_screen_when_someone_is_sharing":{"anyOf":[{"type":"string","enum":["host","all"]},{"type":"string"}]},"participants_share_simultaneously":{"anyOf":[{"type":"string","enum":["multiple","one"]},{"type":"string"}]},"workplace_by_facebook":{"type":"boolean"},"transfer_meetings_between_devices":{"type":"boolean"},"allow_show_zoom_windows":{"type":"boolean"},"meeting_summary_with_ai_companion":{"type":"object","properties":{"enable":{"type":"boolean"},"auto_enable":{"type":"boolean"},"who_will_receive_summary":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4}]}},"additionalProperties":{}},"ai_companion_questions":{"type":"object","properties":{"enable":{"type":"boolean"},"auto_enable":{"type":"boolean"},"who_can_ask_questions":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5}]}},"additionalProperties":{}}},"required":["annotation","attendee_on_hold","attention_mode_focus_mode","auto_saving_chat","breakout_room","chat","closed_caption","co_host","far_end_camera_control","feedback","group_hd","webinar_group_hd","non_verbal_feedback","polling","private_chat","remote_control","remote_support","share_dual_camera","virtual_background","waiting_room"],"additionalProperties":{}},"profile":{"type":"object","properties":{"recording_storage_location":{"type":"object","properties":{"allowed_values":{"type":"array","items":{"type":"string"}},"value":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}},"recording":{"type":"object","properties":{"ask_host_to_confirm_disclaimer":{"type":"boolean"},"ask_participants_to_consent_disclaimer":{"type":"boolean"},"auto_delete_cmr":{"default":false,"type":"boolean"},"auto_delete_cmr_days":{"anyOf":[{"type":"number","const":30},{"type":"number","const":60},{"type":"number","const":90},{"type":"number","const":120}]},"record_files_separately":{"type":"object","properties":{"active_speaker":{"type":"boolean"},"gallery_view":{"type":"boolean"},"shared_screen":{"type":"boolean"}},"additionalProperties":{}},"display_participant_name":{"type":"boolean"},"recording_thumbnails":{"type":"boolean"},"optimize_recording_for_3rd_party_video_editor":{"type":"boolean"},"recording_highlight":{"type":"boolean"},"save_panelist_chat":{"type":"boolean"},"save_poll_results":{"type":"boolean"},"save_close_caption":{"type":"boolean"},"auto_recording":{"anyOf":[{"type":"string","enum":["local","cloud","none"]},{"type":"string"}]},"cloud_recording":{"default":false,"type":"boolean"},"host_pause_stop_recording":{"default":false,"type":"boolean"},"ip_address_access_control":{"type":"object","properties":{"enable":{"type":"boolean"},"ip_addresses_or_ranges":{"type":"string"}},"additionalProperties":{}},"local_recording":{"type":"boolean"},"record_audio_file":{"default":false,"type":"boolean"},"record_gallery_view":{"default":false,"type":"boolean"},"record_speaker_view":{"default":false,"type":"boolean"},"recording_audio_transcript":{"type":"boolean"},"recording_disclaimer":{"type":"boolean"},"smart_recording":{"type":"object","properties":{"create_recording_highlights":{"type":"boolean"},"create_smart_chapters":{"type":"boolean"},"create_next_steps":{"type":"boolean"}},"additionalProperties":{}},"recording_password_requirement":{"type":"object","properties":{"have_letter":{"type":"boolean"},"have_number":{"type":"boolean"},"have_special_character":{"type":"boolean"},"length":{"type":"number"},"only_allow_numeric":{"type":"boolean"}},"additionalProperties":{}},"save_chat_text":{"default":false,"type":"boolean"},"show_timestamp":{"default":false,"type":"boolean"},"recording_notification_for_zoom_client":{"type":"object","properties":{"disclaimer_to_participants":{"type":"string"},"play_voice_prompt":{"type":"string"},"ask_host_to_confirm":{"type":"boolean"}},"additionalProperties":{}}},"required":["auto_delete_cmr","cloud_recording","host_pause_stop_recording","record_audio_file","record_gallery_view","record_speaker_view","save_chat_text","show_timestamp"],"additionalProperties":{}},"schedule_meeting":{"type":"object","properties":{"audio_type":{"anyOf":[{"type":"string","enum":["both","telephony","voip","thirdParty"]},{"type":"string"}]},"default_password_for_scheduled_meetings":{"type":"string"},"embed_password_in_join_link":{"type":"boolean"},"force_pmi_jbh_password":{"type":"boolean"},"host_video":{"type":"boolean"},"join_before_host":{"type":"boolean"},"meeting_password_requirement":{"type":"object","properties":{"consecutive_characters_length":{"anyOf":[{"type":"number","const":0},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"number","const":7},{"type":"number","const":8}]},"have_letter":{"type":"boolean"},"have_number":{"type":"boolean"},"have_special_character":{"type":"boolean"},"have_upper_and_lower_characters":{"type":"boolean"},"length":{"type":"number"},"only_allow_numeric":{"type":"boolean"},"weak_enhance_detection":{"type":"boolean"}},"additionalProperties":{}},"participants_video":{"type":"boolean"},"personal_meeting":{"type":"boolean"},"pmi_password":{"type":"string"},"pstn_password_protected":{"type":"boolean"},"require_password_for_instant_meetings":{"type":"boolean"},"require_password_for_pmi_meetings":{"anyOf":[{"type":"string","enum":["jbh_only","all","none"]},{"type":"string"}]},"require_password_for_scheduled_meetings":{"type":"boolean"},"require_password_for_scheduling_new_meetings":{"type":"boolean"},"use_pmi_for_instant_meetings":{"type":"boolean"},"use_pmi_for_scheduled_meetings":{"type":"boolean"},"continuous_meeting_chat":{"type":"object","properties":{"enable":{"type":"boolean"},"can_add_external_users":{"type":"boolean"},"auto_add_invited_external_users":{"type":"boolean"},"support_instant_meetings":{"type":"boolean"},"support_scheduled_meetings":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}},"telephony":{"type":"object","properties":{"audio_conference_info":{"default":"","type":"string"},"show_international_numbers_link":{"type":"boolean"},"telephony_regions":{"type":"object","properties":{"allowed_values":{"type":"array","items":{"type":"string"}},"selection_values":{"type":"string"}},"additionalProperties":{}},"third_party_audio":{"type":"boolean"}},"required":["audio_conference_info"],"additionalProperties":{}},"tsp":{"type":"object","properties":{"call_out":{"type":"boolean"},"call_out_countries":{"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"show_international_numbers_link":{"type":"boolean"},"global_dial_in_countries":{"type":"object","properties":{"allowed_countries":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}},"selected_countries":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}}},"additionalProperties":{}},"whiteboard":{"type":"object","properties":{"out_meeting_advanced_whiteboard":{"type":"boolean"},"in_meeting_advanced_whiteboard":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}},{"type":"object","properties":{"authentication_options":{"type":"object","properties":{"meeting_authentication":{"type":"object","properties":{"allow_authentication_exception":{"type":"boolean"},"authentication_options":{"type":"array","items":{"type":"object","properties":{"default_option":{"type":"boolean"},"domains":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["enforce_login","enforce_login_with_domains","enforce_login_with_same_account"]},{"type":"string"}]},"visible":{"type":"boolean"}},"additionalProperties":{}}},"meeting_authentication":{"type":"boolean"}},"additionalProperties":{}},"recording_authentication":{"type":"object","properties":{"authentication_options":{"type":"array","items":{"type":"object","properties":{"default_option":{"type":"boolean"},"domains":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["enforce_login","enforce_login_with_domains","internally"]},{"type":"string"}]},"visible":{"type":"boolean"}},"additionalProperties":{}}},"recording_authentication":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}}},"additionalProperties":{}},{"type":"object","properties":{"allow_authentication_exception":{"type":"boolean"},"authentication_options":{"type":"array","items":{"type":"object","properties":{"default_option":{"type":"boolean"},"domains":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["enforce_login","enforce_login_with_same_account","enforce_login_with_domains"]},{"type":"string"}]},"visible":{"type":"boolean"}},"additionalProperties":{}}},"meeting_authentication":{"type":"boolean"}},"additionalProperties":{}},{"type":"object","properties":{"authentication_options":{"type":"array","items":{"type":"object","properties":{"default_option":{"type":"boolean"},"domains":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["internally","enforce_login","enforce_login_with_domains"]},{"type":"string"}]},"visible":{"type":"boolean"}},"additionalProperties":{}}},"recording_authentication":{"type":"boolean"}},"additionalProperties":{}},{"type":"object","properties":{"meeting_security":{"type":"object","properties":{"auto_security":{"type":"boolean"},"block_user_domain":{"type":"boolean"},"block_user_domain_list":{"maxItems":20,"type":"array","items":{"type":"string"}},"embed_password_in_join_link":{"type":"boolean"},"encryption_type":{"anyOf":[{"type":"string","enum":["enhanced_encryption","e2ee"]},{"type":"string"}]},"end_to_end_encrypted_meetings":{"type":"boolean"},"meeting_password":{"type":"boolean"},"meeting_password_requirement":{"type":"object","properties":{"consecutive_characters_length":{"anyOf":[{"type":"number","const":0},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"number","const":7},{"type":"number","const":8}]},"have_letter":{"type":"boolean"},"have_number":{"type":"boolean"},"have_special_character":{"type":"boolean"},"have_upper_and_lower_characters":{"type":"boolean"},"length":{"type":"number"},"only_allow_numeric":{"type":"boolean"},"weak_enhance_detection":{"type":"boolean"}},"additionalProperties":{}},"only_authenticated_can_join_from_webclient":{"type":"boolean"},"phone_password":{"type":"boolean"},"pmi_password":{"type":"boolean"},"require_password_for_scheduled_meeting":{"type":"boolean"},"require_password_for_scheduled_webinar":{"type":"boolean"},"waiting_room":{"type":"boolean"},"waiting_room_settings":{"type":"object","properties":{"participants_to_place_in_waiting_room":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1},{"type":"number","const":2}]},"users_who_can_admit_participants_from_waiting_room":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1}]},"whitelisted_domains_for_waiting_room":{"type":"string"}},"additionalProperties":{}},"webinar_password":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-users/users/{userId}/token":{"get":{"operationId":"zoom-users.get_user_token","description":"Get a user's token. Can retrieve either a regular token or a ZAK token.","tags":["zoom-users"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"User ID or email"},"required":true,"description":"User ID or email"},{"in":"query","name":"type","schema":{"description":"Token type to retrieve","type":"string","enum":["token","zak"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}}},"webhooks":{},"components":{"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}},"bearerApiKey":{"type":"http","scheme":"bearer","description":"API key authentication. Pass a Ferrule API key as a Bearer token."}}}}