Class: ZoomUs::Users

Inherits:
Object
  • Object
show all
Defined in:
lib/zoom_us/users.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Users

Returns a new instance of Users.



19
20
21
 
# File 'lib/zoom_us/users.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/zoom_us/users.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#switch_user_account(user_id, account_id, opts = {}) ⇒ Object

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`

Parameters:

  • user_id
  • account_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Body54)

Returns:

  • (Object) 


29
30
31
32
 
# File 'lib/zoom_us/users.rb', line 29

def (user_id, , opts = {})
  data, _status_code, _headers = (user_id, , opts)
  data
end

#switch_user_account_with_http_info(user_id, account_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Switch a User&#39;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 &#x60;me&#x60; as the value for &#x60;accountId&#x60;. In this scenario, &quot;me&quot; 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&#39;s Account ID as the value for &#x60;accountId&#x60;. 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: &#x60;user:master&#x60;&lt;br&gt;

Parameters:

  • user_id
  • account_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Body54)

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/zoom_us/users.rb', line 41

def (user_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 && .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' + '}', .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

#user(user_id, opts = {}) ⇒ InlineResponse20047

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>

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :login_type (String) —

    &#x60;0&#x60; - Facebook.&lt;br&gt;&#x60;1&#x60; - Google.&lt;br&gt;&#x60;99&#x60; - API.&lt;br&gt;&#x60;100&#x60; - Zoom.&lt;br&gt;&#x60;101&#x60; - SSO.

Returns:

  • (InlineResponse20047) 


90
91
92
93
 
# 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

#user_assistant_create(user_id, body, opts = {}) ⇒ InlineResponse20117

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`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • body —

    User assistant.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20117) 


150
151
152
153
 
# 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

#user_assistant_create_with_http_info(user_id, body, opts = {}) ⇒ Array<(InlineResponse20117, Fixnum, Hash)>

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.&lt;br&gt;Use this API to assign assistants to a user. &lt;br&gt; In the request body, provide either the User ID or the email address of the user.&lt;br&gt;&lt;br&gt; Prerequisite: * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user&#39;s account.&lt;br&gt; Scopes: &#x60;user:write:admin&#x60; &#x60;user:write&#x60;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • body —

    User assistant.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20117, Fixnum, Hash)>) —

    InlineResponse20117 data, response status code and response headers



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# 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

#user_assistant_delete(user_id, assistant_id, opts = {}) ⇒ nil

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`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • assistant_id —

    Assistant ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


210
211
212
213
 
# 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

#user_assistant_delete_with_http_info(user_id, assistant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

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.&lt;br&gt;&lt;br&gt; Prerequisites: * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user&#39;s account.&lt;br&gt; Scopes: &#x60;user:write:admin&#x60; &#x60;user:write&#x60;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • assistant_id —

    Assistant ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# 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

#user_assistants(user_id, opts = {}) ⇒ UserAssistantsList

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`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (UserAssistantsList) 


268
269
270
271
 
# 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

#user_assistants_delete(user_id, opts = {}) ⇒ nil

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`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


322
323
324
325
 
# 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

#user_assistants_delete_with_http_info(user_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete User Assistants Delete all assistants of the current user.&lt;br&gt; 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.&lt;br&gt; Prerequisite: * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user&#39;s account.&lt;br&gt; Scopes: &#x60;user:write:admin&#x60; &#x60;user:write&#x60;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# 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

#user_assistants_with_http_info(user_id, opts = {}) ⇒ Array<(UserAssistantsList, Fixnum, Hash)>

List User Assistants List a user&#39;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.&lt;br&gt;&lt;br&gt; Prerequisites: &lt;br&gt; * Current user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user&#39;s account.&lt;br&gt; Scopes: &#x60;user:read:admin&#x60; &#x60;user:read&#x60;&lt;br&gt;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UserAssistantsList, Fixnum, Hash)>) —

    UserAssistantsList data, response status code and response headers



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# 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

#user_create(body, opts = {}) ⇒ InlineResponse20116

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`

Parameters:

  • body —

    User

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20116) 


375
376
377
378
 
# 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

#user_create_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20116, Fixnum, Hash)>

Create Users A Zoom account can have one or more users. Use this API to add a new user to your account.&lt;br&gt;&lt;br&gt; Scopes: &#x60;user:write:admin&#x60; &#x60;user:write&#x60;&lt;br&gt;

Parameters:

  • body —

    User

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20116, Fixnum, Hash)>) —

    InlineResponse20116 data, response status code and response headers



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# 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

#user_delete(user_id, opts = {}) ⇒ nil

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`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :action (String) —

    Delete action options:&lt;br&gt;&#x60;disassociate&#x60; - Disassociate a user.&lt;br&gt;&#x60;delete&#x60;- Permanently delete a user.&lt;br&gt;Note: To delete pending user in the account, use &#x60;disassociate&#x60; (default to disassociate)

  • :transfer_email (String) —

    Transfer email.

  • :transfer_meeting (BOOLEAN) —

    Transfer meeting.

  • :transfer_webinar (BOOLEAN) —

    Transfer webinar.

  • :transfer_recording (BOOLEAN) —

    Transfer recording.

Returns:

  • (nil) 


434
435
436
437
 
# File 'lib/zoom_us/users.rb', line 434

def user_delete(user_id, opts = {})
  user_delete_with_http_info(user_id, opts)
  nil
end

#user_delete_with_http_info(user_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

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.&lt;br&gt;&lt;br&gt; 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&#39;s data (meetings, webinars and cloud recordings) to another user before disassociation.&lt;br&gt; To permanently delete a user, specify &quot;delete&quot; as the value of the &#x60;action&#x60; query parameter. Scopes: &#x60;user:write:admin&#x60; &#x60;user:write&#x60;&lt;br&gt;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :action (String) —

    Delete action options:&lt;br&gt;&#x60;disassociate&#x60; - Disassociate a user.&lt;br&gt;&#x60;delete&#x60;- Permanently delete a user.&lt;br&gt;Note: To delete pending user in the account, use &#x60;disassociate&#x60;

  • :transfer_email (String) —

    Transfer email.

  • :transfer_meeting (BOOLEAN) —

    Transfer meeting.

  • :transfer_webinar (BOOLEAN) —

    Transfer webinar.

  • :transfer_recording (BOOLEAN) —

    Transfer recording.

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# 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

#user_email(email, opts = {}) ⇒ InlineResponse20052

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`

Parameters:

  • email —

    The email address to be verified.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20052) 


500
501
502
503
 
# 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

#user_email_update(user_id, body, opts = {}) ⇒ nil

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.

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • body —

    User email.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


556
557
558
559
 
# 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

#user_email_update_with_http_info(user_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a User&#39;s Email Change a user&#39;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.&lt;br&gt;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.&lt;br&gt; Scopes: &#x60;user:write:admin&#x60; &#x60;user:write&#x60;&lt;br&gt; Prerequisite:&lt;br&gt; * Managed domain must be enabled in the account. * The new email address should not already exist in Zoom.

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • body —

    User email.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# 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

#user_email_with_http_info(email, opts = {}) ⇒ Array<(InlineResponse20052, Fixnum, Hash)>

Check a User Email Verify if a user&#39;s email is registered with Zoom.&lt;br&gt;&lt;br&gt; &lt;p style&#x3D;&quot;background-color:#ffffcc; color:#01579b; padding:8px&quot;&gt; &lt;b&gt;Note: &lt;/b&gt;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 &quot;existed_email&quot; parameter will be &quot;false&quot; irrespective of whether or not the user is registered with Zoom. &lt;/p&gt; Scopes: &#x60;user:read:admin&#x60; &#x60;user:read&#x60;

Parameters:

  • email —

    The email address to be verified.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20052, Fixnum, Hash)>) —

    InlineResponse20052 data, response status code and response headers



510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# 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

#user_password(user_id, body, opts = {}) ⇒ nil

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.

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • body —

    User password.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


615
616
617
618
 
# 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

#user_password_with_http_info(user_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a User&#39;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.&lt;br&gt;&lt;br&gt; Scopes: &#x60;user:write:admin&#x60; &#x60;user:write&#x60;&lt;br&gt; Prerequisites:&lt;br&gt; * Owner or admin of the Zoom account.

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • body —

    User password.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
 
# 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

#user_permission(user_id, opts = {}) ⇒ InlineResponse20048

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`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20048) 


673
674
675
676
 
# 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

#user_permission_with_http_info(user_id, opts = {}) ⇒ Array<(InlineResponse20048, Fixnum, Hash)>

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.&lt;br&gt; Use this API to get permissions that have been granted to the user.&lt;br&gt;&lt;br&gt; Scopes: &#x60;user:read:admin&#x60; &#x60;user:read&#x60;&lt;br&gt;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20048, Fixnum, Hash)>) —

    InlineResponse20048 data, response status code and response headers



683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
 
# 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

#user_picture(user_id, pic_file, opts = {}) ⇒ nil

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`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • pic_file —

    The file&#39;s path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


728
729
730
731
 
# 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

#user_picture_with_http_info(user_id, pic_file, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Upload a User&#39;s Profile Picture Upload a user&#39;s profile picture.&lt;br&gt;&lt;br&gt; Provide &#x60;multipart/form-data&#x60; as the value of the &#x60;content-type&#x60; header for this request. Scopes: &#x60;user:write:admin&#x60; &#x60;user:write&#x60;&lt;br&gt;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • pic_file —

    The file&#39;s path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
 
# 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

#user_scheduler_delete(user_id, scheduler_id, opts = {}) ⇒ nil

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`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • scheduler_id —

    Scheduler&#39;s ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


788
789
790
791
 
# 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

#user_scheduler_delete_with_http_info(user_id, scheduler_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

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.&lt;br&gt; Scopes: &#x60;user:write:admin&#x60; &#x60;user:write&#x60;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • scheduler_id —

    Scheduler&#39;s ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
 
# 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

#user_schedulers(user_id, opts = {}) ⇒ UserSchedulersList

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`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (UserSchedulersList) 


846
847
848
849
 
# 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

#user_schedulers_delete(user_id, opts = {}) ⇒ nil

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`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


900
901
902
903
 
# 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

#user_schedulers_delete_with_http_info(user_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete User Schedulers Delete all of a user&#39;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.&lt;br&gt; Scopes: &#x60;user:write:admin&#x60; &#x60;user:write&#x60;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
 
# 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

#user_schedulers_with_http_info(user_id, opts = {}) ⇒ Array<(UserSchedulersList, Fixnum, Hash)>

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.&lt;br&gt; Scopes: &#x60;user:read:admin&#x60; &#x60;user:read&#x60;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UserSchedulersList, Fixnum, Hash)>) —

    UserSchedulersList data, response status code and response headers



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
 
# 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

#user_settings(user_id, opts = {}) ⇒ Object

Get User Settings Retrieve a user’s settings.
Scopes: ‘user:read:admin` `user:read`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


955
956
957
958
 
# File 'lib/zoom_us/users.rb', line 955

def (user_id, opts = {})
  data, _status_code, _headers = (user_id, opts)
  data
end

#user_settings_update(body, user_id, opts = {}) ⇒ nil

Update User Settings Update a user’s settings.
Scopes: ‘user:write:admin` `user:write`

Parameters:

  • body —

    User Settings

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :option (String)

Returns:

  • (nil) 


1021
1022
1023
1024
 
# File 'lib/zoom_us/users.rb', line 1021

def (body, user_id, opts = {})
  (body, user_id, opts)
  nil
end

#user_settings_update_with_http_info(body, user_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update User Settings Update a user&#39;s settings.&lt;br&gt;&lt;br&gt; Scopes: &#x60;user:write:admin&#x60; &#x60;user:write&#x60;&lt;br&gt;

Parameters:

  • body —

    User Settings

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :option (String)

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'lib/zoom_us/users.rb', line 1033

def (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

#user_settings_with_http_info(user_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Get User Settings Retrieve a user&#39;s settings.&lt;br&gt;&lt;br&gt; Scopes: &#x60;user:read:admin&#x60; &#x60;user:read&#x60;&lt;br&gt;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
 
# File 'lib/zoom_us/users.rb', line 967

def (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

#user_sso_token_delete(user_id, opts = {}) ⇒ nil

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`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1084
1085
1086
1087
 
# 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

#user_sso_token_delete_with_http_info(user_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Revoke a User&#39;s SSO Token Revoke a user&#39;s SSO token.&lt;br&gt;&lt;br&gt; After calling this API, the SSO user will be logged out of their current Zoom session.&lt;br&gt; Scopes: &#x60;user:write:admin&#x60; &#x60;user:write&#x60;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
 
# 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

#user_status(user_id, body, opts = {}) ⇒ nil

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`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • body —

    User status.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1138
1139
1140
1141
 
# 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

#user_status_with_http_info(user_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

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.&lt;br&gt; 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 .&lt;br&gt;&lt;br&gt;Scopes: &#x60;user:write:admin&#x60; &#x60;user:write&#x60;&lt;br&gt;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • body —

    User status.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# 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

#user_token(user_id, opts = {}) ⇒ InlineResponse20051

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.

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :type (String) —

    User token types:&lt;br&gt;&#x60;token&#x60; - Used for starting meetings with the client SDK.&lt;br&gt;&#x60;zpk&#x60; - Used for generating the start meeting URL (Deprecated).&lt;br&gt;&#x60;zak&#x60; - Used for generating the start meeting URL. The token expiration time is two hours. For API users, the expiration time is 90 days.

Returns:

  • (InlineResponse20051) 


1197
1198
1199
1200
 
# 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

#user_token_with_http_info(user_id, opts = {}) ⇒ Array<(InlineResponse20051, Fixnum, Hash)>

Get a User Token Retrieve a user&#39;s token.&lt;br&gt;&lt;br&gt; This token is used for starting meetings with the Client SDK.&lt;br&gt; Scopes: &#x60;user:read:admin&#x60; &#x60;user:read&#x60;&lt;br&gt; 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.

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :type (String) —

    User token types:&lt;br&gt;&#x60;token&#x60; - Used for starting meetings with the client SDK.&lt;br&gt;&#x60;zpk&#x60; - Used for generating the start meeting URL (Deprecated).&lt;br&gt;&#x60;zak&#x60; - Used for generating the start meeting URL. The token expiration time is two hours. For API users, the expiration time is 90 days.

Returns:

  • (Array<(InlineResponse20051, Fixnum, Hash)>) —

    InlineResponse20051 data, response status code and response headers



1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
 
# 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

#user_update(user_id, body, opts = {}) ⇒ nil

Update User Update information on a user’s Zoom [profile](support.zoom.us/hc/en-us/articles/201363203-My-Profile).
Scopes: ‘user:write:admin` `user:write`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • body —

    User

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :login_type (String) —

    &#x60;0&#x60; - Facebook.&lt;br&gt;&#x60;1&#x60; - Google.&lt;br&gt;&#x60;99&#x60; - API.&lt;br&gt;&#x60;100&#x60; - Zoom.&lt;br&gt;&#x60;101&#x60; - SSO.

Returns:

  • (nil) 


1258
1259
1260
1261
 
# 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

#user_update_with_http_info(user_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update User Update information on a user&#39;s Zoom [profile](support.zoom.us/hc/en-us/articles/201363203-My-Profile).&lt;br&gt;&lt;br&gt; Scopes: &#x60;user:write:admin&#x60; &#x60;user:write&#x60;&lt;br&gt;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • body —

    User

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :login_type (String) —

    &#x60;0&#x60; - Facebook.&lt;br&gt;&#x60;1&#x60; - Google.&lt;br&gt;&#x60;99&#x60; - API.&lt;br&gt;&#x60;100&#x60; - Zoom.&lt;br&gt;&#x60;101&#x60; - SSO.

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# 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

#user_vanity_name(vanity_name, opts = {}) ⇒ InlineResponse20053

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`

Parameters:

  • vanity_name —

    Personal meeting room name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20053) 


1321
1322
1323
1324
 
# 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

#user_vanity_name_with_http_info(vanity_name, opts = {}) ⇒ Array<(InlineResponse20053, Fixnum, Hash)>

Check a User&#39;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.&lt;br&gt;&lt;br&gt; Scopes: &#x60;user:read:admin&#x60; &#x60;user:read&#x60;&lt;br&gt;

Parameters:

  • vanity_name —

    Personal meeting room name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20053, Fixnum, Hash)>) —

    InlineResponse20053 data, response status code and response headers



1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# 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

#user_with_http_info(user_id, opts = {}) ⇒ Array<(InlineResponse20047, Fixnum, Hash)>

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.&lt;br&gt;&lt;br&gt; Scopes: &#x60;user:read:admin&#x60; &#x60;user:read&#x60;&lt;br&gt; &lt;p style&#x3D;&quot;background-color:#e1f5fe; color:#01579b; padding:8px&quot;&gt; &lt;b&gt;Note: &lt;/b&gt;If a user&#39;s status is pending, only &#x60;id&#x60; and &#x60;created_at&#x60; fields will be returned. The value of &#x60;created_at&#x60; will be the time at which the API call was made until the user activates their account.&lt;/p&gt;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :login_type (String) —

    &#x60;0&#x60; - Facebook.&lt;br&gt;&#x60;1&#x60; - Google.&lt;br&gt;&#x60;99&#x60; - API.&lt;br&gt;&#x60;100&#x60; - Zoom.&lt;br&gt;&#x60;101&#x60; - SSO.

Returns:

  • (Array<(InlineResponse20047, Fixnum, Hash)>) —

    InlineResponse20047 data, response status code and response headers



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# 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

#user_zpk(zpk, opts = {}) ⇒ Object

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`

Parameters:

  • zpk —

    User zpk.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


1376
1377
1378
1379
 
# 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

#user_zpk_with_http_info(zpk, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Verify a User&#39;s zpk (Deprecated) &lt;p style&#x3D;&quot;background-color:#e1f5fe; color:#01579b&quot;&gt;Note: We will stop supporting this API from &lt;b&gt;September 30, 2019&lt;/b&gt;. &lt;/p&gt; Check if the zpk is expired. The zpk object is used to authenticate a user.&lt;br&gt;&lt;br&gt; Scopes: &#x60;user:read:admin&#x60; &#x60;user:read&#x60;

Parameters:

  • zpk —

    User zpk.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
 
# 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

#users(opts = {}) ⇒ InlineResponse20046

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`

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :status (String) —

    User statuses:&lt;br&gt;&#x60;active&#x60; - Users with an active status.&lt;br&gt;&#x60;inactive&#x60; - Users with an inactive status.&lt;br&gt;&#x60;pending&#x60; - Users with a pending status. (default to active)

  • :page_size (Integer) —

    The number of records returned within a single API call. (default to 30)

  • :page_number (Integer) —

    The current page number of returned records. (default to 1)

  • :role_id (String) —

    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.

Returns:

  • (InlineResponse20046) 


1434
1435
1436
1437
 
# File 'lib/zoom_us/users.rb', line 1434

def users(opts = {})
  data, _status_code, _headers = users_with_http_info(opts)
  data
end

#users_with_http_info(opts = {}) ⇒ Array<(InlineResponse20046, Fixnum, Hash)>

List Users A Zoom account can have one or more users. Use this API to list users on your account.&lt;br&gt;&lt;br&gt; &lt;p style&#x3D;&quot;background-color:#e1f5fe; color:#01579b; padding:8px&quot;&gt; &lt;b&gt;Note: &lt;/b&gt;Starting August 18, 2019, if an account holds more than 5000 users, the response data will no longer be sorted by email.&lt;/p&gt; Scopes: &#x60;user:read:admin&#x60;&lt;br&gt;

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :status (String) —

    User statuses:&lt;br&gt;&#x60;active&#x60; - Users with an active status.&lt;br&gt;&#x60;inactive&#x60; - Users with an inactive status.&lt;br&gt;&#x60;pending&#x60; - Users with a pending status.

  • :page_size (Integer) —

    The number of records returned within a single API call.

  • :page_number (Integer) —

    The current page number of returned records.

  • :role_id (String) —

    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.

Returns:

  • (Array<(InlineResponse20046, Fixnum, Hash)>) —

    InlineResponse20046 data, response status code and response headers



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
 
# 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