Class: PureCloud::AuthorizationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/api/authorization_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_authorization_role(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/purecloudplatformclientv2/api/authorization_api.rb', line 32

def delete_authorization_role(role_id, opts = {})
  delete_authorization_role_with_http_info(role_id, opts)
  return nil
end

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

def delete_authorization_role_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi.delete_authorization_role ..."
  end
  # verify the required parameter 'role_id' is set
  fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.delete_authorization_role" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_authorization_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_user_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) 


88
89
90
91
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 88

def delete_user_roles(user_id, opts = {})
  delete_user_roles_with_http_info(user_id, opts)
  return nil
end

#delete_user_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



98
99
100
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
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 98

def delete_user_roles_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi.delete_user_roles ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthorizationApi.delete_user_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_authorization_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:



145
146
147
148
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 145

def get_authorization_permissions(opts = {})
  data, _status_code, _headers = get_authorization_permissions_with_http_info(opts)
  return data
end

#get_authorization_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:



156
157
158
159
160
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
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 156

def get_authorization_permissions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_authorization_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_authorization_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:



202
203
204
205
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 202

def get_authorization_products(opts = {})
  data, _status_code, _headers = get_authorization_products_with_http_info(opts)
  return data
end

#get_authorization_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:



211
212
213
214
215
216
217
218
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
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 211

def get_authorization_products_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_authorization_products\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_authorization_role(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:



256
257
258
259
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 256

def get_authorization_role(role_id, opts = {})
  data, _status_code, _headers = get_authorization_role_with_http_info(role_id, opts)
  return data
end

#get_authorization_role_comparedefault_right_role_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:



314
315
316
317
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 314

def get_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id, opts = {})
  data, _status_code, _headers = get_authorization_role_comparedefault_right_role_id_with_http_info(left_role_id, right_role_id, opts)
  return data
end

#get_authorization_role_comparedefault_right_role_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



325
326
327
328
329
330
331
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
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 325

def get_authorization_role_comparedefault_right_role_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_authorization_role_comparedefault_right_role_id ..."
  end
  # verify the required parameter 'left_role_id' is set
  fail ArgumentError, "Missing the required parameter 'left_role_id' when calling AuthorizationApi.get_authorization_role_comparedefault_right_role_id" if left_role_id.nil?
  # verify the required parameter 'right_role_id' is set
  fail ArgumentError, "Missing the required parameter 'right_role_id' when calling AuthorizationApi.get_authorization_role_comparedefault_right_role_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_authorization_role_comparedefault_right_role_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_authorization_role_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



266
267
268
269
270
271
272
273
274
275
276
277
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
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 266

def get_authorization_role_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_role ..."
  end
  # verify the required parameter 'role_id' is set
  fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.get_authorization_role" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_authorization_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_authorization_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:



381
382
383
384
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 381

def get_authorization_roles(opts = {})
  data, _status_code, _headers = get_authorization_roles_with_http_info(opts)
  return data
end

#get_authorization_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:



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
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 398

def get_authorization_roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_authorization_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_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:



451
452
453
454
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 451

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

#get_user_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



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
495
496
497
498
499
500
501
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 461

def get_user_roles_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi.get_user_roles ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthorizationApi.get_user_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_authorization_role(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:



509
510
511
512
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 509

def patch_authorization_role(role_id, body, opts = {})
  data, _status_code, _headers = patch_authorization_role_with_http_info(role_id, body, opts)
  return data
end

#patch_authorization_role_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



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
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 520

def patch_authorization_role_with_http_info(role_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi.patch_authorization_role ..."
  end
  # verify the required parameter 'role_id' is set
  fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.patch_authorization_role" if role_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.patch_authorization_role" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_authorization_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_authorization_role_comparedefault_right_role_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:



571
572
573
574
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 571

def post_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id, body, opts = {})
  data, _status_code, _headers = post_authorization_role_comparedefault_right_role_id_with_http_info(left_role_id, right_role_id, body, opts)
  return data
end

#post_authorization_role_comparedefault_right_role_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



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
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 583

def post_authorization_role_comparedefault_right_role_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_authorization_role_comparedefault_right_role_id ..."
  end
  # verify the required parameter 'left_role_id' is set
  fail ArgumentError, "Missing the required parameter 'left_role_id' when calling AuthorizationApi.post_authorization_role_comparedefault_right_role_id" if left_role_id.nil?
  # verify the required parameter 'right_role_id' is set
  fail ArgumentError, "Missing the required parameter 'right_role_id' when calling AuthorizationApi.post_authorization_role_comparedefault_right_role_id" if right_role_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.post_authorization_role_comparedefault_right_role_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_authorization_role_comparedefault_right_role_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create an organization role.

Parameters:

  • body —

    Organization role

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

    the optional parameters

Returns:



634
635
636
637
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 634

def post_authorization_roles(body, opts = {})
  data, _status_code, _headers = post_authorization_roles_with_http_info(body, opts)
  return data
end

#post_authorization_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:



691
692
693
694
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 691

def post_authorization_roles_default(opts = {})
  data, _status_code, _headers = post_authorization_roles_default_with_http_info(opts)
  return data
end

#post_authorization_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&#x3D;true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force&#x3D;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:



701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 701

def post_authorization_roles_default_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi.post_authorization_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_authorization_roles_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_authorization_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



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 644

def post_authorization_roles_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi.post_authorization_roles ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.post_authorization_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_authorization_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_authorization_role(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:



748
749
750
751
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 748

def put_authorization_role(role_id, body, opts = {})
  data, _status_code, _headers = put_authorization_role_with_http_info(role_id, body, opts)
  return data
end

#put_authorization_role_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>) 


809
810
811
812
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 809

def put_authorization_role_users_add(role_id, body, opts = {})
  data, _status_code, _headers = put_authorization_role_users_add_with_http_info(role_id, body, opts)
  return data
end

#put_authorization_role_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



820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 820

def put_authorization_role_users_add_with_http_info(role_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi.put_authorization_role_users_add ..."
  end
  # verify the required parameter 'role_id' is set
  fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.put_authorization_role_users_add" if role_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.put_authorization_role_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_authorization_role_users_add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_authorization_role_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>) 


870
871
872
873
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 870

def put_authorization_role_users_remove(role_id, body, opts = {})
  data, _status_code, _headers = put_authorization_role_users_remove_with_http_info(role_id, body, opts)
  return data
end

#put_authorization_role_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



881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 881

def put_authorization_role_users_remove_with_http_info(role_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi.put_authorization_role_users_remove ..."
  end
  # verify the required parameter 'role_id' is set
  fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.put_authorization_role_users_remove" if role_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.put_authorization_role_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_authorization_role_users_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_authorization_role_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



759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 759

def put_authorization_role_with_http_info(role_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi.put_authorization_role ..."
  end
  # verify the required parameter 'role_id' is set
  fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.put_authorization_role" if role_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.put_authorization_role" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_authorization_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Restore specified default roles

Parameters:

  • body —

    Organization roles list

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

    the optional parameters

Returns:



930
931
932
933
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 930

def put_authorization_roles_default(body, opts = {})
  data, _status_code, _headers = put_authorization_roles_default_with_http_info(body, opts)
  return data
end

#put_authorization_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:



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
967
968
969
970
971
972
973
974
975
976
977
978
979
980
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 940

def put_authorization_roles_default_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi.put_authorization_roles_default ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.put_authorization_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_authorization_roles_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_user_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:



988
989
990
991
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 988

def put_user_roles(user_id, body, opts = {})
  data, _status_code, _headers = put_user_roles_with_http_info(user_id, body, opts)
  return data
end

#put_user_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



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
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
 
# File 'lib/purecloudplatformclientv2/api/authorization_api.rb', line 999

def put_user_roles_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi.put_user_roles ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthorizationApi.put_user_roles" if user_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.put_user_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end