class ZoomUs::Users
Attributes
Public Class Methods
# File lib/zoom_us/users.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Switch a User's Account Disassociate a user from one Account and move the user to another Account under the same Master Account. With this API, a user under a Master Account or a Sub Account can be moved to another Sub Account within the same Master Account. To move a user from a Master Account to a Sub Account, use `me` as the value for `accountId`. In this scenario, "me" refers to the Account ID of the Master Account. To move a user from one Sub Account to another Sub Account, provide the Sub Account's Account ID as the value for `accountId`. Prerequisites: * The account should have Pro or a higher plan with Master Account option enabled. * The user whose account needs to be switched should not be an admin or an owner of that account. * The user should not have the same [managed domain](support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-) as the account owner. Scope: `user:master`
@param user_id @param account_id @param [Hash] opts the optional parameters @option opts [Body54] :body @return [Object]
# File lib/zoom_us/users.rb, line 29 def switch_user_account(user_id, account_id, opts = {}) data, _status_code, _headers = switch_user_account_with_http_info(user_id, account_id, opts) data end
Switch a User's Account Disassociate a user from one Account and move the user to another Account under the same Master Account. With this API, a user under a Master Account or a Sub Account can be moved to another Sub Account within the same Master Account. To move a user from a Master Account to a Sub Account, use `me` as the value for `accountId`. In this scenario, "me" refers to the Account ID of the Master Account. To move a user from one Sub Account to another Sub Account, provide the Sub Account's Account ID as the value for `accountId`. Prerequisites: * The account should have Pro or a higher plan with Master Account option enabled. * The user whose account needs to be switched should not be an admin or an owner of that account. * The user should not have the same [managed domain](support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-) as the account owner. Scope: `user:master`<br> @param user_id @param account_id @param [Hash] opts the optional parameters @option opts [Body54] :body @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
# File lib/zoom_us/users.rb, line 41 def switch_user_account_with_http_info(user_id, account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.switch_user_account ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.switch_user_account" end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.switch_user_account" end # resource path local_var_path = '/accounts/{accountId}/users/{userId}/account'.sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Object') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#switch_user_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a User A Zoom account can have one or more users. Use this API to view information of a specific user on a Zoom account.
Scopes: `user:read:admin` `user:read`
<p style="background-color:#e1f5fe; color:#01579b; padding:8px"> Note: If a user's status is pending, only `id` and `created_at` fields will be returned. The value of `created_at` will be the time at which the API call was made until the user activates their account.</p> @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @option opts [String] :login_type `0` - Facebook.<br>`1` - Google.<br>`99` - API.<br>`100` - Zoom.<br>`101` - SSO. @return [InlineResponse20047]
# File lib/zoom_us/users.rb, line 90 def user(user_id, opts = {}) data, _status_code, _headers = user_with_http_info(user_id, opts) data end
Add Assistants Assistants are the users to whom the current user has assigned [scheduling privilege](support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](zoom.us/account/setting) on the account.
Use this API to assign assistants to a user.
In the request body, provide either the User ID or the email address of the user.
Prerequisite: * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user's account.
Scopes: `user:write:admin` `user:write` @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param body User assistant. @param [Hash] opts the optional parameters @return [InlineResponse20117]
# File lib/zoom_us/users.rb, line 150 def user_assistant_create(user_id, body, opts = {}) data, _status_code, _headers = user_assistant_create_with_http_info(user_id, body, opts) data end
Add Assistants Assistants are the users to whom the current user has assigned [scheduling privilege](support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](zoom.us/account/setting) on the account.<br>Use this API to assign assistants to a user. <br> In the request body, provide either the User ID or the email address of the user.<br><br> Prerequisite: * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user's account.<br> Scopes: `user:write:admin` `user:write` @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param body User assistant. @param [Hash] opts the optional parameters @return [Array<(InlineResponse20117, Fixnum, Hash)>] InlineResponse20117 data, response status code and response headers
# File lib/zoom_us/users.rb, line 161 def user_assistant_create_with_http_info(user_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_assistant_create ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_assistant_create" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.user_assistant_create" end # resource path local_var_path = '/users/{userId}/assistants'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20117') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_assistant_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a User Assistant Delete a specific assistant of a user. Assistants are the users to whom the current user has assigned [scheduling privilege](support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](zoom.us/account/setting) on the account.
Prerequisites: * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user's account.
Scopes: `user:write:admin` `user:write` @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param assistant_id Assistant ID. @param [Hash] opts the optional parameters @return [nil]
# File lib/zoom_us/users.rb, line 210 def user_assistant_delete(user_id, assistant_id, opts = {}) user_assistant_delete_with_http_info(user_id, assistant_id, opts) nil end
Delete a User Assistant Delete a specific assistant of a user. Assistants are the users to whom the current user has assigned [scheduling privilege](support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](zoom.us/account/setting) on the account.<br><br> Prerequisites: * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user's account.<br> Scopes: `user:write:admin` `user:write` @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param assistant_id Assistant ID. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/zoom_us/users.rb, line 221 def user_assistant_delete_with_http_info(user_id, assistant_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_assistant_delete ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_assistant_delete" end # verify the required parameter 'assistant_id' is set if @api_client.config.client_side_validation && assistant_id.nil? fail ArgumentError, "Missing the required parameter 'assistant_id' when calling UsersApi.user_assistant_delete" end # resource path local_var_path = '/users/{userId}/assistants/{assistantId}'.sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'assistantId' + '}', assistant_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_assistant_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List User Assistants List a user's assistants. Assistants are the users to whom the current user has assigned [scheduling privilege](support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](zoom.us/account/setting) on the account.
Prerequisites:
* Current user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user's account.
Scopes: `user:read:admin` `user:read`
@param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @return [UserAssistantsList]
# File lib/zoom_us/users.rb, line 268 def user_assistants(user_id, opts = {}) data, _status_code, _headers = user_assistants_with_http_info(user_id, opts) data end
Delete User Assistants Delete all assistants of the current user.
Assistants are the users to whom the current user has assigned [scheduling privilege](support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](zoom.us/account/setting) on the account.
Prerequisite: * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user's account.
Scopes: `user:write:admin` `user:write` @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @return [nil]
# File lib/zoom_us/users.rb, line 322 def user_assistants_delete(user_id, opts = {}) user_assistants_delete_with_http_info(user_id, opts) nil end
Delete User Assistants Delete all assistants of the current user.<br> Assistants are the users to whom the current user has assigned [scheduling privilege](support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](zoom.us/account/setting) on the account.<br> Prerequisite: * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user's account.<br> Scopes: `user:write:admin` `user:write` @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/zoom_us/users.rb, line 332 def user_assistants_delete_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_assistants_delete ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_assistants_delete" end # resource path local_var_path = '/users/{userId}/assistants'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_assistants_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List User Assistants List a user's assistants. Assistants are the users to whom the current user has assigned [scheduling privilege](support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](zoom.us/account/setting) on the account.<br><br> Prerequisites: <br> * Current user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user's account.<br> Scopes: `user:read:admin` `user:read`<br> @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @return [Array<(UserAssistantsList, Fixnum, Hash)>] UserAssistantsList data, response status code and response headers
# File lib/zoom_us/users.rb, line 278 def user_assistants_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_assistants ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_assistants" end # resource path local_var_path = '/users/{userId}/assistants'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UserAssistantsList') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_assistants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create Users
A Zoom account can have one or more users. Use this API to add a new user to your account.
Scopes: `user:write:admin` `user:write`
@param body User @param [Hash] opts the optional parameters @return [InlineResponse20116]
# File lib/zoom_us/users.rb, line 375 def user_create(body, opts = {}) data, _status_code, _headers = user_create_with_http_info(body, opts) data end
Create Users
A Zoom account can have one or more users. Use this API to add a new user to your account.<br><br> Scopes: `user:write:admin` `user:write`<br> @param body User @param [Hash] opts the optional parameters @return [Array<(InlineResponse20116, Fixnum, Hash)>] InlineResponse20116 data, response status code and response headers
# File lib/zoom_us/users.rb, line 385 def user_create_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_create ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.user_create" end # resource path local_var_path = '/users' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20116') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete User Deleting a user permanently removes them and their data from Zoom. They will be able to create a new Zoom account with the same email address if they have access to it. An account owner or an account admin can transfer meetings, webinars and cloud recordings to another Zoom user before deleting, but if not transferred, they will be permanently deleted.
By default, this API disassociates (unlinks) a user from the associated account. The disassociation will give them their own basic, free Zoom account. It will not be associated with your account, and they will be able to purchase their own licenses. You can transfer the user's data (meetings, webinars and cloud recordings) to another user before disassociation.
To permanently delete a user, specify "delete" as the value of the `action` query parameter. Scopes: `user:write:admin` `user:write`
@param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @option opts [String] :action Delete action options:<br>`disassociate` - Disassociate a user.<br>`delete`- Permanently delete a user.<br>Note: To delete pending user in the account, use `disassociate` (default to disassociate) @option opts [String] :transfer_email Transfer email. @option opts [BOOLEAN] :transfer_meeting Transfer meeting. @option opts [BOOLEAN] :transfer_webinar Transfer webinar. @option opts [BOOLEAN] :transfer_recording Transfer recording. @return [nil]
# File lib/zoom_us/users.rb, line 434 def user_delete(user_id, opts = {}) user_delete_with_http_info(user_id, opts) nil end
Delete User Deleting a user permanently removes them and their data from Zoom. They will be able to create a new Zoom account with the same email address if they have access to it. An account owner or an account admin can transfer meetings, webinars and cloud recordings to another Zoom user before deleting, but if not transferred, they will be permanently deleted.<br><br> By default, this API disassociates (unlinks) a user from the associated account. The disassociation will give them their own basic, free Zoom account. It will not be associated with your account, and they will be able to purchase their own licenses. You can transfer the user's data (meetings, webinars and cloud recordings) to another user before disassociation.<br> To permanently delete a user, specify "delete" as the value of the `action` query parameter. Scopes: `user:write:admin` `user:write`<br> @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @option opts [String] :action Delete action options:<br>`disassociate` - Disassociate a user.<br>`delete`- Permanently delete a user.<br>Note: To delete pending user in the account, use `disassociate` @option opts [String] :transfer_email Transfer email. @option opts [BOOLEAN] :transfer_meeting Transfer meeting. @option opts [BOOLEAN] :transfer_webinar Transfer webinar. @option opts [BOOLEAN] :transfer_recording Transfer recording. @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/zoom_us/users.rb, line 449 def user_delete_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_delete ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_delete" end if @api_client.config.client_side_validation && opts[:'action'] && !['disassociate', 'delete'].include?(opts[:'action']) fail ArgumentError, 'invalid value for "action", must be one of disassociate, delete' end # resource path local_var_path = '/users/{userId}'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil? query_params[:'transfer_email'] = opts[:'transfer_email'] if !opts[:'transfer_email'].nil? query_params[:'transfer_meeting'] = opts[:'transfer_meeting'] if !opts[:'transfer_meeting'].nil? query_params[:'transfer_webinar'] = opts[:'transfer_webinar'] if !opts[:'transfer_webinar'].nil? query_params[:'transfer_recording'] = opts[:'transfer_recording'] if !opts[:'transfer_recording'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Check a User Email Verify if a user's email is registered with Zoom.
<p style="background-color:#ffffcc; color:#01579b; padding:8px"> Note: Starting November 17, 2019, the behavior of this API will change so that you will be able to successfully check to see if a user is a registered Zoom user only if the user is within your account. If you provide an email address of a user who is not in your account, the value of "existed_email" parameter will be "false" irrespective of whether or not the user is registered with Zoom. </p> Scopes: `user:read:admin` `user:read` @param email The email address to be verified. @param [Hash] opts the optional parameters @return [InlineResponse20052]
# File lib/zoom_us/users.rb, line 500 def user_email(email, opts = {}) data, _status_code, _headers = user_email_with_http_info(email, opts) data end
Update a User's Email Change a user's [email address](support.zoom.us/hc/en-us/articles/201362563-How-Do-I-Change-the-Email-on-My-Account-) on a Zoom account that has managed domain set up.
If the Zoom Account in which the user belongs, has multiple [managed domains](support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-), the email to be updated must match one of the managed domains.
Scopes: `user:write:admin` `user:write`
Prerequisite:
* Managed domain must be enabled in the account. * The new email address should not already exist in Zoom. @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param body User email. @param [Hash] opts the optional parameters @return [nil]
# File lib/zoom_us/users.rb, line 556 def user_email_update(user_id, body, opts = {}) user_email_update_with_http_info(user_id, body, opts) nil end
Update a User's Email Change a user's [email address](support.zoom.us/hc/en-us/articles/201362563-How-Do-I-Change-the-Email-on-My-Account-) on a Zoom account that has managed domain set up.<br>If the Zoom Account in which the user belongs, has multiple [managed domains](support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-), the email to be updated must match one of the managed domains.<br> Scopes: `user:write:admin` `user:write`<br> Prerequisite:<br> * Managed domain must be enabled in the account. * The new email address should not already exist in Zoom. @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param body User email. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/zoom_us/users.rb, line 567 def user_email_update_with_http_info(user_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_email_update ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_email_update" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.user_email_update" end # resource path local_var_path = '/users/{userId}/email'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_email_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Check a User Email Verify if a user's email is registered with Zoom.<br><br> <p style="background-color:#ffffcc; color:#01579b; padding:8px"> <b>Note: </b>Starting November 17, 2019, the behavior of this API will change so that you will be able to successfully check to see if a user is a registered Zoom user only if the user is within your account. If you provide an email address of a user who is not in your account, the value of "existed_email" parameter will be "false" irrespective of whether or not the user is registered with Zoom. </p> Scopes: `user:read:admin` `user:read` @param email The email address to be verified. @param [Hash] opts the optional parameters @return [Array<(InlineResponse20052, Fixnum, Hash)>] InlineResponse20052 data, response status code and response headers
# File lib/zoom_us/users.rb, line 510 def user_email_with_http_info(email, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_email ...' end # verify the required parameter 'email' is set if @api_client.config.client_side_validation && email.nil? fail ArgumentError, "Missing the required parameter 'email' when calling UsersApi.user_email" end # resource path local_var_path = '/users/email' # query parameters query_params = {} query_params[:'email'] = email # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20052') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a User's Password Update the [password](support.zoom.us/hc/en-us/articles/206344385-Change-a-User-s-Password) of a user using which the user can login to Zoom.
Scopes: `user:write:admin` `user:write`
Prerequisites:
* Owner or admin of the Zoom account. @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param body User password. @param [Hash] opts the optional parameters @return [nil]
# File lib/zoom_us/users.rb, line 615 def user_password(user_id, body, opts = {}) user_password_with_http_info(user_id, body, opts) nil end
Update a User's Password Update the [password](support.zoom.us/hc/en-us/articles/206344385-Change-a-User-s-Password) of a user using which the user can login to Zoom.<br><br> Scopes: `user:write:admin` `user:write`<br> Prerequisites:<br> * Owner or admin of the Zoom account. @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param body User password. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/zoom_us/users.rb, line 626 def user_password_with_http_info(user_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_password ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_password" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.user_password" end # resource path local_var_path = '/users/{userId}/password'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get User Permissions Users
can be assigned a set of permissions that allows them to access only the pages/information that a user needs to view or edit.
Use this API to get permissions that have been granted to the user.
Scopes: `user:read:admin` `user:read`
@param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @return [InlineResponse20048]
# File lib/zoom_us/users.rb, line 673 def user_permission(user_id, opts = {}) data, _status_code, _headers = user_permission_with_http_info(user_id, opts) data end
Get User Permissions Users
can be assigned a set of permissions that allows them to access only the pages/information that a user needs to view or edit.<br> Use this API to get permissions that have been granted to the user.<br><br> Scopes: `user:read:admin` `user:read`<br> @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @return [Array<(InlineResponse20048, Fixnum, Hash)>] InlineResponse20048 data, response status code and response headers
# File lib/zoom_us/users.rb, line 683 def user_permission_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_permission ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_permission" end # resource path local_var_path = '/users/{userId}/permissions'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20048') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_permission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Upload a User's Profile Picture Upload a user's profile picture.
Provide `multipart/form-data` as the value of the `content-type` header for this request. Scopes: `user:write:admin` `user:write`
@param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param pic_file The file's path. @param [Hash] opts the optional parameters @return [nil]
# File lib/zoom_us/users.rb, line 728 def user_picture(user_id, pic_file, opts = {}) user_picture_with_http_info(user_id, pic_file, opts) nil end
Upload a User's Profile Picture Upload a user's profile picture.<br><br> Provide `multipart/form-data` as the value of the `content-type` header for this request. Scopes: `user:write:admin` `user:write`<br> @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param pic_file The file's path. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/zoom_us/users.rb, line 739 def user_picture_with_http_info(user_id, pic_file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_picture ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_picture" end # verify the required parameter 'pic_file' is set if @api_client.config.client_side_validation && pic_file.nil? fail ArgumentError, "Missing the required parameter 'pic_file' when calling UsersApi.user_picture" end # resource path local_var_path = '/users/{userId}/picture'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data']) # form parameters form_params = {} form_params['pic_file'] = pic_file # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_picture\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a Scheduler Delete a Scheduler. Schedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of this scheduler. Prerequisite: Current user must be under the same account as the scheduler.
Scopes: `user:write:admin` `user:write` @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param scheduler_id Scheduler's ID. @param [Hash] opts the optional parameters @return [nil]
# File lib/zoom_us/users.rb, line 788 def user_scheduler_delete(user_id, scheduler_id, opts = {}) user_scheduler_delete_with_http_info(user_id, scheduler_id, opts) nil end
Delete a Scheduler Delete a Scheduler. Schedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of this scheduler. Prerequisite: Current user must be under the same account as the scheduler.<br> Scopes: `user:write:admin` `user:write` @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param scheduler_id Scheduler's ID. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/zoom_us/users.rb, line 799 def user_scheduler_delete_with_http_info(user_id, scheduler_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_scheduler_delete ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_scheduler_delete" end # verify the required parameter 'scheduler_id' is set if @api_client.config.client_side_validation && scheduler_id.nil? fail ArgumentError, "Missing the required parameter 'scheduler_id' when calling UsersApi.user_scheduler_delete" end # resource path local_var_path = '/users/{userId}/schedulers/{schedulerId}'.sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'schedulerId' + '}', scheduler_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_scheduler_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List User Schedulers List all the schedulers of a user. Schedulers in this context are the users for whom the current user can schedule meetings for. For instance, if the current user (i.e., the user whose userId was passed in the path parameter of this API call) is user A, the response of this API will contain a list of user(s), for whom user A can schedule and manage meetings. User A is the assistant of these users and thus has scheduling privilege for these user(s). Prerequisites: * Current user must be under the same account as the scheduler.
Scopes: `user:read:admin` `user:read` @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @return [UserSchedulersList]
# File lib/zoom_us/users.rb, line 846 def user_schedulers(user_id, opts = {}) data, _status_code, _headers = user_schedulers_with_http_info(user_id, opts) data end
Delete User Schedulers Delete all of a user's schedulers. Schedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of any user. Prerequisite: Current user (assistant) must be under the same account as the scheduler.
Scopes: `user:write:admin` `user:write` @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @return [nil]
# File lib/zoom_us/users.rb, line 900 def user_schedulers_delete(user_id, opts = {}) user_schedulers_delete_with_http_info(user_id, opts) nil end
Delete User Schedulers Delete all of a user's schedulers. Schedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of any user. Prerequisite: Current user (assistant) must be under the same account as the scheduler.<br> Scopes: `user:write:admin` `user:write` @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/zoom_us/users.rb, line 910 def user_schedulers_delete_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_schedulers_delete ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_schedulers_delete" end # resource path local_var_path = '/users/{userId}/schedulers'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_schedulers_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List User Schedulers List all the schedulers of a user. Schedulers in this context are the users for whom the current user can schedule meetings for. For instance, if the current user (i.e., the user whose userId was passed in the path parameter of this API call) is user A, the response of this API will contain a list of user(s), for whom user A can schedule and manage meetings. User A is the assistant of these users and thus has scheduling privilege for these user(s). Prerequisites: * Current user must be under the same account as the scheduler.<br> Scopes: `user:read:admin` `user:read` @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @return [Array<(UserSchedulersList, Fixnum, Hash)>] UserSchedulersList data, response status code and response headers
# File lib/zoom_us/users.rb, line 856 def user_schedulers_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_schedulers ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_schedulers" end # resource path local_var_path = '/users/{userId}/schedulers'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UserSchedulersList') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_schedulers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get User Settings Retrieve a user's settings.
Scopes: `user:read:admin` `user:read`
@param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @option opts [String] :login_type `0` - Facebook.<br>`1` - Google.<br>`99` - API.<br>`100` - Zoom.<br>`101` - SSO. @option opts [String] :option `meeting_authentication`: Use this query parameter to view [meeting authentication configuration](support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied on the account.<br>`recording_authentication`: Use this query parameter to view [recording authentication configuration](support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied on the account. @return [Object]
# File lib/zoom_us/users.rb, line 955 def user_settings(user_id, opts = {}) data, _status_code, _headers = user_settings_with_http_info(user_id, opts) data end
Update User Settings Update a user's settings.
Scopes: `user:write:admin` `user:write`
@param body User Settings @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @option opts [String] :option @return [nil]
# File lib/zoom_us/users.rb, line 1021 def user_settings_update(body, user_id, opts = {}) user_settings_update_with_http_info(body, user_id, opts) nil end
Update User Settings Update a user's settings.<br><br> Scopes: `user:write:admin` `user:write`<br> @param body User Settings @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @option opts [String] :option @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/zoom_us/users.rb, line 1033 def user_settings_update_with_http_info(body, user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_settings_update ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.user_settings_update" end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_settings_update" end if @api_client.config.client_side_validation && opts[:'option'] && !['meeting_authentication', 'recording_authentication'].include?(opts[:'option']) fail ArgumentError, 'invalid value for "option", must be one of meeting_authentication, recording_authentication' end # resource path local_var_path = '/users/{userId}/settings'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} query_params[:'option'] = opts[:'option'] if !opts[:'option'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_settings_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get User Settings Retrieve a user's settings.<br><br> Scopes: `user:read:admin` `user:read`<br> @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @option opts [String] :login_type `0` - Facebook.<br>`1` - Google.<br>`99` - API.<br>`100` - Zoom.<br>`101` - SSO. @option opts [String] :option `meeting_authentication`: Use this query parameter to view [meeting authentication configuration](support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied on the account.<br>`recording_authentication`: Use this query parameter to view [recording authentication configuration](support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied on the account. @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
# File lib/zoom_us/users.rb, line 967 def user_settings_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_settings ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_settings" end if @api_client.config.client_side_validation && opts[:'login_type'] && !['0', '1', '99', '100', '101'].include?(opts[:'login_type']) fail ArgumentError, 'invalid value for "login_type", must be one of 0, 1, 99, 100, 101' end if @api_client.config.client_side_validation && opts[:'option'] && !['meeting_authentication', 'recording_authentication'].include?(opts[:'option']) fail ArgumentError, 'invalid value for "option", must be one of meeting_authentication, recording_authentication' end # resource path local_var_path = '/users/{userId}/settings'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} query_params[:'login_type'] = opts[:'login_type'] if !opts[:'login_type'].nil? query_params[:'option'] = opts[:'option'] if !opts[:'option'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Object') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Revoke a User's SSO Token Revoke a user's SSO token.
After calling this API, the SSO user will be logged out of their current Zoom session.
Scopes: `user:write:admin` `user:write` @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @return [nil]
# File lib/zoom_us/users.rb, line 1084 def user_sso_token_delete(user_id, opts = {}) user_sso_token_delete_with_http_info(user_id, opts) nil end
Revoke a User's SSO Token Revoke a user's SSO token.<br><br> After calling this API, the SSO user will be logged out of their current Zoom session.<br> Scopes: `user:write:admin` `user:write` @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/zoom_us/users.rb, line 1094 def user_sso_token_delete_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_sso_token_delete ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_sso_token_delete" end # resource path local_var_path = '/users/{userId}/token'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_sso_token_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update User Status An account owner or admins can deactivate as well as activate a user in a Zoom account. Deactivating a user will remove all licenses associated with a user. It will prevent the deactivated user from logging into their Zoom account. A deactivated user can be reactivated. Reactivating a user grants the user access to login to their Zoom account.
Use this API to either [deactivate](support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_6a9bc1c3-d739-4945-b1f2-00b3b88fb5cc) an active user or to [reactivate](support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_16319724-d120-4be6-af5d-31582d134ea0) a deactivated user .
Scopes: `user:write:admin` `user:write`
@param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param body User status. @param [Hash] opts the optional parameters @return [nil]
# File lib/zoom_us/users.rb, line 1138 def user_status(user_id, body, opts = {}) user_status_with_http_info(user_id, body, opts) nil end
Update User Status An account owner or admins can deactivate as well as activate a user in a Zoom account. Deactivating a user will remove all licenses associated with a user. It will prevent the deactivated user from logging into their Zoom account. A deactivated user can be reactivated. Reactivating a user grants the user access to login to their Zoom account.<br> Use this API to either [deactivate](support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_6a9bc1c3-d739-4945-b1f2-00b3b88fb5cc) an active user or to [reactivate](support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_16319724-d120-4be6-af5d-31582d134ea0) a deactivated user .<br><br>Scopes: `user:write:admin` `user:write`<br> @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param body User status. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/zoom_us/users.rb, line 1149 def user_status_with_http_info(user_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_status ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_status" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.user_status" end # resource path local_var_path = '/users/{userId}/status'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a User Token Retrieve a user's token.
This token is used for starting meetings with the Client SDK.
Scopes: `user:read:admin` `user:read`
If a user signed into Zoom using Google or Facebook, a null value will be returned for the token. To get the token with this API, ask the user to sign into Zoom using their email and password instead. @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @option opts [String] :type User token types:<br>`token` - Used for starting meetings with the client SDK.<br>`zpk` - Used for generating the start meeting URL (Deprecated).<br>`zak` - Used for generating the start meeting URL. The token expiration time is two hours. For API users, the expiration time is 90 days. @return [InlineResponse20051]
# File lib/zoom_us/users.rb, line 1197 def user_token(user_id, opts = {}) data, _status_code, _headers = user_token_with_http_info(user_id, opts) data end
Get a User Token Retrieve a user's token.<br><br> This token is used for starting meetings with the Client SDK.<br> Scopes: `user:read:admin` `user:read`<br> If a user signed into Zoom using Google or Facebook, a null value will be returned for the token. To get the token with this API, ask the user to sign into Zoom using their email and password instead. @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @option opts [String] :type User token types:<br>`token` - Used for starting meetings with the client SDK.<br>`zpk` - Used for generating the start meeting URL (Deprecated).<br>`zak` - Used for generating the start meeting URL. The token expiration time is two hours. For API users, the expiration time is 90 days. @return [Array<(InlineResponse20051, Fixnum, Hash)>] InlineResponse20051 data, response status code and response headers
# File lib/zoom_us/users.rb, line 1208 def user_token_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_token ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_token" end if @api_client.config.client_side_validation && opts[:'type'] && !['token', 'zpk', 'zak'].include?(opts[:'type']) fail ArgumentError, 'invalid value for "type", must be one of token, zpk, zak' end # resource path local_var_path = '/users/{userId}/token'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20051') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update User Update information on a user's Zoom [profile](
# File lib/zoom_us/users.rb, line 1258
def user_update(user_id, body, opts = {})
user_update_with_http_info(user_id, body, opts)
nil
end
Update User Update information on a user's Zoom [profile](support.zoom.us/hc/en-us/articles/201363203-My-Profile).<br><br> Scopes: `user:write:admin` `user:write`<br> @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param body User @param [Hash] opts the optional parameters @option opts [String] :login_type `0` - Facebook.<br>`1` - Google.<br>`99` - API.<br>`100` - Zoom.<br>`101` - SSO. @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/zoom_us/users.rb, line 1270 def user_update_with_http_info(user_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_update ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_update" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.user_update" end if @api_client.config.client_side_validation && opts[:'login_type'] && !['0', '1', '99', '100', '101'].include?(opts[:'login_type']) fail ArgumentError, 'invalid value for "login_type", must be one of 0, 1, 99, 100, 101' end # resource path local_var_path = '/users/{userId}'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} query_params[:'login_type'] = opts[:'login_type'] if !opts[:'login_type'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Check a User's PM Room Name A personal meeting room is a virtual meeting room that can be permanently assigned to a user. Use this API to check if a personal meeting room with the given name exists or not.
Scopes: `user:read:admin` `user:read`
@param vanity_name Personal meeting room name. @param [Hash] opts the optional parameters @return [InlineResponse20053]
# File lib/zoom_us/users.rb, line 1321 def user_vanity_name(vanity_name, opts = {}) data, _status_code, _headers = user_vanity_name_with_http_info(vanity_name, opts) data end
Check a User's PM Room Name A personal meeting room is a virtual meeting room that can be permanently assigned to a user. Use this API to check if a personal meeting room with the given name exists or not.<br><br> Scopes: `user:read:admin` `user:read`<br> @param vanity_name Personal meeting room name. @param [Hash] opts the optional parameters @return [Array<(InlineResponse20053, Fixnum, Hash)>] InlineResponse20053 data, response status code and response headers
# File lib/zoom_us/users.rb, line 1331 def user_vanity_name_with_http_info(vanity_name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_vanity_name ...' end # verify the required parameter 'vanity_name' is set if @api_client.config.client_side_validation && vanity_name.nil? fail ArgumentError, "Missing the required parameter 'vanity_name' when calling UsersApi.user_vanity_name" end # resource path local_var_path = '/users/vanity_name' # query parameters query_params = {} query_params[:'vanity_name'] = vanity_name # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20053') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_vanity_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a User A Zoom account can have one or more users. Use this API to view information of a specific user on a Zoom account.<br><br> Scopes: `user:read:admin` `user:read`<br> <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note: </b>If a user's status is pending, only `id` and `created_at` fields will be returned. The value of `created_at` will be the time at which the API call was made until the user activates their account.</p> @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId. @param [Hash] opts the optional parameters @option opts [String] :login_type `0` - Facebook.<br>`1` - Google.<br>`99` - API.<br>`100` - Zoom.<br>`101` - SSO. @return [Array<(InlineResponse20047, Fixnum, Hash)>] InlineResponse20047 data, response status code and response headers
# File lib/zoom_us/users.rb, line 101 def user_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user" end if @api_client.config.client_side_validation && opts[:'login_type'] && !['0', '1', '99', '100', '101'].include?(opts[:'login_type']) fail ArgumentError, 'invalid value for "login_type", must be one of 0, 1, 99, 100, 101' end # resource path local_var_path = '/users/{userId}'.sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} query_params[:'login_type'] = opts[:'login_type'] if !opts[:'login_type'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20047') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Verify a User's zpk (Deprecated) <p style="background-color:#e1f5fe; color:#01579b">Note: We will stop supporting this API from September 30, 2019. </p> Check if the zpk is expired. The zpk object is used to authenticate a user.
Scopes: `user:read:admin` `user:read` @param zpk User zpk. @param [Hash] opts the optional parameters @return [Object]
# File lib/zoom_us/users.rb, line 1376 def user_zpk(zpk, opts = {}) data, _status_code, _headers = user_zpk_with_http_info(zpk, opts) data end
Verify a User's zpk (Deprecated) <p style="background-color:#e1f5fe; color:#01579b">Note: We will stop supporting this API from <b>September 30, 2019</b>. </p> Check if the zpk is expired. The zpk object is used to authenticate a user.<br><br> Scopes: `user:read:admin` `user:read` @param zpk User zpk. @param [Hash] opts the optional parameters @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
# File lib/zoom_us/users.rb, line 1386 def user_zpk_with_http_info(zpk, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.user_zpk ...' end # verify the required parameter 'zpk' is set if @api_client.config.client_side_validation && zpk.nil? fail ArgumentError, "Missing the required parameter 'zpk' when calling UsersApi.user_zpk" end # resource path local_var_path = '/users/zpk' # query parameters query_params = {} query_params[:'zpk'] = zpk # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Object') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#user_zpk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Users
A Zoom account can have one or more users. Use this API to list users on your account.
<p style="background-color:#e1f5fe; color:#01579b; padding:8px"> Note: Starting August 18, 2019, if an account holds more than 5000 users, the response data will no longer be sorted by email.</p> Scopes: `user:read:admin`
@param [Hash] opts the optional parameters @option opts [String] :status User statuses:<br>`active` - Users
with an active status.<br>`inactive` - Users
with an inactive status.<br>`pending` - Users
with a pending status. (default to active) @option opts [Integer] :page_size The number of records returned within a single API call. (default to 30) @option opts [Integer] :page_number The current page number of returned records. (default to 1) @option opts [String] :role_id Unique identifier for the role. Provide this parameter if you would like to filter the response by a specific role. You can retrieve Role IDs from [List Roles](marketplace.zoom.us/docs/api-reference/zoom-api/roles/roles) API. @return [InlineResponse20046]
# File lib/zoom_us/users.rb, line 1434 def users(opts = {}) data, _status_code, _headers = users_with_http_info(opts) data end
List Users
A Zoom account can have one or more users. Use this API to list users on your account.<br><br> <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note: </b>Starting August 18, 2019, if an account holds more than 5000 users, the response data will no longer be sorted by email.</p> Scopes: `user:read:admin`<br> @param [Hash] opts the optional parameters @option opts [String] :status User statuses:<br>`active` - Users
with an active status.<br>`inactive` - Users
with an inactive status.<br>`pending` - Users
with a pending status. @option opts [Integer] :page_size The number of records returned within a single API call. @option opts [Integer] :page_number The current page number of returned records. @option opts [String] :role_id Unique identifier for the role. Provide this parameter if you would like to filter the response by a specific role. You can retrieve Role IDs from [List Roles](marketplace.zoom.us/docs/api-reference/zoom-api/roles/roles) API. @return [Array<(InlineResponse20046, Fixnum, Hash)>] InlineResponse20046 data, response status code and response headers
# File lib/zoom_us/users.rb, line 1447 def users_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.users ...' end if @api_client.config.client_side_validation && opts[:'status'] && !['active', 'inactive', 'pending'].include?(opts[:'status']) fail ArgumentError, 'invalid value for "status", must be one of active, inactive, pending' end if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 300 fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling UsersApi.users, must be smaller than or equal to 300.' end # resource path local_var_path = '/users' # query parameters query_params = {} query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil? query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'page_number'] = opts[:'page_number'] if !opts[:'page_number'].nil? query_params[:'role_id'] = opts[:'role_id'] if !opts[:'role_id'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20046') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end