Class: PureCloud::OrganizationAuthorizationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/api/organization_authorization_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrganizationAuthorizationApi

Returns a new instance of OrganizationAuthorizationApi.



23
24
25
 
# File 'lib/purecloudclient_v2a/api/organization_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/purecloudclient_v2a/api/organization_authorization_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_orgauthorization_trustee(trustee_org_id, opts = {}) ⇒ nil

Delete Org Trust

Parameters:

  • trustee_org_id —

    Trustee Organization Id

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

    the optional parameters

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 32

def delete_orgauthorization_trustee(trustee_org_id, opts = {})
  delete_orgauthorization_trustee_with_http_info(trustee_org_id, opts)
  return nil
end

#delete_orgauthorization_trustee_user(trustee_org_id, trustee_user_id, opts = {}) ⇒ nil

Delete Trustee User

Parameters:

  • trustee_org_id —

    Trustee Organization Id

  • trustee_user_id —

    Trustee User Id

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

    the optional parameters

Returns:

  • (nil) 


97
98
99
100
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 97

def delete_orgauthorization_trustee_user(trustee_org_id, trustee_user_id, opts = {})
  delete_orgauthorization_trustee_user_with_http_info(trustee_org_id, trustee_user_id, opts)
  return nil
end

#delete_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id, opts = {}) ⇒ nil

Delete Trustee User Roles

Parameters:

  • trustee_org_id —

    Trustee Organization Id

  • trustee_user_id —

    Trustee User Id

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

    the optional parameters

Returns:

  • (nil) 


171
172
173
174
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 171

def delete_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id, opts = {})
  delete_orgauthorization_trustee_user_roles_with_http_info(trustee_org_id, trustee_user_id, opts)
  return nil
end

#delete_orgauthorization_trustee_user_roles_with_http_info(trustee_org_id, trustee_user_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Trustee User Roles

Parameters:

  • trustee_org_id —

    Trustee Organization Id

  • trustee_user_id —

    Trustee User Id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
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
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 182

def delete_orgauthorization_trustee_user_roles_with_http_info(trustee_org_id, trustee_user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.delete_orgauthorization_trustee_user_roles ..."
  end
  
  
  # verify the required parameter 'trustee_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_org_id' when calling OrganizationAuthorizationApi.delete_orgauthorization_trustee_user_roles" if trustee_org_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'trustee_user_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_user_id' when calling OrganizationAuthorizationApi.delete_orgauthorization_trustee_user_roles" if trustee_user_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles".sub('{format}','json').sub('{' + 'trusteeOrgId' + '}', trustee_org_id.to_s).sub('{' + 'trusteeUserId' + '}', trustee_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: OrganizationAuthorizationApi#delete_orgauthorization_trustee_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_orgauthorization_trustee_user_with_http_info(trustee_org_id, trustee_user_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Trustee User

Parameters:

  • trustee_org_id —

    Trustee Organization Id

  • trustee_user_id —

    Trustee User Id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 108

def delete_orgauthorization_trustee_user_with_http_info(trustee_org_id, trustee_user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.delete_orgauthorization_trustee_user ..."
  end
  
  
  # verify the required parameter 'trustee_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_org_id' when calling OrganizationAuthorizationApi.delete_orgauthorization_trustee_user" if trustee_org_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'trustee_user_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_user_id' when calling OrganizationAuthorizationApi.delete_orgauthorization_trustee_user" if trustee_user_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}".sub('{format}','json').sub('{' + 'trusteeOrgId' + '}', trustee_org_id.to_s).sub('{' + 'trusteeUserId' + '}', trustee_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: OrganizationAuthorizationApi#delete_orgauthorization_trustee_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_orgauthorization_trustee_with_http_info(trustee_org_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Org Trust

Parameters:

  • trustee_org_id —

    Trustee Organization Id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_orgauthorization_trustee_with_http_info(trustee_org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.delete_orgauthorization_trustee ..."
  end
  
  
  # verify the required parameter 'trustee_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_org_id' when calling OrganizationAuthorizationApi.delete_orgauthorization_trustee" if trustee_org_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustees/{trusteeOrgId}".sub('{format}','json').sub('{' + 'trusteeOrgId' + '}', trustee_org_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: OrganizationAuthorizationApi#delete_orgauthorization_trustee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_orgauthorization_trustor(trustor_org_id, opts = {}) ⇒ nil

Delete Org Trust

Parameters:

  • trustor_org_id —

    Trustor Organization Id

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

    the optional parameters

Returns:

  • (nil) 


244
245
246
247
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 244

def delete_orgauthorization_trustor(trustor_org_id, opts = {})
  delete_orgauthorization_trustor_with_http_info(trustor_org_id, opts)
  return nil
end

#delete_orgauthorization_trustor_user(trustor_org_id, trustee_user_id, opts = {}) ⇒ nil

Delete Trustee User

Parameters:

  • trustor_org_id —

    Trustor Organization Id

  • trustee_user_id —

    Trustee User Id

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

    the optional parameters

Returns:

  • (nil) 


309
310
311
312
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 309

def delete_orgauthorization_trustor_user(trustor_org_id, trustee_user_id, opts = {})
  delete_orgauthorization_trustor_user_with_http_info(trustor_org_id, trustee_user_id, opts)
  return nil
end

#delete_orgauthorization_trustor_user_with_http_info(trustor_org_id, trustee_user_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Trustee User

Parameters:

  • trustor_org_id —

    Trustor Organization Id

  • trustee_user_id —

    Trustee User Id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



320
321
322
323
324
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
368
369
370
371
372
373
374
375
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 320

def delete_orgauthorization_trustor_user_with_http_info(trustor_org_id, trustee_user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.delete_orgauthorization_trustor_user ..."
  end
  
  
  # verify the required parameter 'trustor_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustor_org_id' when calling OrganizationAuthorizationApi.delete_orgauthorization_trustor_user" if trustor_org_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'trustee_user_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_user_id' when calling OrganizationAuthorizationApi.delete_orgauthorization_trustor_user" if trustee_user_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}".sub('{format}','json').sub('{' + 'trustorOrgId' + '}', trustor_org_id.to_s).sub('{' + 'trusteeUserId' + '}', trustee_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: OrganizationAuthorizationApi#delete_orgauthorization_trustor_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_orgauthorization_trustor_with_http_info(trustor_org_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Org Trust

Parameters:

  • trustor_org_id —

    Trustor Organization Id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



254
255
256
257
258
259
260
261
262
263
264
265
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
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 254

def delete_orgauthorization_trustor_with_http_info(trustor_org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.delete_orgauthorization_trustor ..."
  end
  
  
  # verify the required parameter 'trustor_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustor_org_id' when calling OrganizationAuthorizationApi.delete_orgauthorization_trustor" if trustor_org_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustors/{trustorOrgId}".sub('{format}','json').sub('{' + 'trustorOrgId' + '}', trustor_org_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: OrganizationAuthorizationApi#delete_orgauthorization_trustor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_orgauthorization_pairing(pairing_id, opts = {}) ⇒ TrustRequest

Get Pairing Info

Parameters:

  • pairing_id —

    Pairing Id

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

    the optional parameters

Returns:



382
383
384
385
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 382

def get_orgauthorization_pairing(pairing_id, opts = {})
  data, _status_code, _headers = get_orgauthorization_pairing_with_http_info(pairing_id, opts)
  return data
end

#get_orgauthorization_pairing_with_http_info(pairing_id, opts = {}) ⇒ Array<(TrustRequest, Fixnum, Hash)>

Get Pairing Info

Parameters:

  • pairing_id —

    Pairing Id

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

    the optional parameters

Returns:

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

    TrustRequest data, response status code and response headers



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

def get_orgauthorization_pairing_with_http_info(pairing_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.get_orgauthorization_pairing ..."
  end
  
  
  # verify the required parameter 'pairing_id' is set
  fail ArgumentError, "Missing the required parameter 'pairing_id' when calling OrganizationAuthorizationApi.get_orgauthorization_pairing" if pairing_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/pairings/{pairingId}".sub('{format}','json').sub('{' + 'pairingId' + '}', pairing_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 => 'TrustRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationAuthorizationApi#get_orgauthorization_pairing\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_orgauthorization_trustee(trustee_org_id, opts = {}) ⇒ Trustee

Get Org Trust

Parameters:

  • trustee_org_id —

    Trustee Organization Id

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

    the optional parameters

Returns:



447
448
449
450
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 447

def get_orgauthorization_trustee(trustee_org_id, opts = {})
  data, _status_code, _headers = get_orgauthorization_trustee_with_http_info(trustee_org_id, opts)
  return data
end

#get_orgauthorization_trustee_user(trustee_org_id, trustee_user_id, opts = {}) ⇒ TrustUser

Get Trustee User

Parameters:

  • trustee_org_id —

    Trustee Organization Id

  • trustee_user_id —

    Trustee User Id

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

    the optional parameters

Returns:



513
514
515
516
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 513

def get_orgauthorization_trustee_user(trustee_org_id, trustee_user_id, opts = {})
  data, _status_code, _headers = get_orgauthorization_trustee_user_with_http_info(trustee_org_id, trustee_user_id, opts)
  return data
end

#get_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id, opts = {}) ⇒ UserAuthorization

Get Trustee User Roles

Parameters:

  • trustee_org_id —

    Trustee Organization Id

  • trustee_user_id —

    Trustee User Id

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

    the optional parameters

Returns:



588
589
590
591
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 588

def get_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id, opts = {})
  data, _status_code, _headers = get_orgauthorization_trustee_user_roles_with_http_info(trustee_org_id, trustee_user_id, opts)
  return data
end

#get_orgauthorization_trustee_user_roles_with_http_info(trustee_org_id, trustee_user_id, opts = {}) ⇒ Array<(UserAuthorization, Fixnum, Hash)>

Get Trustee User Roles

Parameters:

  • trustee_org_id —

    Trustee Organization Id

  • trustee_user_id —

    Trustee User Id

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

    the optional parameters

Returns:

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

    UserAuthorization data, response status code and response headers



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
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 599

def get_orgauthorization_trustee_user_roles_with_http_info(trustee_org_id, trustee_user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.get_orgauthorization_trustee_user_roles ..."
  end
  
  
  # verify the required parameter 'trustee_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_org_id' when calling OrganizationAuthorizationApi.get_orgauthorization_trustee_user_roles" if trustee_org_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'trustee_user_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_user_id' when calling OrganizationAuthorizationApi.get_orgauthorization_trustee_user_roles" if trustee_user_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles".sub('{format}','json').sub('{' + 'trusteeOrgId' + '}', trustee_org_id.to_s).sub('{' + 'trusteeUserId' + '}', trustee_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: OrganizationAuthorizationApi#get_orgauthorization_trustee_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_orgauthorization_trustee_user_with_http_info(trustee_org_id, trustee_user_id, opts = {}) ⇒ Array<(TrustUser, Fixnum, Hash)>

Get Trustee User

Parameters:

  • trustee_org_id —

    Trustee Organization Id

  • trustee_user_id —

    Trustee User Id

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

    the optional parameters

Returns:

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

    TrustUser data, response status code and response headers



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
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 524

def get_orgauthorization_trustee_user_with_http_info(trustee_org_id, trustee_user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.get_orgauthorization_trustee_user ..."
  end
  
  
  # verify the required parameter 'trustee_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_org_id' when calling OrganizationAuthorizationApi.get_orgauthorization_trustee_user" if trustee_org_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'trustee_user_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_user_id' when calling OrganizationAuthorizationApi.get_orgauthorization_trustee_user" if trustee_user_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}".sub('{format}','json').sub('{' + 'trusteeOrgId' + '}', trustee_org_id.to_s).sub('{' + 'trusteeUserId' + '}', trustee_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 => 'TrustUser')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationAuthorizationApi#get_orgauthorization_trustee_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_orgauthorization_trustee_users(trustee_org_id, opts = {}) ⇒ TrustUserEntityListing

The list of trustee users for this organization (i.e. users granted access to this organization).

Parameters:

  • trustee_org_id —

    Trustee Organization Id

  • 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:



664
665
666
667
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 664

def get_orgauthorization_trustee_users(trustee_org_id, opts = {})
  data, _status_code, _headers = get_orgauthorization_trustee_users_with_http_info(trustee_org_id, opts)
  return data
end

#get_orgauthorization_trustee_users_with_http_info(trustee_org_id, opts = {}) ⇒ Array<(TrustUserEntityListing, Fixnum, Hash)>

The list of trustee users for this organization (i.e. users granted access to this organization).

Parameters:

  • trustee_org_id —

    Trustee Organization Id

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

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

    TrustUserEntityListing data, response status code and response headers



676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
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
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 676

def get_orgauthorization_trustee_users_with_http_info(trustee_org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.get_orgauthorization_trustee_users ..."
  end
  
  
  # verify the required parameter 'trustee_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_org_id' when calling OrganizationAuthorizationApi.get_orgauthorization_trustee_users" if trustee_org_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustees/{trusteeOrgId}/users".sub('{format}','json').sub('{' + 'trusteeOrgId' + '}', trustee_org_id.to_s)

  # 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 => 'TrustUserEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationAuthorizationApi#get_orgauthorization_trustee_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_orgauthorization_trustee_with_http_info(trustee_org_id, opts = {}) ⇒ Array<(Trustee, Fixnum, Hash)>

Get Org Trust

Parameters:

  • trustee_org_id —

    Trustee Organization Id

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

    the optional parameters

Returns:

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

    Trustee 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
505
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 457

def get_orgauthorization_trustee_with_http_info(trustee_org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.get_orgauthorization_trustee ..."
  end
  
  
  # verify the required parameter 'trustee_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_org_id' when calling OrganizationAuthorizationApi.get_orgauthorization_trustee" if trustee_org_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustees/{trusteeOrgId}".sub('{format}','json').sub('{' + 'trusteeOrgId' + '}', trustee_org_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 => 'Trustee')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationAuthorizationApi#get_orgauthorization_trustee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_orgauthorization_trustees(opts = {}) ⇒ TrustEntityListing

The list of trustees for this organization (i.e. organizations granted access to this organization).

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:



746
747
748
749
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 746

def get_orgauthorization_trustees(opts = {})
  data, _status_code, _headers = get_orgauthorization_trustees_with_http_info(opts)
  return data
end

#get_orgauthorization_trustees_with_http_info(opts = {}) ⇒ Array<(TrustEntityListing, Fixnum, Hash)>

The list of trustees for this organization (i.e. organizations granted access to this organization).

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

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

    TrustEntityListing data, response status code and response headers



757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
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
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 757

def get_orgauthorization_trustees_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.get_orgauthorization_trustees ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustees".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 => 'TrustEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationAuthorizationApi#get_orgauthorization_trustees\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_orgauthorization_trustor(trustor_org_id, opts = {}) ⇒ Trustor

Get Org Trust

Parameters:

  • trustor_org_id —

    Trustor Organization Id

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

    the optional parameters

Returns:



818
819
820
821
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 818

def get_orgauthorization_trustor(trustor_org_id, opts = {})
  data, _status_code, _headers = get_orgauthorization_trustor_with_http_info(trustor_org_id, opts)
  return data
end

#get_orgauthorization_trustor_user(trustor_org_id, trustee_user_id, opts = {}) ⇒ TrustUser

Get Trustee User

Parameters:

  • trustor_org_id —

    Trustor Organization Id

  • trustee_user_id —

    Trustee User Id

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

    the optional parameters

Returns:



884
885
886
887
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 884

def get_orgauthorization_trustor_user(trustor_org_id, trustee_user_id, opts = {})
  data, _status_code, _headers = get_orgauthorization_trustor_user_with_http_info(trustor_org_id, trustee_user_id, opts)
  return data
end

#get_orgauthorization_trustor_user_with_http_info(trustor_org_id, trustee_user_id, opts = {}) ⇒ Array<(TrustUser, Fixnum, Hash)>

Get Trustee User

Parameters:

  • trustor_org_id —

    Trustor Organization Id

  • trustee_user_id —

    Trustee User Id

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

    the optional parameters

Returns:

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

    TrustUser data, response status code and response headers



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
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 895

def get_orgauthorization_trustor_user_with_http_info(trustor_org_id, trustee_user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.get_orgauthorization_trustor_user ..."
  end
  
  
  # verify the required parameter 'trustor_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustor_org_id' when calling OrganizationAuthorizationApi.get_orgauthorization_trustor_user" if trustor_org_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'trustee_user_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_user_id' when calling OrganizationAuthorizationApi.get_orgauthorization_trustor_user" if trustee_user_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}".sub('{format}','json').sub('{' + 'trustorOrgId' + '}', trustor_org_id.to_s).sub('{' + 'trusteeUserId' + '}', trustee_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 => 'TrustUser')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationAuthorizationApi#get_orgauthorization_trustor_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_orgauthorization_trustor_users(trustor_org_id, opts = {}) ⇒ TrustUserEntityListing

The list of users in the trustor organization (i.e. users granted access).

Parameters:

  • trustor_org_id —

    Trustee Organization Id

  • 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:



960
961
962
963
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 960

def get_orgauthorization_trustor_users(trustor_org_id, opts = {})
  data, _status_code, _headers = get_orgauthorization_trustor_users_with_http_info(trustor_org_id, opts)
  return data
end

#get_orgauthorization_trustor_users_with_http_info(trustor_org_id, opts = {}) ⇒ Array<(TrustUserEntityListing, Fixnum, Hash)>

The list of users in the trustor organization (i.e. users granted access).

Parameters:

  • trustor_org_id —

    Trustee Organization Id

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

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

    TrustUserEntityListing data, response status code and response headers



972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 972

def get_orgauthorization_trustor_users_with_http_info(trustor_org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.get_orgauthorization_trustor_users ..."
  end
  
  
  # verify the required parameter 'trustor_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustor_org_id' when calling OrganizationAuthorizationApi.get_orgauthorization_trustor_users" if trustor_org_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustors/{trustorOrgId}/users".sub('{format}','json').sub('{' + 'trustorOrgId' + '}', trustor_org_id.to_s)

  # 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 => 'TrustUserEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationAuthorizationApi#get_orgauthorization_trustor_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_orgauthorization_trustor_with_http_info(trustor_org_id, opts = {}) ⇒ Array<(Trustor, Fixnum, Hash)>

Get Org Trust

Parameters:

  • trustor_org_id —

    Trustor Organization Id

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

    the optional parameters

Returns:

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

    Trustor data, response status code and response headers



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
863
864
865
866
867
868
869
870
871
872
873
874
875
876
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 828

def get_orgauthorization_trustor_with_http_info(trustor_org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.get_orgauthorization_trustor ..."
  end
  
  
  # verify the required parameter 'trustor_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustor_org_id' when calling OrganizationAuthorizationApi.get_orgauthorization_trustor" if trustor_org_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustors/{trustorOrgId}".sub('{format}','json').sub('{' + 'trustorOrgId' + '}', trustor_org_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 => 'Trustor')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationAuthorizationApi#get_orgauthorization_trustor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_orgauthorization_trustors(opts = {}) ⇒ TrustorEntityListing

The list of organizations that have authorized/trusted your organization.

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:



1042
1043
1044
1045
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1042

def get_orgauthorization_trustors(opts = {})
  data, _status_code, _headers = get_orgauthorization_trustors_with_http_info(opts)
  return data
end

#get_orgauthorization_trustors_with_http_info(opts = {}) ⇒ Array<(TrustorEntityListing, Fixnum, Hash)>

The list of organizations that have authorized/trusted your organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

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

    TrustorEntityListing data, response status code and response headers



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1053

def get_orgauthorization_trustors_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.get_orgauthorization_trustors ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustors".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 => 'TrustorEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationAuthorizationApi#get_orgauthorization_trustors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_orgauthorization_pairings(body, opts = {}) ⇒ TrustRequest

A pairing id is created by the trustee and given to the trustor to create a trust.

Parameters:

  • body —

    Pairing Info

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

    the optional parameters

Returns:



1114
1115
1116
1117
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1114

def post_orgauthorization_pairings(body, opts = {})
  data, _status_code, _headers = post_orgauthorization_pairings_with_http_info(body, opts)
  return data
end

#post_orgauthorization_pairings_with_http_info(body, opts = {}) ⇒ Array<(TrustRequest, Fixnum, Hash)>

A pairing id is created by the trustee and given to the trustor to create a trust.

Parameters:

  • body —

    Pairing Info

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

    the optional parameters

Returns:

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

    TrustRequest data, response status code and response headers



1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1124

def post_orgauthorization_pairings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.post_orgauthorization_pairings ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationAuthorizationApi.post_orgauthorization_pairings" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/pairings".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 => 'TrustRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationAuthorizationApi#post_orgauthorization_pairings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_orgauthorization_trustee_users(trustee_org_id, body, opts = {}) ⇒ TrustUser

Add a user to the trust.

Parameters:

  • trustee_org_id —

    Trustee Organization Id

  • body —

    Trust

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

    the optional parameters

Returns:



1180
1181
1182
1183
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1180

def post_orgauthorization_trustee_users(trustee_org_id, body, opts = {})
  data, _status_code, _headers = post_orgauthorization_trustee_users_with_http_info(trustee_org_id, body, opts)
  return data
end

#post_orgauthorization_trustee_users_with_http_info(trustee_org_id, body, opts = {}) ⇒ Array<(TrustUser, Fixnum, Hash)>

Add a user to the trust.

Parameters:

  • trustee_org_id —

    Trustee Organization Id

  • body —

    Trust

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

    the optional parameters

Returns:

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

    TrustUser data, response status code and response headers



1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1191

def post_orgauthorization_trustee_users_with_http_info(trustee_org_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.post_orgauthorization_trustee_users ..."
  end
  
  
  # verify the required parameter 'trustee_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_org_id' when calling OrganizationAuthorizationApi.post_orgauthorization_trustee_users" if trustee_org_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationAuthorizationApi.post_orgauthorization_trustee_users" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustees/{trusteeOrgId}/users".sub('{format}','json').sub('{' + 'trusteeOrgId' + '}', trustee_org_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 => 'TrustUser')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationAuthorizationApi#post_orgauthorization_trustee_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_orgauthorization_trustees(body, opts = {}) ⇒ Trustee

Create a new organization authorization trust. This is required to grant other organizations access to your organization.

Parameters:

  • body —

    Trust

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

    the optional parameters

Returns:



1254
1255
1256
1257
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1254

def post_orgauthorization_trustees(body, opts = {})
  data, _status_code, _headers = post_orgauthorization_trustees_with_http_info(body, opts)
  return data
end

#post_orgauthorization_trustees_audits(body, opts = {}) ⇒ AuditQueryResponse

Get Org Trustee Audits

Parameters:

  • body —

    Values to scope the request.

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

  • :sort_by (String) —

    Sort by (default to timestamp)

  • :sort_order (String) —

    Sort order (default to descending)

Returns:



1323
1324
1325
1326
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1323

def post_orgauthorization_trustees_audits(body, opts = {})
  data, _status_code, _headers = post_orgauthorization_trustees_audits_with_http_info(body, opts)
  return data
end

#post_orgauthorization_trustees_audits_with_http_info(body, opts = {}) ⇒ Array<(AuditQueryResponse, Fixnum, Hash)>

Get Org Trustee Audits

Parameters:

  • body —

    Values to scope the request.

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

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

    AuditQueryResponse data, response status code and response headers



1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1337

def post_orgauthorization_trustees_audits_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.post_orgauthorization_trustees_audits ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationAuthorizationApi.post_orgauthorization_trustees_audits" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustees/audits".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[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 => 'AuditQueryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationAuthorizationApi#post_orgauthorization_trustees_audits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_orgauthorization_trustees_with_http_info(body, opts = {}) ⇒ Array<(Trustee, Fixnum, Hash)>

Create a new organization authorization trust. This is required to grant other organizations access to your organization.

Parameters:

  • body —

    Trust

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

    the optional parameters

Returns:

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

    Trustee data, response status code and response headers



1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1264

def post_orgauthorization_trustees_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.post_orgauthorization_trustees ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationAuthorizationApi.post_orgauthorization_trustees" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustees".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 => 'Trustee')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationAuthorizationApi#post_orgauthorization_trustees\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_orgauthorization_trustor_audits(body, opts = {}) ⇒ AuditQueryResponse

Get Org Trustor Audits

Parameters:

  • body —

    Values to scope the request.

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

  • :sort_by (String) —

    Sort by (default to timestamp)

  • :sort_order (String) —

    Sort order (default to descending)

Returns:



1424
1425
1426
1427
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1424

def post_orgauthorization_trustor_audits(body, opts = {})
  data, _status_code, _headers = post_orgauthorization_trustor_audits_with_http_info(body, opts)
  return data
end

#post_orgauthorization_trustor_audits_with_http_info(body, opts = {}) ⇒ Array<(AuditQueryResponse, Fixnum, Hash)>

Get Org Trustor Audits

Parameters:

  • body —

    Values to scope the request.

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

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

    AuditQueryResponse data, response status code and response headers



1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1438

def post_orgauthorization_trustor_audits_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.post_orgauthorization_trustor_audits ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationAuthorizationApi.post_orgauthorization_trustor_audits" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustor/audits".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[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 => 'AuditQueryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationAuthorizationApi#post_orgauthorization_trustor_audits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_orgauthorization_trustee(trustee_org_id, body, opts = {}) ⇒ Trustee

Update Org Trust

Parameters:

  • trustee_org_id —

    Trustee Organization Id

  • body —

    Client

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

    the optional parameters

Returns:



1522
1523
1524
1525
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1522

def put_orgauthorization_trustee(trustee_org_id, body, opts = {})
  data, _status_code, _headers = put_orgauthorization_trustee_with_http_info(trustee_org_id, body, opts)
  return data
end

#put_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id, body, opts = {}) ⇒ UserAuthorization

Update Trustee User Roles

Parameters:

  • trustee_org_id —

    Trustee Organization Id

  • trustee_user_id —

    Trustee User Id

  • body —

    List of roles

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

    the optional parameters

Returns:



1598
1599
1600
1601
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1598

def put_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id, body, opts = {})
  data, _status_code, _headers = put_orgauthorization_trustee_user_roles_with_http_info(trustee_org_id, trustee_user_id, body, opts)
  return data
end

#put_orgauthorization_trustee_user_roles_with_http_info(trustee_org_id, trustee_user_id, body, opts = {}) ⇒ Array<(UserAuthorization, Fixnum, Hash)>

Update Trustee User Roles

Parameters:

  • trustee_org_id —

    Trustee Organization Id

  • trustee_user_id —

    Trustee 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



1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1610

def put_orgauthorization_trustee_user_roles_with_http_info(trustee_org_id, trustee_user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.put_orgauthorization_trustee_user_roles ..."
  end
  
  
  # verify the required parameter 'trustee_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_org_id' when calling OrganizationAuthorizationApi.put_orgauthorization_trustee_user_roles" if trustee_org_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'trustee_user_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_user_id' when calling OrganizationAuthorizationApi.put_orgauthorization_trustee_user_roles" if trustee_user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationAuthorizationApi.put_orgauthorization_trustee_user_roles" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles".sub('{format}','json').sub('{' + 'trusteeOrgId' + '}', trustee_org_id.to_s).sub('{' + 'trusteeUserId' + '}', trustee_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: OrganizationAuthorizationApi#put_orgauthorization_trustee_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_orgauthorization_trustee_with_http_info(trustee_org_id, body, opts = {}) ⇒ Array<(Trustee, Fixnum, Hash)>

Update Org Trust

Parameters:

  • trustee_org_id —

    Trustee Organization Id

  • body —

    Client

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

    the optional parameters

Returns:

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

    Trustee data, response status code and response headers



1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1533

def put_orgauthorization_trustee_with_http_info(trustee_org_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.put_orgauthorization_trustee ..."
  end
  
  
  # verify the required parameter 'trustee_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_org_id' when calling OrganizationAuthorizationApi.put_orgauthorization_trustee" if trustee_org_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationAuthorizationApi.put_orgauthorization_trustee" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustees/{trusteeOrgId}".sub('{format}','json').sub('{' + 'trusteeOrgId' + '}', trustee_org_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 => 'Trustee')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationAuthorizationApi#put_orgauthorization_trustee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_orgauthorization_trustor_user(trustor_org_id, trustee_user_id, opts = {}) ⇒ TrustUser

Add a Trustee user to the trust.

Parameters:

  • trustor_org_id —

    Trustor Organization Id

  • trustee_user_id —

    Trustee User Id

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

    the optional parameters

Returns:



1682
1683
1684
1685
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1682

def put_orgauthorization_trustor_user(trustor_org_id, trustee_user_id, opts = {})
  data, _status_code, _headers = put_orgauthorization_trustor_user_with_http_info(trustor_org_id, trustee_user_id, opts)
  return data
end

#put_orgauthorization_trustor_user_with_http_info(trustor_org_id, trustee_user_id, opts = {}) ⇒ Array<(TrustUser, Fixnum, Hash)>

Add a Trustee user to the trust.

Parameters:

  • trustor_org_id —

    Trustor Organization Id

  • trustee_user_id —

    Trustee User Id

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

    the optional parameters

Returns:

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

    TrustUser data, response status code and response headers



1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
 
# File 'lib/purecloudclient_v2a/api/organization_authorization_api.rb', line 1693

def put_orgauthorization_trustor_user_with_http_info(trustor_org_id, trustee_user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationAuthorizationApi.put_orgauthorization_trustor_user ..."
  end
  
  
  # verify the required parameter 'trustor_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustor_org_id' when calling OrganizationAuthorizationApi.put_orgauthorization_trustor_user" if trustor_org_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'trustee_user_id' is set
  fail ArgumentError, "Missing the required parameter 'trustee_user_id' when calling OrganizationAuthorizationApi.put_orgauthorization_trustor_user" if trustee_user_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}".sub('{format}','json').sub('{' + 'trustorOrgId' + '}', trustor_org_id.to_s).sub('{' + 'trusteeUserId' + '}', trustee_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(: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 => 'TrustUser')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationAuthorizationApi#put_orgauthorization_trustor_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end