Class: PureCloud::OAuthApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OAuthApi

Returns a new instance of OAuthApi.


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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.


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

def api_client
  @api_client
end

Instance Method Details

#delete_client(client_id, opts = {}) ⇒ nil

Delete OAuth Client

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Returns:

  • (nil) 

1150
1151
1152
1153
 
# File 'lib/purecloud/api/o_auth_api.rb', line 1150

def delete_client(client_id, opts = {})
  delete_client_with_http_info(client_id, opts)
  return nil
end

#delete_client_with_http_info(client_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete OAuth Client

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers


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

def delete_client_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#delete_client ..."
  end
  
  # verify the required parameter 'client_id' is set
  fail "Missing the required parameter 'client_id' when calling delete_client" if client_id.nil?
  
  # resource path
  path = "/api/v1/oauth/clients/{clientId}".sub('{format}','json').sub('{' + 'clientId' + '}', client_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#delete_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_identityprovider(opts = {}) ⇒ nil

Delete an identity provider

Parameters:

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

    the optional parameters

Returns:

  • (nil) 

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

def delete_identityprovider(opts = {})
  delete_identityprovider_with_http_info(opts)
  return nil
end

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

Delete an identity provider

Parameters:

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

    the optional parameters

Returns:

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

    nil, 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/o_auth_api.rb', line 865

def delete_identityprovider_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#delete_identityprovider ..."
  end
  
  # resource path
  path = "/api/v1/identityproviders/{providerId}".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, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#delete_identityprovider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_identityproviders_okta(opts = {}) ⇒ nil

Delete Okta Identity Provider

Parameters:

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

    the optional parameters

Returns:

  • (nil) 

184
185
186
187
 
# File 'lib/purecloud/api/o_auth_api.rb', line 184

def delete_identityproviders_okta(opts = {})
  delete_identityproviders_okta_with_http_info(opts)
  return nil
end

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

Delete Okta Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers


193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/purecloud/api/o_auth_api.rb', line 193

def delete_identityproviders_okta_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#delete_identityproviders_okta ..."
  end
  
  # resource path
  path = "/api/v1/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, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#delete_identityproviders_okta\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_identityproviders_onelogin(opts = {}) ⇒ nil

Delete OneLogin Identity Provider

Parameters:

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

    the optional parameters

Returns:

  • (nil) 

352
353
354
355
 
# File 'lib/purecloud/api/o_auth_api.rb', line 352

def delete_identityproviders_onelogin(opts = {})
  delete_identityproviders_onelogin_with_http_info(opts)
  return nil
end

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

Delete OneLogin Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers


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
397
398
399
400
401
 
# File 'lib/purecloud/api/o_auth_api.rb', line 361

def delete_identityproviders_onelogin_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#delete_identityproviders_onelogin ..."
  end
  
  # resource path
  path = "/api/v1/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, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#delete_identityproviders_onelogin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_identityproviders_purecloud(opts = {}) ⇒ nil

Delete PureCloud Identity Provider

Parameters:

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

    the optional parameters

Returns:

  • (nil) 

520
521
522
523
 
# File 'lib/purecloud/api/o_auth_api.rb', line 520

def delete_identityproviders_purecloud(opts = {})
  delete_identityproviders_purecloud_with_http_info(opts)
  return nil
end

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

Delete PureCloud Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers


529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/purecloud/api/o_auth_api.rb', line 529

def delete_identityproviders_purecloud_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#delete_identityproviders_purecloud ..."
  end
  
  # resource path
  path = "/api/v1/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, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#delete_identityproviders_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_identityproviders_salesforce(opts = {}) ⇒ nil

Delete Salesforce Identity Provider

Parameters:

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

    the optional parameters

Returns:

  • (nil) 

688
689
690
691
 
# File 'lib/purecloud/api/o_auth_api.rb', line 688

def delete_identityproviders_salesforce(opts = {})
  delete_identityproviders_salesforce_with_http_info(opts)
  return nil
end

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

Delete Salesforce Identity Provider

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers


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

def delete_identityproviders_salesforce_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#delete_identityproviders_salesforce ..."
  end
  
  # resource path
  path = "/api/v1/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, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#delete_identityproviders_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_client(client_id, opts = {}) ⇒ OAuthClient

Get OAuth Client

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Returns:


1026
1027
1028
1029
 
# File 'lib/purecloud/api/o_auth_api.rb', line 1026

def get_client(client_id, opts = {})
  data, status_code, headers = get_client_with_http_info(client_id, opts)
  return data
end

#get_client_with_http_info(client_id, opts = {}) ⇒ Array<(OAuthClient, Fixnum, Hash)>

Get OAuth Client

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Returns:

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

    OAuthClient data, response status code and response headers


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
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
 
# File 'lib/purecloud/api/o_auth_api.rb', line 1036

def get_client_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#get_client ..."
  end
  
  # verify the required parameter 'client_id' is set
  fail "Missing the required parameter 'client_id' when calling get_client" if client_id.nil?
  
  # resource path
  path = "/api/v1/oauth/clients/{clientId}".sub('{format}','json').sub('{' + 'clientId' + '}', client_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

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

#get_clients(opts = {}) ⇒ OAuthClientEntityListing

The list of OAuth clients

Parameters:

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

    the optional parameters

Returns:


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

def get_clients(opts = {})
  data, status_code, headers = get_clients_with_http_info(opts)
  return data
end

#get_clients_with_http_info(opts = {}) ⇒ Array<(OAuthClientEntityListing, Fixnum, Hash)>

The list of OAuth clients

Parameters:

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

    the optional parameters

Returns:

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

    OAuthClientEntityListing 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
961
 
# File 'lib/purecloud/api/o_auth_api.rb', line 920

def get_clients_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#get_clients ..."
  end
  
  # resource path
  path = "/api/v1/oauth/clients".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

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

#get_identityprovider(opts = {}) ⇒ OAuthProvider

Get an identity provider

Parameters:

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

    the optional parameters

Returns:


743
744
745
746
 
# File 'lib/purecloud/api/o_auth_api.rb', line 743

def get_identityprovider(opts = {})
  data, status_code, headers = get_identityprovider_with_http_info(opts)
  return data
end

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

Get an identity provider

Parameters:

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

    the optional parameters

Returns:

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

    OAuthProvider data, response status code and response headers


752
753
754
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
 
# File 'lib/purecloud/api/o_auth_api.rb', line 752

def get_identityprovider_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#get_identityprovider ..."
  end
  
  # resource path
  path = "/api/v1/identityproviders/{providerId}".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthProvider')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#get_identityprovider\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:


15
16
17
18
 
# File 'lib/purecloud/api/o_auth_api.rb', line 15

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

#get_identityproviders_okta(opts = {}) ⇒ Okta

Get Okta Identity Provider

Parameters:

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

    the optional parameters

Returns:


71
72
73
74
 
# File 'lib/purecloud/api/o_auth_api.rb', line 71

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


80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/purecloud/api/o_auth_api.rb', line 80

def get_identityproviders_okta_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#get_identityproviders_okta ..."
  end
  
  # resource path
  path = "/api/v1/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, 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: OAuthApi#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:


239
240
241
242
 
# File 'lib/purecloud/api/o_auth_api.rb', line 239

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


248
249
250
251
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
 
# File 'lib/purecloud/api/o_auth_api.rb', line 248

def get_identityproviders_onelogin_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#get_identityproviders_onelogin ..."
  end
  
  # resource path
  path = "/api/v1/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, 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: OAuthApi#get_identityproviders_onelogin\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:


407
408
409
410
 
# File 'lib/purecloud/api/o_auth_api.rb', line 407

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


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
450
451
452
453
454
455
456
457
 
# File 'lib/purecloud/api/o_auth_api.rb', line 416

def get_identityproviders_purecloud_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#get_identityproviders_purecloud ..."
  end
  
  # resource path
  path = "/api/v1/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, 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: OAuthApi#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:


575
576
577
578
 
# File 'lib/purecloud/api/o_auth_api.rb', line 575

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


584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/purecloud/api/o_auth_api.rb', line 584

def get_identityproviders_salesforce_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#get_identityproviders_salesforce ..."
  end
  
  # resource path
  path = "/api/v1/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, 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: OAuthApi#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


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

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

#post_client_secret(client_id, opts = {}) ⇒ nil

Regenerate Client Secret This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Returns:

  • (nil) 

1210
1211
1212
1213
 
# File 'lib/purecloud/api/o_auth_api.rb', line 1210

def post_client_secret(client_id, opts = {})
  post_client_secret_with_http_info(client_id, opts)
  return nil
end

#post_client_secret_with_http_info(client_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Regenerate Client Secret This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Returns:

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

    nil, 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
1261
1262
1263
 
# File 'lib/purecloud/api/o_auth_api.rb', line 1220

def post_client_secret_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#post_client_secret ..."
  end
  
  # verify the required parameter 'client_id' is set
  fail "Missing the required parameter 'client_id' when calling post_client_secret" if client_id.nil?
  
  # resource path
  path = "/api/v1/oauth/clients/{clientId}/secret".sub('{format}','json').sub('{' + 'clientId' + '}', client_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#post_client_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_clients(opts = {}) ⇒ OAuthClient

Create OAuth client The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. nThe preferred authorizedGrantTypes is &#39;CODE&#39; which requires applications to send a client ID and client secret. This is typically a web server. nIf the client is unable to secure the client secret then the &#39;TOKEN&#39; grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. nIf a client is to be used outside of the context of a user then the &#39;CLIENT-CREDENTIALS&#39; grant may be used. In this case the client must be granted roles nvia the &#39;roleIds&#39; field.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:


968
969
970
971
 
# File 'lib/purecloud/api/o_auth_api.rb', line 968

def post_clients(opts = {})
  data, status_code, headers = post_clients_with_http_info(opts)
  return data
end

#post_clients_with_http_info(opts = {}) ⇒ Array<(OAuthClient, Fixnum, Hash)>

Create OAuth client The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. nThe preferred authorizedGrantTypes is &#39;CODE&#39; which requires applications to send a client ID and client secret. This is typically a web server. nIf the client is unable to secure the client secret then the &#39;TOKEN&#39; grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. nIf a client is to be used outside of the context of a user then the &#39;CLIENT-CREDENTIALS&#39; grant may be used. In this case the client must be granted roles nvia the &#39;roleIds&#39; field.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    OAuthClient data, response status code and response headers


978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/purecloud/api/o_auth_api.rb', line 978

def post_clients_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#post_clients ..."
  end
  
  # resource path
  path = "/api/v1/oauth/clients".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthClient')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#post_clients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_client(client_id, opts = {}) ⇒ OAuthClient

Update OAuth Client

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Options Hash (opts):

Returns:


1088
1089
1090
1091
 
# File 'lib/purecloud/api/o_auth_api.rb', line 1088

def put_client(client_id, opts = {})
  data, status_code, headers = put_client_with_http_info(client_id, opts)
  return data
end

#put_client_with_http_info(client_id, opts = {}) ⇒ Array<(OAuthClient, Fixnum, Hash)>

Update OAuth Client

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    OAuthClient data, response status code and response headers


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
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'lib/purecloud/api/o_auth_api.rb', line 1099

def put_client_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#put_client ..."
  end
  
  # verify the required parameter 'client_id' is set
  fail "Missing the required parameter 'client_id' when calling put_client" if client_id.nil?
  
  # resource path
  path = "/api/v1/oauth/clients/{clientId}".sub('{format}','json').sub('{' + 'clientId' + '}', client_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

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

#put_identityprovider(opts = {}) ⇒ nil

Update an identity provider

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 

800
801
802
803
 
# File 'lib/purecloud/api/o_auth_api.rb', line 800

def put_identityprovider(opts = {})
  put_identityprovider_with_http_info(opts)
  return nil
end

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

Update an identity provider

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, 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/o_auth_api.rb', line 810

def put_identityprovider_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#put_identityprovider ..."
  end
  
  # resource path
  path = "/api/v1/identityproviders/{providerId}".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

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

#put_identityproviders_okta(opts = {}) ⇒ nil

Update/Create Okta Identity Provider

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Okta) —

    Provider

Returns:

  • (nil) 

128
129
130
131
 
# File 'lib/purecloud/api/o_auth_api.rb', line 128

def put_identityproviders_okta(opts = {})
  put_identityproviders_okta_with_http_info(opts)
  return nil
end

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

Update/Create Okta Identity Provider

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Okta) —

    Provider

Returns:

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

    nil, response status code and response headers


138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/purecloud/api/o_auth_api.rb', line 138

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

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

#put_identityproviders_onelogin(opts = {}) ⇒ nil

Update/Create OneLogin Identity Provider

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 

296
297
298
299
 
# File 'lib/purecloud/api/o_auth_api.rb', line 296

def put_identityproviders_onelogin(opts = {})
  put_identityproviders_onelogin_with_http_info(opts)
  return nil
end

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

Update/Create OneLogin Identity Provider

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers


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
344
345
346
 
# File 'lib/purecloud/api/o_auth_api.rb', line 306

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

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

#put_identityproviders_purecloud(opts = {}) ⇒ nil

Update/Create PureCloud Identity Provider

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 

464
465
466
467
 
# File 'lib/purecloud/api/o_auth_api.rb', line 464

def put_identityproviders_purecloud(opts = {})
  put_identityproviders_purecloud_with_http_info(opts)
  return nil
end

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

Update/Create PureCloud Identity Provider

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers


474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/purecloud/api/o_auth_api.rb', line 474

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

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

#put_identityproviders_salesforce(opts = {}) ⇒ nil

Update/Create Salesforce Identity Provider

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 

632
633
634
635
 
# File 'lib/purecloud/api/o_auth_api.rb', line 632

def put_identityproviders_salesforce(opts = {})
  put_identityproviders_salesforce_with_http_info(opts)
  return nil
end

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

Update/Create Salesforce Identity Provider

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers


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

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

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