Class: PureCloud::AuthorizationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/api/authorization_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AuthorizationApi

Returns a new instance of AuthorizationApi.



23
24
25
 
# File 'lib/purecloud/api/authorization_api.rb', line 23

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloud/api/authorization_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_roles_role_id(role_id, opts = {}) ⇒ nil

Delete an organization role.

Parameters:

  • role_id —

    Role ID

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

    the optional parameters

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/purecloud/api/authorization_api.rb', line 32

def delete_roles_role_id(role_id, opts = {})
  delete_roles_role_id_with_http_info(role_id, opts)
  return nil
end

#delete_roles_role_id_with_http_info(role_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an organization role.

Parameters:

  • role_id —

    Role ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
84
 
# File 'lib/purecloud/api/authorization_api.rb', line 42

def delete_roles_role_id_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#delete_roles_role_id ..."
  end
  
  # verify the required parameter 'role_id' is set
  fail "Missing the required parameter 'role_id' when calling delete_roles_role_id" if role_id.nil?
  
  # resource path
  local_var_path = "/api/v2/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: AuthorizationApi#delete_roles_role_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Removes all the roles from the user.

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

  • (nil) 


91
92
93
94
 
# File 'lib/purecloud/api/authorization_api.rb', line 91

def delete_user_id_roles(user_id, opts = {})
  delete_user_id_roles_with_http_info(user_id, opts)
  return nil
end

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

Removes all the roles from the user.

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

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

    nil, 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/purecloud/api/authorization_api.rb', line 101

def delete_user_id_roles_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#delete_user_id_roles ..."
  end
  
  # verify the required parameter 'user_id' is set
  fail "Missing the required parameter 'user_id' when calling delete_user_id_roles" if user_id.nil?
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: AuthorizationApi#delete_user_id_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_permissions(opts = {}) ⇒ PermissionCollectionEntityListing

Get all permissions. Retrieve a list of all permission defined in the system.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



151
152
153
154
 
# File 'lib/purecloud/api/authorization_api.rb', line 151

def get_permissions(opts = {})
  data, status_code, headers = get_permissions_with_http_info(opts)
  return data
end

#get_permissions_with_http_info(opts = {}) ⇒ Array<(PermissionCollectionEntityListing, Fixnum, Hash)>

Get all permissions. Retrieve a list of all permission defined in the system.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



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
204
 
# File 'lib/purecloud/api/authorization_api.rb', line 162

def get_permissions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#get_permissions ..."
  end
  
  # resource path
  local_var_path = "/api/v2/authorization/permissions".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'PermissionCollectionEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationApi#get_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_products(opts = {}) ⇒ OrganizationProductEntityListing

Get the list of enabled products Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.

Parameters:

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

    the optional parameters

Returns:



210
211
212
213
 
# File 'lib/purecloud/api/authorization_api.rb', line 210

def get_products(opts = {})
  data, status_code, headers = get_products_with_http_info(opts)
  return data
end

#get_products_with_http_info(opts = {}) ⇒ Array<(OrganizationProductEntityListing, Fixnum, Hash)>

Get the list of enabled products Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.

Parameters:

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

    the optional parameters

Returns:



219
220
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
 
# File 'lib/purecloud/api/authorization_api.rb', line 219

def get_products_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#get_products ..."
  end
  
  # resource path
  local_var_path = "/api/v2/authorization/products".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'OrganizationProductEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationApi#get_products\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_roles(opts = {}) ⇒ OrganizationRoleEntityListing

Retrieve a list of all roles defined for the organization

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested (default to 25)

  • :page_number (Integer) —

    The page number requested (default to 1)

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<Object>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :permission (Array<Object>)
  • :user_count (BOOLEAN) — default: default to true

Returns:



273
274
275
276
 
# File 'lib/purecloud/api/authorization_api.rb', line 273

def get_roles(opts = {})
  data, status_code, headers = get_roles_with_http_info(opts)
  return data
end

#get_roles_leftrole_id_comparedefault_rightrole_id(left_role_id, right_role_id, opts = {}) ⇒ DomainOrgRoleDifference

Get an org role to default role comparison comparison Compares any organization role to a default role id and show differences

Parameters:

  • left_role_id —

    Left Role ID

  • right_role_id —

    Right Role id

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

    the optional parameters

Returns:



346
347
348
349
 
# File 'lib/purecloud/api/authorization_api.rb', line 346

def get_roles_leftrole_id_comparedefault_rightrole_id(left_role_id, right_role_id, opts = {})
  data, status_code, headers = get_roles_leftrole_id_comparedefault_rightrole_id_with_http_info(left_role_id, right_role_id, opts)
  return data
end

#get_roles_leftrole_id_comparedefault_rightrole_id_with_http_info(left_role_id, right_role_id, opts = {}) ⇒ Array<(DomainOrgRoleDifference, Fixnum, Hash)>

Get an org role to default role comparison comparison Compares any organization role to a default role id and show differences

Parameters:

  • left_role_id —

    Left Role ID

  • right_role_id —

    Right Role id

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

    the optional parameters

Returns:

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

    DomainOrgRoleDifference data, response status code and response headers



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/purecloud/api/authorization_api.rb', line 357

def get_roles_leftrole_id_comparedefault_rightrole_id_with_http_info(left_role_id, right_role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#get_roles_leftrole_id_comparedefault_rightrole_id ..."
  end
  
  # verify the required parameter 'left_role_id' is set
  fail "Missing the required parameter 'left_role_id' when calling get_roles_leftrole_id_comparedefault_rightrole_id" if left_role_id.nil?
  
  # verify the required parameter 'right_role_id' is set
  fail "Missing the required parameter 'right_role_id' when calling get_roles_leftrole_id_comparedefault_rightrole_id" if right_role_id.nil?
  
  # resource path
  local_var_path = "/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}".sub('{format}','json').sub('{' + 'leftRoleId' + '}', left_role_id.to_s).sub('{' + 'rightRoleId' + '}', right_role_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'DomainOrgRoleDifference')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationApi#get_roles_leftrole_id_comparedefault_rightrole_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_roles_role_id(role_id, opts = {}) ⇒ DomainOrganizationRole

Get a single organization role. Get the organization role specified by its ID.

Parameters:

  • role_id —

    Role ID

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

    the optional parameters

Returns:



410
411
412
413
 
# File 'lib/purecloud/api/authorization_api.rb', line 410

def get_roles_role_id(role_id, opts = {})
  data, status_code, headers = get_roles_role_id_with_http_info(role_id, opts)
  return data
end

#get_roles_role_id_with_http_info(role_id, opts = {}) ⇒ Array<(DomainOrganizationRole, Fixnum, Hash)>

Get a single organization role. Get the organization role specified by its ID.

Parameters:

  • role_id —

    Role ID

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

    the optional parameters

Returns:

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

    DomainOrganizationRole data, response status code and response headers



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/purecloud/api/authorization_api.rb', line 420

def get_roles_role_id_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#get_roles_role_id ..."
  end
  
  # verify the required parameter 'role_id' is set
  fail "Missing the required parameter 'role_id' when calling get_roles_role_id" if role_id.nil?
  
  # resource path
  local_var_path = "/api/v2/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'DomainOrganizationRole')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationApi#get_roles_role_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_roles_with_http_info(opts = {}) ⇒ Array<(OrganizationRoleEntityListing, Fixnum, Hash)>

Retrieve a list of all roles defined for the organization

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<Object>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :permission (Array<Object>)
  • :user_count (BOOLEAN)

Returns:



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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/purecloud/api/authorization_api.rb', line 290

def get_roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#get_roles ..."
  end
  
  # resource path
  local_var_path = "/api/v2/authorization/roles".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
  query_params[:'permission'] = @api_client.build_collection_param(opts[:'permission'], :multi) if opts[:'permission']
  query_params[:'userCount'] = opts[:'user_count'] if opts[:'user_count']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'OrganizationRoleEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationApi#get_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_id_roles(user_id, opts = {}) ⇒ UserAuthorization

Returns a listing of roles and permissions for a user.

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:



470
471
472
473
 
# File 'lib/purecloud/api/authorization_api.rb', line 470

def get_user_id_roles(user_id, opts = {})
  data, status_code, headers = get_user_id_roles_with_http_info(user_id, opts)
  return data
end

#get_user_id_roles_with_http_info(user_id, opts = {}) ⇒ Array<(UserAuthorization, Fixnum, Hash)>

Returns a listing of roles and permissions for a user.

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

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

    UserAuthorization data, response status code and response headers



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/purecloud/api/authorization_api.rb', line 480

def get_user_id_roles_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#get_user_id_roles ..."
  end
  
  # verify the required parameter 'user_id' is set
  fail "Missing the required parameter 'user_id' when calling get_user_id_roles" if user_id.nil?
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'UserAuthorization')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationApi#get_user_id_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_roles_role_id(role_id, body, opts = {}) ⇒ DomainOrganizationRole

Patch Organization Role for needsUpdate Field Patch Organization Role for needsUpdate Field

Parameters:

  • role_id —

    Role ID

  • body —

    Organization role

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

    the optional parameters

Returns:



531
532
533
534
 
# File 'lib/purecloud/api/authorization_api.rb', line 531

def patch_roles_role_id(role_id, body, opts = {})
  data, status_code, headers = patch_roles_role_id_with_http_info(role_id, body, opts)
  return data
end

#patch_roles_role_id_with_http_info(role_id, body, opts = {}) ⇒ Array<(DomainOrganizationRole, Fixnum, Hash)>

Patch Organization Role for needsUpdate Field Patch Organization Role for needsUpdate Field

Parameters:

  • role_id —

    Role ID

  • body —

    Organization role

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

    the optional parameters

Returns:

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

    DomainOrganizationRole data, response status code and response headers



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
 
# File 'lib/purecloud/api/authorization_api.rb', line 542

def patch_roles_role_id_with_http_info(role_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#patch_roles_role_id ..."
  end
  
  # verify the required parameter 'role_id' is set
  fail "Missing the required parameter 'role_id' when calling patch_roles_role_id" if role_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling patch_roles_role_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  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,
    :return_type => 'DomainOrganizationRole')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationApi#patch_roles_role_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_roles(body, opts = {}) ⇒ DomainOrganizationRole

Create an organization role.

Parameters:

  • body —

    Organization role

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

    the optional parameters

Returns:



595
596
597
598
 
# File 'lib/purecloud/api/authorization_api.rb', line 595

def post_roles(body, opts = {})
  data, status_code, headers = post_roles_with_http_info(body, opts)
  return data
end

#post_roles_default(opts = {}) ⇒ OrganizationRoleEntityListing

Restores all default roles This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :force (BOOLEAN) —

    Restore default roles (default to false)

Returns:



655
656
657
658
 
# File 'lib/purecloud/api/authorization_api.rb', line 655

def post_roles_default(opts = {})
  data, status_code, headers = post_roles_default_with_http_info(opts)
  return data
end

#post_roles_default_with_http_info(opts = {}) ⇒ Array<(OrganizationRoleEntityListing, Fixnum, Hash)>

Restores all default roles This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :force (BOOLEAN) —

    Restore default roles

Returns:



665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/purecloud/api/authorization_api.rb', line 665

def post_roles_default_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#post_roles_default ..."
  end
  
  # resource path
  local_var_path = "/api/v2/authorization/roles/default".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'force'] = opts[:'force'] if opts[:'force']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'OrganizationRoleEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationApi#post_roles_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_roles_leftrole_id_comparedefault_rightrole_id(left_role_id, right_role_id, body, opts = {}) ⇒ DomainOrgRoleDifference

Get an unsaved org role to default role comparison Allows users to compare their existing roles in an unsaved state to its default role

Parameters:

  • left_role_id —

    Left Role ID

  • right_role_id —

    Right Role id

  • body —

    Organization role

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

    the optional parameters

Returns:



715
716
717
718
 
# File 'lib/purecloud/api/authorization_api.rb', line 715

def post_roles_leftrole_id_comparedefault_rightrole_id(left_role_id, right_role_id, body, opts = {})
  data, status_code, headers = post_roles_leftrole_id_comparedefault_rightrole_id_with_http_info(left_role_id, right_role_id, body, opts)
  return data
end

#post_roles_leftrole_id_comparedefault_rightrole_id_with_http_info(left_role_id, right_role_id, body, opts = {}) ⇒ Array<(DomainOrgRoleDifference, Fixnum, Hash)>

Get an unsaved org role to default role comparison Allows users to compare their existing roles in an unsaved state to its default role

Parameters:

  • left_role_id —

    Left Role ID

  • right_role_id —

    Right Role id

  • body —

    Organization role

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

    the optional parameters

Returns:

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

    DomainOrgRoleDifference data, response status code and response headers



727
728
729
730
731
732
733
734
735
736
737
738
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
 
# File 'lib/purecloud/api/authorization_api.rb', line 727

def post_roles_leftrole_id_comparedefault_rightrole_id_with_http_info(left_role_id, right_role_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#post_roles_leftrole_id_comparedefault_rightrole_id ..."
  end
  
  # verify the required parameter 'left_role_id' is set
  fail "Missing the required parameter 'left_role_id' when calling post_roles_leftrole_id_comparedefault_rightrole_id" if left_role_id.nil?
  
  # verify the required parameter 'right_role_id' is set
  fail "Missing the required parameter 'right_role_id' when calling post_roles_leftrole_id_comparedefault_rightrole_id" if right_role_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_roles_leftrole_id_comparedefault_rightrole_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}".sub('{format}','json').sub('{' + 'leftRoleId' + '}', left_role_id.to_s).sub('{' + 'rightRoleId' + '}', right_role_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  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 => 'DomainOrgRoleDifference')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationApi#post_roles_leftrole_id_comparedefault_rightrole_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_roles_with_http_info(body, opts = {}) ⇒ Array<(DomainOrganizationRole, Fixnum, Hash)>

Create an organization role.

Parameters:

  • body —

    Organization role

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

    the optional parameters

Returns:

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

    DomainOrganizationRole data, response status code and response headers



605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
 
# File 'lib/purecloud/api/authorization_api.rb', line 605

def post_roles_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#post_roles ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_roles" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/authorization/roles".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  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 => 'DomainOrganizationRole')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationApi#post_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_roles_default(body, opts = {}) ⇒ OrganizationRoleEntityListing

Restore specified default roles

Parameters:

  • body —

    Organization roles list

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

    the optional parameters

Returns:



783
784
785
786
 
# File 'lib/purecloud/api/authorization_api.rb', line 783

def put_roles_default(body, opts = {})
  data, status_code, headers = put_roles_default_with_http_info(body, opts)
  return data
end

#put_roles_default_with_http_info(body, opts = {}) ⇒ Array<(OrganizationRoleEntityListing, Fixnum, Hash)>

Restore specified default roles

Parameters:

  • body —

    Organization roles list

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

    the optional parameters

Returns:



793
794
795
796
797
798
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
 
# File 'lib/purecloud/api/authorization_api.rb', line 793

def put_roles_default_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#put_roles_default ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_roles_default" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/authorization/roles/default".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  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 => 'OrganizationRoleEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationApi#put_roles_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_roles_role_id(role_id, body, opts = {}) ⇒ DomainOrganizationRole

Update an organization role. Update

Parameters:

  • role_id —

    Role ID

  • body —

    Organization role

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

    the optional parameters

Returns:



844
845
846
847
 
# File 'lib/purecloud/api/authorization_api.rb', line 844

def put_roles_role_id(role_id, body, opts = {})
  data, status_code, headers = put_roles_role_id_with_http_info(role_id, body, opts)
  return data
end

#put_roles_role_id_users_add(role_id, body, opts = {}) ⇒ Array<String>

Sets the users for the role

Parameters:

  • role_id —

    Role ID

  • body —

    List of user IDs

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

    the optional parameters

Returns:

  • (Array<String>) 


909
910
911
912
 
# File 'lib/purecloud/api/authorization_api.rb', line 909

def put_roles_role_id_users_add(role_id, body, opts = {})
  data, status_code, headers = put_roles_role_id_users_add_with_http_info(role_id, body, opts)
  return data
end

#put_roles_role_id_users_add_with_http_info(role_id, body, opts = {}) ⇒ Array<(Array<String>, Fixnum, Hash)>

Sets the users for the role

Parameters:

  • role_id —

    Role ID

  • body —

    List of user IDs

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

    the optional parameters

Returns:

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

    Array<String> data, response status code and response headers



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
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/purecloud/api/authorization_api.rb', line 920

def put_roles_role_id_users_add_with_http_info(role_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#put_roles_role_id_users_add ..."
  end
  
  # verify the required parameter 'role_id' is set
  fail "Missing the required parameter 'role_id' when calling put_roles_role_id_users_add" if role_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_roles_role_id_users_add" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/authorization/roles/{roleId}/users/add".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  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 => 'Array<String>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationApi#put_roles_role_id_users_add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_roles_role_id_users_remove(role_id, body, opts = {}) ⇒ Array<String>

Removes the users from the role

Parameters:

  • role_id —

    Role ID

  • body —

    List of user IDs

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

    the optional parameters

Returns:

  • (Array<String>) 


974
975
976
977
 
# File 'lib/purecloud/api/authorization_api.rb', line 974

def put_roles_role_id_users_remove(role_id, body, opts = {})
  data, status_code, headers = put_roles_role_id_users_remove_with_http_info(role_id, body, opts)
  return data
end

#put_roles_role_id_users_remove_with_http_info(role_id, body, opts = {}) ⇒ Array<(Array<String>, Fixnum, Hash)>

Removes the users from the role

Parameters:

  • role_id —

    Role ID

  • body —

    List of user IDs

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

    the optional parameters

Returns:

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

    Array<String> data, response status code and response headers



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
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
 
# File 'lib/purecloud/api/authorization_api.rb', line 985

def put_roles_role_id_users_remove_with_http_info(role_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#put_roles_role_id_users_remove ..."
  end
  
  # verify the required parameter 'role_id' is set
  fail "Missing the required parameter 'role_id' when calling put_roles_role_id_users_remove" if role_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_roles_role_id_users_remove" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/authorization/roles/{roleId}/users/remove".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  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 => 'Array<String>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationApi#put_roles_role_id_users_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_roles_role_id_with_http_info(role_id, body, opts = {}) ⇒ Array<(DomainOrganizationRole, Fixnum, Hash)>

Update an organization role. Update

Parameters:

  • role_id —

    Role ID

  • body —

    Organization role

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

    the optional parameters

Returns:

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

    DomainOrganizationRole data, response status code and response headers



855
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
895
896
897
898
899
900
901
 
# File 'lib/purecloud/api/authorization_api.rb', line 855

def put_roles_role_id_with_http_info(role_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#put_roles_role_id ..."
  end
  
  # verify the required parameter 'role_id' is set
  fail "Missing the required parameter 'role_id' when calling put_roles_role_id" if role_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_roles_role_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  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 => 'DomainOrganizationRole')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationApi#put_roles_role_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_user_id_roles(user_id, body, opts = {}) ⇒ UserAuthorization

Sets the user’s roles

Parameters:

  • user_id —

    User ID

  • body —

    List of roles

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

    the optional parameters

Returns:



1039
1040
1041
1042
 
# File 'lib/purecloud/api/authorization_api.rb', line 1039

def put_user_id_roles(user_id, body, opts = {})
  data, status_code, headers = put_user_id_roles_with_http_info(user_id, body, opts)
  return data
end

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

Sets the user&#39;s roles

Parameters:

  • user_id —

    User ID

  • body —

    List of roles

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

    the optional parameters

Returns:

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

    UserAuthorization data, response status code and response headers



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
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
 
# File 'lib/purecloud/api/authorization_api.rb', line 1050

def put_user_id_roles_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#put_user_id_roles ..."
  end
  
  # verify the required parameter 'user_id' is set
  fail "Missing the required parameter 'user_id' when calling put_user_id_roles" if user_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_user_id_roles" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  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 => 'UserAuthorization')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationApi#put_user_id_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end