@itentialopensource/adapter-zoom

{ "openapi": "3.0.0", "info": { "title": "Zoom API", "description": "API Description", "contact": { "name": "Zoom Developers", "url": "https://developer.zoom.us/", "email": "developer@zoom.us" }, "version": "2.0.0" }, "servers": [ { "url": "https://api.zoom.us/v2", "variables": {} } ], "paths": { "/accounts": { "get": { "tags": [ "Accounts" ], "summary": "accounts", "description": "List all the sub accounts under the master account", "operationId": "accounts", "parameters": [ { "name": "page_size", "in": "query", "description": "The number of records returned within a single API call", "style": "form", "explode": true, "schema": { "maximum": 300.0, "type": "integer", "format": "int32", "default": 30 } }, { "name": "page_number", "in": "query", "description": "Current page number of returned records", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Account list returned", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountList" } }, "application/xml": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AccountList" }, { "xml": { "name": "AccountList", "attribute": false, "wrapped": false } } ] } } } } }, "deprecated": false }, "post": { "tags": [ "Accounts" ], "summary": "accountCreate", "description": "Create a sub account under the master account. <aside>Your account must be a master account and have this privilege to create sub account. Zoom only assigns this privilege to trusted partners. The created user will not receive a confirmation email.</aside>.", "operationId": "accountCreate", "parameters": [], "requestBody": { "description": "Account", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Account" }, { "description": "Account" } ] } } }, "required": true }, "responses": { "201": { "description": "Account Created", "headers": { "Content-Location": { "description": "Location of created Account", "content": { "text/plain": { "schema": { "type": "string", "description": "Location of created Account" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountCreateResponse" } }, "application/xml": { "schema": { "allOf": [ { "$ref": "#/components/schemas/accountCreateResponse" }, { "xml": { "name": "accountCreateResponse", "attribute": false, "wrapped": false } } ] } } } }, "409": { "description": "Account with that email already exists", "headers": {}, "content": {} } }, "deprecated": false } }, "/accounts/{accountId}": { "get": { "tags": [ "Accounts" ], "summary": "account", "description": "Retrieve a sub account under the master account. <aside>Your account must be a master account and have this privilege to read sub accounts. Zoom only assigns this privilege to trusted partners</aside>.", "operationId": "account", "parameters": [ { "name": "accountId", "in": "path", "description": "The account ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Account object returned", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountResponse" } }, "application/xml": { "schema": { "allOf": [ { "$ref": "#/components/schemas/accountResponse" }, { "xml": { "name": "accountResponse", "attribute": false, "wrapped": false } } ] } } } }, "404": { "description": "User not found", "headers": {}, "content": {} } }, "deprecated": false }, "delete": { "tags": [ "Accounts" ], "summary": "accountDisassociate", "description": "Disassociate a sub account from the master account. This will leave the account intact but the sub account will not longer be associated with the master account.", "operationId": "accountDisassociate", "parameters": [ { "name": "accountId", "in": "path", "description": "The account ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Account deleted", "headers": {}, "content": {} }, "404": { "description": "Account not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/accounts/{accountId}/options": { "patch": { "tags": [ "Accounts" ], "summary": "accountOptionsUpdate", "description": "Update a sub account's options under the master account", "operationId": "accountOptionsUpdate", "parameters": [ { "name": "accountId", "in": "path", "description": "The account ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOptions" } } }, "required": true }, "responses": { "204": { "description": "Account options updated", "headers": {}, "content": {} }, "404": { "description": "Account not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/accounts/{accountId}/settings": { "get": { "tags": [ "Accounts" ], "summary": "accountSettings", "description": "Retrieve a sub account's settings under the master account", "operationId": "accountSettings", "parameters": [ { "name": "accountId", "in": "path", "description": "The account ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Account settings returned", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accountsettings" } }, "application/xml": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accountsettings" }, { "xml": { "name": "Accountsettings", "attribute": false, "wrapped": false } } ] } } } }, "404": { "description": "Account not found", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "Accounts" ], "summary": "accountSettingsUpdate", "description": "Update a sub account's settings under the master account", "operationId": "accountSettingsUpdate", "parameters": [ { "name": "accountId", "in": "path", "description": "The account ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accountsettings" } } }, "required": true }, "responses": { "204": { "description": "Account settings updated", "headers": {}, "content": {} }, "404": { "description": "Account not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/accounts/{accountId}/managed_domains": { "get": { "tags": [ "Accounts" ], "summary": "accountManagedDomain", "description": "Retrieve a sub account's managed domains under the master account", "operationId": "accountManagedDomain", "parameters": [ { "name": "accountId", "in": "path", "description": "The account ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Account managed domains returned", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainsList" } }, "application/xml": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DomainsList" }, { "xml": { "name": "DomainsList", "attribute": false, "wrapped": false } } ] } } } }, "404": { "description": "Account not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/accounts/{accountId}/billing": { "get": { "tags": [ "Billing" ], "summary": "accountBilling", "description": "Retrieve billing information for a sub account under the master account", "operationId": "accountBilling", "parameters": [ { "name": "accountId", "in": "path", "description": "The account ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Account billing contact information returned", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingContactRequired" } }, "application/xml": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BillingContactRequired" }, { "xml": { "name": "BillingContactRequired", "attribute": false, "wrapped": false } } ] } } } }, "404": { "description": "Account not found", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "Billing" ], "summary": "accountBillingUpdate", "description": "Update billing information for a sub account under the master account <aside>Only for the sub account which is a paid account and paid by master account</aside>", "operationId": "accountBillingUpdate", "parameters": [ { "name": "accountId", "in": "path", "description": "The account ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingContact" } } }, "required": true }, "responses": { "204": { "description": "Account billing contact information updated", "headers": {}, "content": {} }, "404": { "description": "Account not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/accounts/{accountId}/plans": { "get": { "tags": [ "Billing" ], "summary": "accountPlans", "description": "Retrieve plan information for a sub account under the master account <aside>Only for the sub account which is paid by master account</aside>", "operationId": "accountPlans", "parameters": [ { "name": "accountId", "in": "path", "description": "The account ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Account plans returned", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountPlans" } }, "application/xml": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AccountPlans" }, { "xml": { "name": "AccountPlans", "attribute": false, "wrapped": false } } ] } } } }, "404": { "description": "Account not fond", "headers": {}, "content": {} } }, "deprecated": false }, "post": { "tags": [ "Billing" ], "summary": "accountPlanCreate", "description": "Subscribe plans for a sub account of the master account <aside>Can only subscribe plans for the sub account which is a free account and paid by master account</aside>", "operationId": "accountPlanCreate", "parameters": [ { "name": "accountId", "in": "path", "description": "The account ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/body" } } }, "required": true }, "responses": { "201": { "description": "Account plans updated", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountPlans" } }, "application/xml": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AccountPlans" }, { "xml": { "name": "AccountPlans", "attribute": false, "wrapped": false } } ] } } } } }, "deprecated": false } }, "/accounts/{accountId}/plans/base": { "put": { "tags": [ "Billing" ], "summary": "accountPlanBaseUpdate", "description": "Update a base plan for a sub account <aside>Can only update a base plan for the sub account which is a paid account and paid by master account</aside>", "operationId": "accountPlanBaseUpdate", "parameters": [ { "name": "accountId", "in": "path", "description": "The account ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountPlanBaseRequired" } } }, "required": true }, "responses": { "204": { "description": "Account plans updated", "headers": {}, "content": {} } }, "deprecated": false } }, "/accounts/{accountId}/plans/addons": { "post": { "tags": [ "Billing" ], "summary": "accountPlanAddonCreate", "description": "Add an additional plan for sub account <aside>Can only add an Additional plan for the sub account which is a paid account and paid by master account</aside>", "operationId": "accountPlanAddonCreate", "parameters": [ { "name": "accountId", "in": "path", "description": "The account ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountPlanRequired" } } }, "required": true }, "responses": { "201": { "description": "Account plans updated", "headers": {}, "content": {} } }, "deprecated": false }, "put": { "tags": [ "Billing" ], "summary": "accountPlanAddonUpdate", "description": "Update an additional plan for sub account<aside>Can only update an Additional plan for the sub account which is a paid account and paid by master account</aside>", "operationId": "accountPlanAddonUpdate", "parameters": [ { "name": "accountId", "in": "path", "description": "The account ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountPlanRequired" } } }, "required": true }, "responses": { "204": { "description": "Account plans updated", "headers": {}, "content": {} } }, "deprecated": false } }, "/users": { "get": { "tags": [ "Users" ], "summary": "users", "description": "List users on your account", "operationId": "users", "parameters": [ { "name": "status", "in": "query", "description": "User status", "style": "form", "explode": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/status4" }, { "description": "User status" } ] } }, { "name": "page_size", "in": "query", "description": "The number of records returned within a single API call", "style": "form", "explode": true, "schema": { "maximum": 300.0, "type": "integer", "format": "int32", "default": 30 } }, { "name": "page_number", "in": "query", "description": "Current page number of returned records", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "User list returned", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserList" } }, "application/xml": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserList" }, { "xml": { "name": "UserList", "attribute": false, "wrapped": false } } ] } } } } }, "deprecated": false }, "post": { "tags": [ "Users" ], "summary": "userCreate", "description": "Create a user on your account", "operationId": "userCreate", "parameters": [], "requestBody": { "description": "User", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/body13" }, { "description": "User" } ] } } }, "required": true }, "responses": { "201": { "description": "User Created", "headers": { "Content-Location": { "description": "Location of created User", "content": { "text/plain": { "schema": { "type": "string", "description": "Location of created User" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userCreateResponse" } }, "application/xml": { "schema": { "allOf": [ { "$ref": "#/components/schemas/userCreateResponse" }, { "xml": { "name": "userCreateResponse", "attribute": false, "wrapped": false } } ] } } } }, "409": { "description": "User with that email already exists", "headers": {}, "content": {} } }, "deprecated": false } }, "/users/{userId}": { "get": { "tags": [ "Users" ], "summary": "user", "description": "Retrieve a user on your account", "operationId": "user", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID or email address", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "login_type", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/login_type" } } ], "responses": { "200": { "description": "User object returned", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userResponse" } }, "application/xml": { "schema": { "allOf": [ { "$ref": "#/components/schemas/userResponse" }, { "xml": { "name": "userResponse", "attribute": false, "wrapped": false } } ] } } } }, "404": { "description": "User not found", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "Users" ], "summary": "userUpdate", "description": "Update a user on your account", "operationId": "userUpdate", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID or email address", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "User", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserUpdate" }, { "description": "User" } ] } } }, "required": true }, "responses": { "204": { "description": "User updated", "headers": {}, "content": {} }, "404": { "description": "User not found", "headers": {}, "content": {} } }, "deprecated": false }, "delete": { "tags": [ "Users" ], "summary": "userDelete", "description": "Delete a user on your account", "operationId": "userDelete", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID or email address", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "action", "in": "query", "description": "Delete action type", "style": "form", "explode": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/action9" }, { "description": "Delete action type" } ] } }, { "name": "transfer_email", "in": "query", "description": "Transfer email", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "transfer_meeting", "in": "query", "description": "Transfer meeting", "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "transfer_webinar", "in": "query", "description": "Transfer webinar", "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "transfer_recording", "in": "query", "description": "Transfer recording", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "User deleted", "headers": {}, "content": {} }, "404": { "description": "User not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/users/{userId}/assistants": { "get": { "tags": [ "Users" ], "summary": "userAssistants", "description": "List a user's assistants", "operationId": "userAssistants", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID or email address", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserassistantsList" } }, "application/xml": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserassistantsList" }, { "xml": { "name": "UserassistantsList", "attribute": false, "wrapped": false } } ] } } } }, "404": { "description": "User not found", "headers": {}, "content": {} } }, "deprecated": false }, "post": { "tags": [ "Users" ], "summary": "userAssistantCreate", "description": "Add assistants to a user", "operationId": "userAssistantCreate", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID or email address", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "User assistant", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserassistantsList" }, { "description": "User assistant" } ] } } }, "required": true }, "responses": { "201": { "description": "Assitant Added", "headers": { "Content-Location": { "description": "Location of created assistant", "content": { "text/plain": { "schema": { "type": "string", "description": "Location of created assistant" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userAssistantCreateResponse" } }, "application/xml": { "schema": { "allOf": [ { "$ref": "#/components/schemas/userAssistantCreateResponse" }, { "xml": { "name": "userAssistantCreateResponse", "attribute": false, "wrapped": false } } ] } } } }, "404": { "description": "User not found", "headers": {}, "content": {} } }, "deprecated": false }, "delete": { "tags": [ "Users" ], "summary": "userAssistantsDelete", "description": "Delete all of a user'sassitants", "operationId": "userAssistantsDelete", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID or email address", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Assitants deleted", "headers": {}, "content": {} }, "404": { "description": "User not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/users/{userId}/assistants/{assistantId}": { "delete": { "tags": [ "Users" ], "summary": "userAssistantDelete", "description": "Delete one of a user's assistants", "operationId": "userAssistantDelete", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID or email address", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "assistantId", "in": "path", "description": "Assistant's ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Assitant deleted", "headers": {}, "content": {} }, "404": { "description": "User or Assistant not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/users/{userId}/schedulers": { "get": { "tags": [ "Users" ], "summary": "userSchedulers", "description": "List a user's schedulers", "operationId": "userSchedulers", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID or email address", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserschedulersList" } }, "application/xml": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserschedulersList" }, { "xml": { "name": "UserschedulersList", "attribute": false, "wrapped": false } } ] } } } }, "404": { "description": "User not found", "headers": {}, "content": {} } }, "deprecated": false }, "delete": { "tags": [ "Users" ], "summary": "userSchedulersDelete", "description": "Delete all of a user'schedulers", "operationId": "userSchedulersDelete", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID or email address", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Schedulers deleted.", "headers": {}, "content": {} }, "404": { "description": "User not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/users/{userId}/schedulers/{schedulerId}": { "delete": { "tags": [ "Users" ], "summary": "userSchedulerDelete", "description": "Delete one of a user's schedulers", "operationId": "userSchedulerDelete", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID or email address", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "schedulerId", "in": "path", "description": "Scheduler's ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Scheduler deleted.", "headers": {}, "content": {} }, "404": { "description": "User or Scheduler not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/users/{userId}/picture": { "post": { "tags": [ "Users" ], "summary": "userPicture", "description": "Upload a user's profile picture", "operationId": "userPicture", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID or email address", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "encoding": {}, "schema": { "required": [ "pic_file" ], "type": "object", "properties": { "pic_file": { "type": "string", "description": "User picture file, must be a jpg/jpeg file", "format": "binary" } } } } }, "required": false }, "responses": { "201": { "description": "Picture Uploaded", "headers": { "Content-Location": { "description": "Location of user's picture", "content": { "text/plain": { "schema": { "type": "string", "description": "Location of user's picture" } } } } }, "content": {} }, "404": { "description": "User not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/users/{userId}/settings": { "get": { "tags": [ "Users" ], "summary": "userSettings", "description": "Retrieve a user's settings", "operationId": "userSettings", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID or email address", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "login_type", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/login_type" } } ], "responses": { "200": { "description": "User settings returned", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Usersettings" } }, "application/xml": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Usersettings" }, { "xml": { "name": "Usersettings", "attribute": false, "wrapped": false } } ] } } } }, "404": { "description": "User not found", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "Users" ], "summary": "userSettingsUpdate", "description": "Update a user's settings", "operationId": "userSettingsUpdate", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID or email address", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "User Settings", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Usersettings1" }, { "description": "User Settings" } ] } } }, "required": true }, "responses": { "204": { "description": "User setting's updated", "headers": {}, "content": {} }, "404": { "description": "User not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/users/{userId}/status": { "put": { "tags": [ "Users" ], "summary": "userStatus", "description": "Update a user's status", "operationId": "userStatus", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID or email address", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "User status", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/body14" }, { "description": "User status" } ] } } }, "required": true }, "responses": { "204": { "description": "Status updated", "headers": {}, "content": {} }, "404": { "description": "User not found", "headers": {}, "content": {} } }, "deprecated": false } }, "/users/{userId}/password": { "put": {