Class: PureCloud::IdentityProviderApi

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

def api_client
  @api_client
end

Instance Method Details

#delete_identityproviders_adfs(opts = {}) ⇒ Empty

Delete ADFS Identity Provider

Parameters:

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

    the optional parameters

Returns:



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

def delete_identityproviders_adfs(opts = {})
  data, _status_code, _headers = delete_identityproviders_adfs_with_http_info(opts)
  return data
end

#delete_identityproviders_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
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 40

def delete_identityproviders_adfs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.delete_identityproviders_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)
  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,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_identityproviders_adfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_identityproviders_cic(opts = {}) ⇒ Empty

Delete Customer Interaction Center (CIC) Identity Provider

Parameters:

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

    the optional parameters

Returns:



84
85
86
87
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 84

def delete_identityproviders_cic(opts = {})
  data, _status_code, _headers = delete_identityproviders_cic_with_http_info(opts)
  return data
end

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 93

def delete_identityproviders_cic_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.delete_identityproviders_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)
  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,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_identityproviders_cic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_identityproviders_gsuite(opts = {}) ⇒ Empty

Delete G Suite Identity Provider

Parameters:

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

    the optional parameters

Returns:



137
138
139
140
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 137

def delete_identityproviders_gsuite(opts = {})
  data, _status_code, _headers = delete_identityproviders_gsuite_with_http_info(opts)
  return data
end

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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 146

def delete_identityproviders_gsuite_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.delete_identityproviders_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)
  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,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_identityproviders_gsuite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_identityproviders_identitynow(opts = {}) ⇒ Empty

Delete IdentityNow Provider

Parameters:

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

    the optional parameters

Returns:



190
191
192
193
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 190

def delete_identityproviders_identitynow(opts = {})
  data, _status_code, _headers = delete_identityproviders_identitynow_with_http_info(opts)
  return data
end

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



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/purecloudplatformclientv2/api/identity_provider_api.rb', line 199

def delete_identityproviders_identitynow_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.delete_identityproviders_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)
  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,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_identityproviders_identitynow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_identityproviders_okta(opts = {}) ⇒ Empty

Delete Okta Identity Provider

Parameters:

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

    the optional parameters

Returns:



243
244
245
246
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 243

def delete_identityproviders_okta(opts = {})
  data, _status_code, _headers = delete_identityproviders_okta_with_http_info(opts)
  return data
end

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



252
253
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
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 252

def delete_identityproviders_okta_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.delete_identityproviders_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)
  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,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_identityproviders_okta\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_identityproviders_onelogin(opts = {}) ⇒ Empty

Delete OneLogin Identity Provider

Parameters:

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

    the optional parameters

Returns:



296
297
298
299
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 296

def delete_identityproviders_onelogin(opts = {})
  data, _status_code, _headers = delete_identityproviders_onelogin_with_http_info(opts)
  return data
end

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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 305

def delete_identityproviders_onelogin_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.delete_identityproviders_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)
  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,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_identityproviders_onelogin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_identityproviders_ping(opts = {}) ⇒ Empty

Delete Ping Identity Provider

Parameters:

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

    the optional parameters

Returns:



349
350
351
352
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 349

def delete_identityproviders_ping(opts = {})
  data, _status_code, _headers = delete_identityproviders_ping_with_http_info(opts)
  return data
end

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



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

def delete_identityproviders_ping_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.delete_identityproviders_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)
  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,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_identityproviders_ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_identityproviders_purecloud(opts = {}) ⇒ Empty

Delete PureCloud Identity Provider

Parameters:

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

    the optional parameters

Returns:



402
403
404
405
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 402

def delete_identityproviders_purecloud(opts = {})
  data, _status_code, _headers = delete_identityproviders_purecloud_with_http_info(opts)
  return data
end

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



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 411

def delete_identityproviders_purecloud_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.delete_identityproviders_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)
  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,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_identityproviders_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_identityproviders_salesforce(opts = {}) ⇒ Empty

Delete Salesforce Identity Provider

Parameters:

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

    the optional parameters

Returns:



455
456
457
458
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 455

def delete_identityproviders_salesforce(opts = {})
  data, _status_code, _headers = delete_identityproviders_salesforce_with_http_info(opts)
  return data
end

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



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

def delete_identityproviders_salesforce_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.delete_identityproviders_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)
  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,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#delete_identityproviders_salesforce\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:



508
509
510
511
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 508

def get_identityproviders(opts = {})
  data, _status_code, _headers = get_identityproviders_with_http_info(opts)
  return data
end

#get_identityproviders_adfs(opts = {}) ⇒ ADFS

Get ADFS Identity Provider

Parameters:

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

    the optional parameters

Returns:



561
562
563
564
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 561

def get_identityproviders_adfs(opts = {})
  data, _status_code, _headers = get_identityproviders_adfs_with_http_info(opts)
  return data
end

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



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 570

def get_identityproviders_adfs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.get_identityproviders_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)
  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 => 'ADFS')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_identityproviders_adfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_identityproviders_cic(opts = {}) ⇒ CustomerInteractionCenter

Get Customer Interaction Center (CIC) Identity Provider

Parameters:

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

    the optional parameters

Returns:



614
615
616
617
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 614

def get_identityproviders_cic(opts = {})
  data, _status_code, _headers = get_identityproviders_cic_with_http_info(opts)
  return data
end

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



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
656
657
658
659
660
661
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 623

def get_identityproviders_cic_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.get_identityproviders_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)
  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 => 'CustomerInteractionCenter')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_identityproviders_cic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_identityproviders_gsuite(opts = {}) ⇒ GSuite

Get G Suite Identity Provider

Parameters:

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

    the optional parameters

Returns:



667
668
669
670
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 667

def get_identityproviders_gsuite(opts = {})
  data, _status_code, _headers = get_identityproviders_gsuite_with_http_info(opts)
  return data
end

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



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

def get_identityproviders_gsuite_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.get_identityproviders_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)
  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 => 'GSuite')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_identityproviders_gsuite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_identityproviders_identitynow(opts = {}) ⇒ IdentityNow

Get IdentityNow Provider

Parameters:

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

    the optional parameters

Returns:



720
721
722
723
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 720

def get_identityproviders_identitynow(opts = {})
  data, _status_code, _headers = get_identityproviders_identitynow_with_http_info(opts)
  return data
end

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



729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 729

def get_identityproviders_identitynow_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.get_identityproviders_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)
  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 => 'IdentityNow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_identityproviders_identitynow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_identityproviders_okta(opts = {}) ⇒ Okta

Get Okta Identity Provider

Parameters:

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

    the optional parameters

Returns:



773
774
775
776
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 773

def get_identityproviders_okta(opts = {})
  data, _status_code, _headers = get_identityproviders_okta_with_http_info(opts)
  return data
end

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



782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 782

def get_identityproviders_okta_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.get_identityproviders_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)
  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 => 'Okta')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_identityproviders_okta\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_identityproviders_onelogin(opts = {}) ⇒ OneLogin

Get OneLogin Identity Provider

Parameters:

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

    the optional parameters

Returns:



826
827
828
829
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 826

def get_identityproviders_onelogin(opts = {})
  data, _status_code, _headers = get_identityproviders_onelogin_with_http_info(opts)
  return data
end

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



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

def get_identityproviders_onelogin_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.get_identityproviders_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)
  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 => 'OneLogin')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_identityproviders_onelogin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_identityproviders_ping(opts = {}) ⇒ PingIdentity

Get Ping Identity Provider

Parameters:

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

    the optional parameters

Returns:



879
880
881
882
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 879

def get_identityproviders_ping(opts = {})
  data, _status_code, _headers = get_identityproviders_ping_with_http_info(opts)
  return data
end

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



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 888

def get_identityproviders_ping_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.get_identityproviders_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)
  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 => 'PingIdentity')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_identityproviders_ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_identityproviders_purecloud(opts = {}) ⇒ PureCloud

Get PureCloud Identity Provider

Parameters:

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

    the optional parameters

Returns:



932
933
934
935
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 932

def get_identityproviders_purecloud(opts = {})
  data, _status_code, _headers = get_identityproviders_purecloud_with_http_info(opts)
  return data
end

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



941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 941

def get_identityproviders_purecloud_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.get_identityproviders_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)
  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 => 'PureCloud')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_identityproviders_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_identityproviders_salesforce(opts = {}) ⇒ Salesforce

Get Salesforce Identity Provider

Parameters:

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

    the optional parameters

Returns:



985
986
987
988
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 985

def get_identityproviders_salesforce(opts = {})
  data, _status_code, _headers = get_identityproviders_salesforce_with_http_info(opts)
  return data
end

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



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

def get_identityproviders_salesforce_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.get_identityproviders_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)
  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 => 'Salesforce')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#get_identityproviders_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
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



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 517

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

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

Update/Create ADFS Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1039
1040
1041
1042
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1039

def put_identityproviders_adfs(body, opts = {})
  data, _status_code, _headers = put_identityproviders_adfs_with_http_info(body, opts)
  return data
end

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



1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1049

def put_identityproviders_adfs_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.put_identityproviders_adfs ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IdentityProviderApi.put_identityproviders_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)
  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 => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_identityproviders_adfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update/Create Customer Interaction Center (CIC) Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1096
1097
1098
1099
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1096

def put_identityproviders_cic(body, opts = {})
  data, _status_code, _headers = put_identityproviders_cic_with_http_info(body, opts)
  return data
end

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



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
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1106

def put_identityproviders_cic_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.put_identityproviders_cic ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IdentityProviderApi.put_identityproviders_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)
  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 => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_identityproviders_cic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update/Create G Suite Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1153
1154
1155
1156
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1153

def put_identityproviders_gsuite(body, opts = {})
  data, _status_code, _headers = put_identityproviders_gsuite_with_http_info(body, opts)
  return data
end

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



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
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1163

def put_identityproviders_gsuite_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.put_identityproviders_gsuite ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IdentityProviderApi.put_identityproviders_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)
  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 => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_identityproviders_gsuite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update/Create IdentityNow Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1210
1211
1212
1213
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1210

def put_identityproviders_identitynow(body, opts = {})
  data, _status_code, _headers = put_identityproviders_identitynow_with_http_info(body, opts)
  return data
end

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



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
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1220

def put_identityproviders_identitynow_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.put_identityproviders_identitynow ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IdentityProviderApi.put_identityproviders_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)
  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 => 'IdentityNow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_identityproviders_identitynow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update/Create Okta Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1267
1268
1269
1270
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1267

def put_identityproviders_okta(body, opts = {})
  data, _status_code, _headers = put_identityproviders_okta_with_http_info(body, opts)
  return data
end

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



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
1313
1314
1315
1316
1317
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1277

def put_identityproviders_okta_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.put_identityproviders_okta ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IdentityProviderApi.put_identityproviders_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)
  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 => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_identityproviders_okta\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update/Create OneLogin Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1324
1325
1326
1327
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1324

def put_identityproviders_onelogin(body, opts = {})
  data, _status_code, _headers = put_identityproviders_onelogin_with_http_info(body, opts)
  return data
end

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



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
1371
1372
1373
1374
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1334

def put_identityproviders_onelogin_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.put_identityproviders_onelogin ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IdentityProviderApi.put_identityproviders_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)
  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 => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_identityproviders_onelogin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update/Create Ping Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1381
1382
1383
1384
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1381

def put_identityproviders_ping(body, opts = {})
  data, _status_code, _headers = put_identityproviders_ping_with_http_info(body, opts)
  return data
end

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



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
1431
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1391

def put_identityproviders_ping_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.put_identityproviders_ping ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IdentityProviderApi.put_identityproviders_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)
  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 => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_identityproviders_ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update/Create PureCloud Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1438
1439
1440
1441
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1438

def put_identityproviders_purecloud(body, opts = {})
  data, _status_code, _headers = put_identityproviders_purecloud_with_http_info(body, opts)
  return data
end

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



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

def put_identityproviders_purecloud_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.put_identityproviders_purecloud ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IdentityProviderApi.put_identityproviders_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)
  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 => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_identityproviders_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update/Create Salesforce Identity Provider

Parameters:

  • body —

    Provider

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

    the optional parameters

Returns:



1495
1496
1497
1498
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1495

def put_identityproviders_salesforce(body, opts = {})
  data, _status_code, _headers = put_identityproviders_salesforce_with_http_info(body, opts)
  return data
end

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



1505
1506
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
 
# File 'lib/purecloudplatformclientv2/api/identity_provider_api.rb', line 1505

def put_identityproviders_salesforce_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityProviderApi.put_identityproviders_salesforce ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IdentityProviderApi.put_identityproviders_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)
  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 => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityProviderApi#put_identityproviders_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end