Class: PureCloud::IdentityProviderApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IdentityProviderApi

Returns a new instance of IdentityProviderApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#delete_adfs(opts = {}) ⇒ Empty

Delete ADFS Identity Provider

Parameters:

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

    the optional parameters

Returns:



31
32
33
34
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 31

def delete_adfs(opts = {})
  data, status_code, headers = delete_adfs_with_http_info(opts)
  return data
end

#delete_adfs_with_http_info(opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Delete ADFS Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



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
72
73
74
75
76
77
78
79
80
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 40

def delete_adfs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_adfs ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/adfs".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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_adfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_cic(opts = {}) ⇒ Empty

Delete Customer Interaction Center (CIC) Identity Provider

Parameters:

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

    the optional parameters

Returns:



86
87
88
89
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 86

def delete_cic(opts = {})
  data, status_code, headers = delete_cic_with_http_info(opts)
  return data
end

#delete_cic_with_http_info(opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Delete Customer Interaction Center (CIC) Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



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
134
135
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 95

def delete_cic_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_cic ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/cic".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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_cic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_gsuite(opts = {}) ⇒ Empty

Delete G Suite Identity Provider

Parameters:

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

    the optional parameters

Returns:



141
142
143
144
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 141

def delete_gsuite(opts = {})
  data, status_code, headers = delete_gsuite_with_http_info(opts)
  return data
end

#delete_gsuite_with_http_info(opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Delete G Suite Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



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
190
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 150

def delete_gsuite_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_gsuite ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/gsuite".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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_gsuite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_identitynow(opts = {}) ⇒ Empty

Delete IdentityNow Provider

Parameters:

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

    the optional parameters

Returns:



196
197
198
199
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 196

def delete_identitynow(opts = {})
  data, status_code, headers = delete_identitynow_with_http_info(opts)
  return data
end

#delete_identitynow_with_http_info(opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Delete IdentityNow Provider

Parameters:

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



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
238
239
240
241
242
243
244
245
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 205

def delete_identitynow_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_identitynow ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/identitynow".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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_identitynow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_okta(opts = {}) ⇒ Empty

Delete Okta Identity Provider

Parameters:

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

    the optional parameters

Returns:



251
252
253
254
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 251

def delete_okta(opts = {})
  data, status_code, headers = delete_okta_with_http_info(opts)
  return data
end

#delete_okta_with_http_info(opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Delete Okta Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



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
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 260

def delete_okta_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_okta ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/okta".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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_okta\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_onelogin(opts = {}) ⇒ Empty

Delete OneLogin Identity Provider

Parameters:

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

    the optional parameters

Returns:



306
307
308
309
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 306

def delete_onelogin(opts = {})
  data, status_code, headers = delete_onelogin_with_http_info(opts)
  return data
end

#delete_onelogin_with_http_info(opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Delete OneLogin Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



315
316
317
318
319
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
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 315

def delete_onelogin_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_onelogin ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/onelogin".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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_onelogin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_ping(opts = {}) ⇒ Empty

Delete Ping Identity Provider

Parameters:

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

    the optional parameters

Returns:



361
362
363
364
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 361

def delete_ping(opts = {})
  data, status_code, headers = delete_ping_with_http_info(opts)
  return data
end

#delete_ping_with_http_info(opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Delete Ping Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 370

def delete_ping_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_ping ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/ping".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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_purecloud(opts = {}) ⇒ Empty

Delete PureCloud Identity Provider

Parameters:

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

    the optional parameters

Returns:



416
417
418
419
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 416

def delete_purecloud(opts = {})
  data, status_code, headers = delete_purecloud_with_http_info(opts)
  return data
end

#delete_purecloud_with_http_info(opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Delete PureCloud Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



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

def delete_purecloud_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_purecloud ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/purecloud".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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_salesforce(opts = {}) ⇒ Empty

Delete Salesforce Identity Provider

Parameters:

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

    the optional parameters

Returns:



471
472
473
474
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 471

def delete_salesforce(opts = {})
  data, status_code, headers = delete_salesforce_with_http_info(opts)
  return data
end

#delete_salesforce_with_http_info(opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Delete Salesforce Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



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

def delete_salesforce_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_salesforce ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/salesforce".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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_adfs(opts = {}) ⇒ ADFS

Get ADFS Identity Provider

Parameters:

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

    the optional parameters

Returns:



526
527
528
529
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 526

def get_adfs(opts = {})
  data, status_code, headers = get_adfs_with_http_info(opts)
  return data
end

#get_adfs_with_http_info(opts = {}) ⇒ Array<(ADFS, Fixnum, Hash)>

Get ADFS Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    ADFS data, response status code and response headers



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
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 535

def get_adfs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_adfs ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/adfs".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ADFS')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_adfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_cic(opts = {}) ⇒ CustomerInteractionCenter

Get Customer Interaction Center (CIC) Identity Provider

Parameters:

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

    the optional parameters

Returns:



581
582
583
584
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 581

def get_cic(opts = {})
  data, status_code, headers = get_cic_with_http_info(opts)
  return data
end

#get_cic_with_http_info(opts = {}) ⇒ Array<(CustomerInteractionCenter, Fixnum, Hash)>

Get Customer Interaction Center (CIC) Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    CustomerInteractionCenter data, response status code and response headers



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
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 590

def get_cic_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_cic ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/cic".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CustomerInteractionCenter')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_cic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_gsuite(opts = {}) ⇒ GSuite

Get G Suite Identity Provider

Parameters:

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

    the optional parameters

Returns:



636
637
638
639
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 636

def get_gsuite(opts = {})
  data, status_code, headers = get_gsuite_with_http_info(opts)
  return data
end

#get_gsuite_with_http_info(opts = {}) ⇒ Array<(GSuite, Fixnum, Hash)>

Get G Suite Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    GSuite data, response status code and response headers



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

def get_gsuite_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_gsuite ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/gsuite".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GSuite')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_gsuite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_identitynow(opts = {}) ⇒ IdentityNow

Get IdentityNow Provider

Parameters:

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

    the optional parameters

Returns:



691
692
693
694
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 691

def get_identitynow(opts = {})
  data, status_code, headers = get_identitynow_with_http_info(opts)
  return data
end

#get_identitynow_with_http_info(opts = {}) ⇒ Array<(IdentityNow, Fixnum, Hash)>

Get IdentityNow Provider

Parameters:

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

    the optional parameters

Returns:

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

    IdentityNow data, response status code and response headers



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
739
740
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 700

def get_identitynow_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_identitynow ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/identitynow".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IdentityNow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_identitynow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_identityproviders(opts = {}) ⇒ OAuthProviderEntityListing

The list of identity providers

Parameters:

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

    the optional parameters

Returns:



746
747
748
749
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 746

def get_identityproviders(opts = {})
  data, status_code, headers = get_identityproviders_with_http_info(opts)
  return data
end

#get_identityproviders_with_http_info(opts = {}) ⇒ Array<(OAuthProviderEntityListing, Fixnum, Hash)>

The list of identity providers

Parameters:

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

    the optional parameters

Returns:

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

    OAuthProviderEntityListing data, response status code and response headers



755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 755

def get_identityproviders_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_identityproviders ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthProviderEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_identityproviders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_okta(opts = {}) ⇒ Okta

Get Okta Identity Provider

Parameters:

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

    the optional parameters

Returns:



801
802
803
804
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 801

def get_okta(opts = {})
  data, status_code, headers = get_okta_with_http_info(opts)
  return data
end

#get_okta_with_http_info(opts = {}) ⇒ Array<(Okta, Fixnum, Hash)>

Get Okta Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    Okta data, response status code and response headers



810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 810

def get_okta_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_okta ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/okta".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Okta')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_okta\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_onelogin(opts = {}) ⇒ OneLogin

Get OneLogin Identity Provider

Parameters:

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

    the optional parameters

Returns:



856
857
858
859
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 856

def get_onelogin(opts = {})
  data, status_code, headers = get_onelogin_with_http_info(opts)
  return data
end

#get_onelogin_with_http_info(opts = {}) ⇒ Array<(OneLogin, Fixnum, Hash)>

Get OneLogin Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    OneLogin data, response status code and response headers



865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 865

def get_onelogin_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_onelogin ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/onelogin".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OneLogin')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_onelogin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ping(opts = {}) ⇒ PingIdentity

Get Ping Identity Provider

Parameters:

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

    the optional parameters

Returns:



911
912
913
914
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 911

def get_ping(opts = {})
  data, status_code, headers = get_ping_with_http_info(opts)
  return data
end

#get_ping_with_http_info(opts = {}) ⇒ Array<(PingIdentity, Fixnum, Hash)>

Get Ping Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    PingIdentity data, response status code and response headers



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 920

def get_ping_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_ping ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/ping".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PingIdentity')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_purecloud(opts = {}) ⇒ PureCloud

Get PureCloud Identity Provider

Parameters:

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

    the optional parameters

Returns:



966
967
968
969
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 966

def get_purecloud(opts = {})
  data, status_code, headers = get_purecloud_with_http_info(opts)
  return data
end

#get_purecloud_with_http_info(opts = {}) ⇒ Array<(PureCloud, Fixnum, Hash)>

Get PureCloud Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    PureCloud data, response status code and response headers



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
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 975

def get_purecloud_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_purecloud ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/purecloud".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PureCloud')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_salesforce(opts = {}) ⇒ Salesforce

Get Salesforce Identity Provider

Parameters:

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

    the optional parameters

Returns:



1021
1022
1023
1024
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1021

def get_salesforce(opts = {})
  data, status_code, headers = get_salesforce_with_http_info(opts)
  return data
end

#get_salesforce_with_http_info(opts = {}) ⇒ Array<(Salesforce, Fixnum, Hash)>

Get Salesforce Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    Salesforce data, response status code and response headers



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
1070
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1030

def get_salesforce_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_salesforce ..."
  end
  
  # resource path
  local_var_path = "/api/v2/identityproviders/salesforce".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Salesforce')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_adfs(body, opts = {}) ⇒ OAuthProvider

Update/Create ADFS Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1077
1078
1079
1080
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1077

def put_adfs(body, opts = {})
  data, status_code, headers = put_adfs_with_http_info(body, opts)
  return data
end

#put_adfs_with_http_info(body, opts = {}) ⇒ Array<(OAuthProvider, Fixnum, Hash)>

Update/Create ADFS Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:

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

    OAuthProvider data, response status code and response headers



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
1130
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1087

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_adfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_cic(body, opts = {}) ⇒ OAuthProvider

Update/Create Customer Interaction Center (CIC) Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1137
1138
1139
1140
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1137

def put_cic(body, opts = {})
  data, status_code, headers = put_cic_with_http_info(body, opts)
  return data
end

#put_cic_with_http_info(body, opts = {}) ⇒ Array<(OAuthProvider, Fixnum, Hash)>

Update/Create Customer Interaction Center (CIC) Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:

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

    OAuthProvider data, response status code and response headers



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
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1147

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_cic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_gsuite(body, opts = {}) ⇒ OAuthProvider

Update/Create G Suite Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1197
1198
1199
1200
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1197

def put_gsuite(body, opts = {})
  data, status_code, headers = put_gsuite_with_http_info(body, opts)
  return data
end

#put_gsuite_with_http_info(body, opts = {}) ⇒ Array<(OAuthProvider, Fixnum, Hash)>

Update/Create G Suite Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:

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

    OAuthProvider data, response status code and response headers



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
1248
1249
1250
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1207

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_gsuite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_identitynow(body, opts = {}) ⇒ IdentityNow

Update/Create IdentityNow Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1257
1258
1259
1260
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1257

def put_identitynow(body, opts = {})
  data, status_code, headers = put_identitynow_with_http_info(body, opts)
  return data
end

#put_identitynow_with_http_info(body, opts = {}) ⇒ Array<(IdentityNow, Fixnum, Hash)>

Update/Create IdentityNow Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:

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

    IdentityNow data, response status code and response headers



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
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1267

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IdentityNow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_identitynow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_okta(body, opts = {}) ⇒ OAuthProvider

Update/Create Okta Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1317
1318
1319
1320
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1317

def put_okta(body, opts = {})
  data, status_code, headers = put_okta_with_http_info(body, opts)
  return data
end

#put_okta_with_http_info(body, opts = {}) ⇒ Array<(OAuthProvider, Fixnum, Hash)>

Update/Create Okta Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:

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

    OAuthProvider data, response status code and response headers



1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1327

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_okta\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_onelogin(body, opts = {}) ⇒ OAuthProvider

Update/Create OneLogin Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1377
1378
1379
1380
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1377

def put_onelogin(body, opts = {})
  data, status_code, headers = put_onelogin_with_http_info(body, opts)
  return data
end

#put_onelogin_with_http_info(body, opts = {}) ⇒ Array<(OAuthProvider, Fixnum, Hash)>

Update/Create OneLogin Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:

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

    OAuthProvider data, response status code and response headers



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1387

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_onelogin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_ping(body, opts = {}) ⇒ OAuthProvider

Update/Create Ping Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1437
1438
1439
1440
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1437

def put_ping(body, opts = {})
  data, status_code, headers = put_ping_with_http_info(body, opts)
  return data
end

#put_ping_with_http_info(body, opts = {}) ⇒ Array<(OAuthProvider, Fixnum, Hash)>

Update/Create Ping Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:

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

    OAuthProvider data, response status code and response headers



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1447

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_purecloud(body, opts = {}) ⇒ OAuthProvider

Update/Create PureCloud Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1497
1498
1499
1500
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1497

def put_purecloud(body, opts = {})
  data, status_code, headers = put_purecloud_with_http_info(body, opts)
  return data
end

#put_purecloud_with_http_info(body, opts = {}) ⇒ Array<(OAuthProvider, Fixnum, Hash)>

Update/Create PureCloud Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:

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

    OAuthProvider data, response status code and response headers



1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1507

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_salesforce(body, opts = {}) ⇒ OAuthProvider

Update/Create Salesforce Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1557
1558
1559
1560
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1557

def put_salesforce(body, opts = {})
  data, status_code, headers = put_salesforce_with_http_info(body, opts)
  return data
end

#put_salesforce_with_http_info(body, opts = {}) ⇒ Array<(OAuthProvider, Fixnum, Hash)>

Update/Create Salesforce Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:

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

    OAuthProvider data, response status code and response headers



1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
 
# File 'lib/purecloud/api/identity_provider_api.rb', line 1567

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end