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.



7
8
9
 
# File 'lib/purecloud/api/authorization_api.rb', line 7

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/purecloud/api/authorization_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#create_roles(opts = {}) ⇒ DomainOrganizationRole

Create an organization role.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



270
271
272
273
 
# File 'lib/purecloud/api/authorization_api.rb', line 270

def create_roles(opts = {})
  data, status_code, headers = create_roles_with_http_info(opts)
  return data
end

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

Returns:



386
387
388
389
 
# File 'lib/purecloud/api/authorization_api.rb', line 386

def create_roles_default(opts = {})
  data, status_code, headers = create_roles_default_with_http_info(opts)
  return data
end

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



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/purecloud/api/authorization_api.rb', line 396

def create_roles_default_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#create_roles_default ..."
  end
  
  # resource path
  path = "/api/v1/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, 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#create_roles_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_roles_left_role_comparedefault_by_right_role_id(left_role_id, right_role_id, 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

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

    the optional parameters

Options Hash (opts):

Returns:



513
514
515
516
 
# File 'lib/purecloud/api/authorization_api.rb', line 513

def create_roles_left_role_comparedefault_by_right_role_id(left_role_id, right_role_id, opts = {})
  data, status_code, headers = create_roles_left_role_comparedefault_by_right_role_id_with_http_info(left_role_id, right_role_id, opts)
  return data
end

#create_roles_left_role_comparedefault_by_right_role_id_with_http_info(left_role_id, right_role_id, 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

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

    the optional parameters

Options Hash (opts):

Returns:

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

    DomainOrgRoleDifference data, response status code and response headers



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
563
564
565
566
567
568
569
570
571
572
 
# File 'lib/purecloud/api/authorization_api.rb', line 525

def create_roles_left_role_comparedefault_by_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#create_roles_left_role_comparedefault_by_right_role_id ..."
  end
  
  # verify the required parameter 'left_role_id' is set
  fail "Missing the required parameter 'left_role_id' when calling create_roles_left_role_comparedefault_by_right_role_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 create_roles_left_role_comparedefault_by_right_role_id" if right_role_id.nil?
  
  # resource path
  path = "/api/v1/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(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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#create_roles_left_role_comparedefault_by_right_role_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create an organization role.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    DomainOrganizationRole data, response status code and response headers



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/purecloud/api/authorization_api.rb', line 280

def create_roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#create_roles ..."
  end
  
  # resource path
  path = "/api/v1/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(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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#create_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete an organization role.

Parameters:

  • role_id —

    Role ID

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

    the optional parameters

Returns:

  • (nil) 


703
704
705
706
 
# File 'lib/purecloud/api/authorization_api.rb', line 703

def delete_role(role_id, opts = {})
  delete_role_with_http_info(role_id, opts)
  return nil
end

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



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
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/purecloud/api/authorization_api.rb', line 713

def delete_role_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#delete_role ..."
  end
  
  # verify the required parameter 'role_id' is set
  fail "Missing the required parameter 'role_id' when calling delete_role" if role_id.nil?
  
  # resource path
  path = "/api/v1/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, 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_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) 


1076
1077
1078
1079
 
# File 'lib/purecloud/api/authorization_api.rb', line 1076

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



1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
 
# File 'lib/purecloud/api/authorization_api.rb', line 1086

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 "Missing the required parameter 'user_id' when calling delete_user_roles" if user_id.nil?
  
  # resource path
  path = "/api/v1/authorization/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, 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_licenses(opts = {}) ⇒ DomainLicenseEntityListing

Retrieve a list of all licenses 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:



17
18
19
20
 
# File 'lib/purecloud/api/authorization_api.rb', line 17

def get_licenses(opts = {})
  data, status_code, headers = get_licenses_with_http_info(opts)
  return data
end

#get_licenses_with_http_info(opts = {}) ⇒ Array<(DomainLicenseEntityListing, Fixnum, Hash)>

Retrieve a list of all licenses 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:

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

    DomainLicenseEntityListing data, response status code and response headers



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/purecloud/api/authorization_api.rb', line 28

def get_licenses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#get_licenses ..."
  end
  
  # resource path
  path = "/api/v1/authorization/licenses".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, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DomainLicenseEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationApi#get_licenses\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

  • :page_number (Integer) —

    Page number

Returns:



79
80
81
82
 
# File 'lib/purecloud/api/authorization_api.rb', line 79

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:



90
91
92
93
94
95
96
97
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
 
# File 'lib/purecloud/api/authorization_api.rb', line 90

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
  path = "/api/v1/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, 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:



139
140
141
142
 
# File 'lib/purecloud/api/authorization_api.rb', line 139

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:



148
149
150
151
152
153
154
155
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
 
# File 'lib/purecloud/api/authorization_api.rb', line 148

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
  path = "/api/v1/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, 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_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:



579
580
581
582
 
# File 'lib/purecloud/api/authorization_api.rb', line 579

def get_role(role_id, opts = {})
  data, status_code, headers = get_role_with_http_info(role_id, opts)
  return data
end

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



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
628
629
630
631
632
633
 
# File 'lib/purecloud/api/authorization_api.rb', line 589

def get_role_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#get_role ..."
  end
  
  # verify the required parameter 'role_id' is set
  fail "Missing the required parameter 'role_id' when calling get_role" if role_id.nil?
  
  # resource path
  path = "/api/v1/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, 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_role\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

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

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

Returns:



201
202
203
204
 
# File 'lib/purecloud/api/authorization_api.rb', line 201

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

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



446
447
448
449
 
# File 'lib/purecloud/api/authorization_api.rb', line 446

def get_roles_left_role_comparedefault_by_right_role_id(left_role_id, right_role_id, opts = {})
  data, status_code, headers = get_roles_left_role_comparedefault_by_right_role_id_with_http_info(left_role_id, right_role_id, opts)
  return data
end

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



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/purecloud/api/authorization_api.rb', line 457

def get_roles_left_role_comparedefault_by_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_roles_left_role_comparedefault_by_right_role_id ..."
  end
  
  # verify the required parameter 'left_role_id' is set
  fail "Missing the required parameter 'left_role_id' when calling get_roles_left_role_comparedefault_by_right_role_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_left_role_comparedefault_by_right_role_id" if right_role_id.nil?
  
  # resource path
  path = "/api/v1/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, 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_left_role_comparedefault_by_right_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<String>) —

    variable name requested by expand list

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

Returns:



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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/purecloud/api/authorization_api.rb', line 216

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
  path = "/api/v1/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[:'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, 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_roles(user_id, opts = {}) ⇒ UserAuthorization

Get the list of roles for a user.

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:



952
953
954
955
 
# File 'lib/purecloud/api/authorization_api.rb', line 952

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

Get the list of roles 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



962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'lib/purecloud/api/authorization_api.rb', line 962

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 "Missing the required parameter 'user_id' when calling get_user_roles" if user_id.nil?
  
  # resource path
  path = "/api/v1/authorization/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, 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_role(role_id, opts = {}) ⇒ DomainOrganizationRole

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

Parameters:

  • role_id —

    Role ID

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

    the optional parameters

Options Hash (opts):

Returns:



764
765
766
767
 
# File 'lib/purecloud/api/authorization_api.rb', line 764

def patch_role(role_id, opts = {})
  data, status_code, headers = patch_role_with_http_info(role_id, opts)
  return data
end

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

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

Parameters:

  • role_id —

    Role ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    DomainOrganizationRole data, response status code and response headers



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
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
 
# File 'lib/purecloud/api/authorization_api.rb', line 775

def patch_role_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#patch_role ..."
  end
  
  # verify the required parameter 'role_id' is set
  fail "Missing the required parameter 'role_id' when calling patch_role" if role_id.nil?
  
  # resource path
  path = "/api/v1/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(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, 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_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update an organization role. Update

Parameters:

  • role_id —

    Role ID

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

    the optional parameters

Options Hash (opts):

Returns:



641
642
643
644
 
# File 'lib/purecloud/api/authorization_api.rb', line 641

def update_role(role_id, opts = {})
  data, status_code, headers = update_role_with_http_info(role_id, opts)
  return data
end

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

Sets the users for the role

Parameters:

  • role_id —

    Role ID

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>)

Returns:

  • (Array<String>) 


827
828
829
830
 
# File 'lib/purecloud/api/authorization_api.rb', line 827

def update_role_users_add(role_id, opts = {})
  data, status_code, headers = update_role_users_add_with_http_info(role_id, opts)
  return data
end

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

Sets the users for the role

Parameters:

  • role_id —

    Role ID

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>)

Returns:

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

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



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
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
 
# File 'lib/purecloud/api/authorization_api.rb', line 838

def update_role_users_add_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#update_role_users_add ..."
  end
  
  # verify the required parameter 'role_id' is set
  fail "Missing the required parameter 'role_id' when calling update_role_users_add" if role_id.nil?
  
  # resource path
  path = "/api/v1/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(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_role_users_add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Removes the users from the role

Parameters:

  • role_id —

    Role ID

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>)

Returns:

  • (Array<String>) 


890
891
892
893
 
# File 'lib/purecloud/api/authorization_api.rb', line 890

def update_role_users_remove(role_id, opts = {})
  data, status_code, headers = update_role_users_remove_with_http_info(role_id, opts)
  return data
end

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

Removes the users from the role

Parameters:

  • role_id —

    Role ID

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>)

Returns:

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

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



901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'lib/purecloud/api/authorization_api.rb', line 901

def update_role_users_remove_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#update_role_users_remove ..."
  end
  
  # verify the required parameter 'role_id' is set
  fail "Missing the required parameter 'role_id' when calling update_role_users_remove" if role_id.nil?
  
  # resource path
  path = "/api/v1/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(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_role_users_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update an organization role. Update

Parameters:

  • role_id —

    Role ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    DomainOrganizationRole data, response status code and response headers



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
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/purecloud/api/authorization_api.rb', line 652

def update_role_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#update_role ..."
  end
  
  # verify the required parameter 'role_id' is set
  fail "Missing the required parameter 'role_id' when calling update_role" if role_id.nil?
  
  # resource path
  path = "/api/v1/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(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_roles_default(opts = {}) ⇒ OrganizationRoleEntityListing

Restore specified default roles

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



328
329
330
331
 
# File 'lib/purecloud/api/authorization_api.rb', line 328

def update_roles_default(opts = {})
  data, status_code, headers = update_roles_default_with_http_info(opts)
  return data
end

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

Restore specified default roles

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/purecloud/api/authorization_api.rb', line 338

def update_roles_default_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#update_roles_default ..."
  end
  
  # resource path
  path = "/api/v1/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(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_roles_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_user_roles(user_id, opts = {}) ⇒ Array<String>

Sets the user&#39;s roles

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>)

Returns:

  • (Array<String>) 


1014
1015
1016
1017
 
# File 'lib/purecloud/api/authorization_api.rb', line 1014

def update_user_roles(user_id, opts = {})
  data, status_code, headers = update_user_roles_with_http_info(user_id, opts)
  return data
end

#update_user_roles_with_http_info(user_id, opts = {}) ⇒ Array<(Array<String>, Fixnum, Hash)>

Sets the user&#39;s roles

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>)

Returns:

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

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



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
 
# File 'lib/purecloud/api/authorization_api.rb', line 1025

def update_user_roles_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthorizationApi#update_user_roles ..."
  end
  
  # verify the required parameter 'user_id' is set
  fail "Missing the required parameter 'user_id' when calling update_user_roles" if user_id.nil?
  
  # resource path
  path = "/api/v1/authorization/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(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end