class PureCloud::IdentityProviderApi
Attributes
Public Class Methods
# File lib/purecloud/api/identity_provider_api.rb, line 23 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Delete ADFS
Identity Provider
@param [Hash] opts the optional parameters @return [Empty]
# File lib/purecloud/api/identity_provider_api.rb, line 31 def delete_adfs(opts = {}) data, status_code, headers = delete_adfs_with_http_info(opts) return data end
Delete ADFS
Identity Provider
@param [Hash] opts the optional parameters @return [Array<(Empty
, Fixnum, Hash)>] Empty
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 40 def delete_adfs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_adfs ..." end # resource path local_var_path = "/api/v2/identityproviders/adfs".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Empty') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#delete_adfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete Customer Interaction Center (CIC) Identity Provider
@param [Hash] opts the optional parameters @return [Empty]
# File lib/purecloud/api/identity_provider_api.rb, line 86 def delete_cic(opts = {}) data, status_code, headers = delete_cic_with_http_info(opts) return data end
Delete Customer Interaction Center (CIC) Identity Provider
@param [Hash] opts the optional parameters @return [Array<(Empty
, Fixnum, Hash)>] Empty
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 95 def delete_cic_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_cic ..." end # resource path local_var_path = "/api/v2/identityproviders/cic".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Empty') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#delete_cic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete G Suite Identity Provider
@param [Hash] opts the optional parameters @return [Empty]
# File lib/purecloud/api/identity_provider_api.rb, line 141 def delete_gsuite(opts = {}) data, status_code, headers = delete_gsuite_with_http_info(opts) return data end
Delete G Suite Identity Provider
@param [Hash] opts the optional parameters @return [Array<(Empty
, Fixnum, Hash)>] Empty
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 150 def delete_gsuite_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_gsuite ..." end # resource path local_var_path = "/api/v2/identityproviders/gsuite".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Empty') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#delete_gsuite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete IdentityNow
Provider
@param [Hash] opts the optional parameters @return [Empty]
# File lib/purecloud/api/identity_provider_api.rb, line 196 def delete_identitynow(opts = {}) data, status_code, headers = delete_identitynow_with_http_info(opts) return data end
Delete IdentityNow
Provider
@param [Hash] opts the optional parameters @return [Array<(Empty
, Fixnum, Hash)>] Empty
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 205 def delete_identitynow_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_identitynow ..." end # resource path local_var_path = "/api/v2/identityproviders/identitynow".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Empty') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#delete_identitynow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete Okta
Identity Provider
@param [Hash] opts the optional parameters @return [Empty]
# File lib/purecloud/api/identity_provider_api.rb, line 251 def delete_okta(opts = {}) data, status_code, headers = delete_okta_with_http_info(opts) return data end
Delete Okta
Identity Provider
@param [Hash] opts the optional parameters @return [Array<(Empty
, Fixnum, Hash)>] Empty
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 260 def delete_okta_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_okta ..." end # resource path local_var_path = "/api/v2/identityproviders/okta".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Empty') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#delete_okta\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete OneLogin
Identity Provider
@param [Hash] opts the optional parameters @return [Empty]
# File lib/purecloud/api/identity_provider_api.rb, line 306 def delete_onelogin(opts = {}) data, status_code, headers = delete_onelogin_with_http_info(opts) return data end
Delete OneLogin
Identity Provider
@param [Hash] opts the optional parameters @return [Array<(Empty
, Fixnum, Hash)>] Empty
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 315 def delete_onelogin_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_onelogin ..." end # resource path local_var_path = "/api/v2/identityproviders/onelogin".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Empty') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#delete_onelogin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete Ping Identity Provider
@param [Hash] opts the optional parameters @return [Empty]
# File lib/purecloud/api/identity_provider_api.rb, line 361 def delete_ping(opts = {}) data, status_code, headers = delete_ping_with_http_info(opts) return data end
Delete Ping Identity Provider
@param [Hash] opts the optional parameters @return [Array<(Empty
, Fixnum, Hash)>] Empty
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 370 def delete_ping_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_ping ..." end # resource path local_var_path = "/api/v2/identityproviders/ping".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Empty') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#delete_ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete PureCloud
Identity Provider
@param [Hash] opts the optional parameters @return [Empty]
# File lib/purecloud/api/identity_provider_api.rb, line 416 def delete_purecloud(opts = {}) data, status_code, headers = delete_purecloud_with_http_info(opts) return data end
Delete PureCloud
Identity Provider
@param [Hash] opts the optional parameters @return [Array<(Empty
, Fixnum, Hash)>] Empty
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 425 def delete_purecloud_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_purecloud ..." end # resource path local_var_path = "/api/v2/identityproviders/purecloud".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Empty') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#delete_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete Salesforce
Identity Provider
@param [Hash] opts the optional parameters @return [Empty]
# File lib/purecloud/api/identity_provider_api.rb, line 471 def delete_salesforce(opts = {}) data, status_code, headers = delete_salesforce_with_http_info(opts) return data end
Delete Salesforce
Identity Provider
@param [Hash] opts the optional parameters @return [Array<(Empty
, Fixnum, Hash)>] Empty
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 480 def delete_salesforce_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_salesforce ..." end # resource path local_var_path = "/api/v2/identityproviders/salesforce".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Empty') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#delete_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get ADFS
Identity Provider
@param [Hash] opts the optional parameters @return [ADFS]
# File lib/purecloud/api/identity_provider_api.rb, line 526 def get_adfs(opts = {}) data, status_code, headers = get_adfs_with_http_info(opts) return data end
Get ADFS
Identity Provider
@param [Hash] opts the optional parameters @return [Array<(ADFS
, Fixnum, Hash)>] ADFS
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 535 def get_adfs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_adfs ..." end # resource path local_var_path = "/api/v2/identityproviders/adfs".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ADFS') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#get_adfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Customer Interaction Center (CIC) Identity Provider
@param [Hash] opts the optional parameters @return [CustomerInteractionCenter]
# File lib/purecloud/api/identity_provider_api.rb, line 581 def get_cic(opts = {}) data, status_code, headers = get_cic_with_http_info(opts) return data end
Get Customer Interaction Center (CIC) Identity Provider
@param [Hash] opts the optional parameters @return [Array<(CustomerInteractionCenter
, Fixnum, Hash)>] CustomerInteractionCenter
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 590 def get_cic_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_cic ..." end # resource path local_var_path = "/api/v2/identityproviders/cic".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CustomerInteractionCenter') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#get_cic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get G Suite Identity Provider
@param [Hash] opts the optional parameters @return [GSuite]
# File lib/purecloud/api/identity_provider_api.rb, line 636 def get_gsuite(opts = {}) data, status_code, headers = get_gsuite_with_http_info(opts) return data end
Get G Suite Identity Provider
@param [Hash] opts the optional parameters @return [Array<(GSuite
, Fixnum, Hash)>] GSuite
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 645 def get_gsuite_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_gsuite ..." end # resource path local_var_path = "/api/v2/identityproviders/gsuite".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GSuite') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#get_gsuite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get IdentityNow
Provider
@param [Hash] opts the optional parameters @return [IdentityNow]
# File lib/purecloud/api/identity_provider_api.rb, line 691 def get_identitynow(opts = {}) data, status_code, headers = get_identitynow_with_http_info(opts) return data end
Get IdentityNow
Provider
@param [Hash] opts the optional parameters @return [Array<(IdentityNow
, Fixnum, Hash)>] IdentityNow
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 700 def get_identitynow_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_identitynow ..." end # resource path local_var_path = "/api/v2/identityproviders/identitynow".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'IdentityNow') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#get_identitynow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
The list of identity providers
@param [Hash] opts the optional parameters @return [OAuthProviderEntityListing]
# File lib/purecloud/api/identity_provider_api.rb, line 746 def get_identityproviders(opts = {}) data, status_code, headers = get_identityproviders_with_http_info(opts) return data end
The list of identity providers
@param [Hash] opts the optional parameters @return [Array<(OAuthProviderEntityListing
, Fixnum, Hash)>] OAuthProviderEntityListing
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 755 def get_identityproviders_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_identityproviders ..." end # resource path local_var_path = "/api/v2/identityproviders".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'OAuthProviderEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#get_identityproviders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Okta
Identity Provider
@param [Hash] opts the optional parameters @return [Okta]
# File lib/purecloud/api/identity_provider_api.rb, line 801 def get_okta(opts = {}) data, status_code, headers = get_okta_with_http_info(opts) return data end
Get Okta
Identity Provider
@param [Hash] opts the optional parameters @return [Array<(Okta
, Fixnum, Hash)>] Okta
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 810 def get_okta_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_okta ..." end # resource path local_var_path = "/api/v2/identityproviders/okta".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Okta') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#get_okta\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get OneLogin
Identity Provider
@param [Hash] opts the optional parameters @return [OneLogin]
# File lib/purecloud/api/identity_provider_api.rb, line 856 def get_onelogin(opts = {}) data, status_code, headers = get_onelogin_with_http_info(opts) return data end
Get OneLogin
Identity Provider
@param [Hash] opts the optional parameters @return [Array<(OneLogin
, Fixnum, Hash)>] OneLogin
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 865 def get_onelogin_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_onelogin ..." end # resource path local_var_path = "/api/v2/identityproviders/onelogin".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'OneLogin') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#get_onelogin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Ping Identity Provider
@param [Hash] opts the optional parameters @return [PingIdentity]
# File lib/purecloud/api/identity_provider_api.rb, line 911 def get_ping(opts = {}) data, status_code, headers = get_ping_with_http_info(opts) return data end
Get Ping Identity Provider
@param [Hash] opts the optional parameters @return [Array<(PingIdentity
, Fixnum, Hash)>] PingIdentity
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 920 def get_ping_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_ping ..." end # resource path local_var_path = "/api/v2/identityproviders/ping".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PingIdentity') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#get_ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get PureCloud
Identity Provider
@param [Hash] opts the optional parameters @return [PureCloud]
# File lib/purecloud/api/identity_provider_api.rb, line 966 def get_purecloud(opts = {}) data, status_code, headers = get_purecloud_with_http_info(opts) return data end
Get PureCloud
Identity Provider
@param [Hash] opts the optional parameters @return [Array<(PureCloud
, Fixnum, Hash)>] PureCloud
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 975 def get_purecloud_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_purecloud ..." end # resource path local_var_path = "/api/v2/identityproviders/purecloud".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PureCloud') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#get_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Salesforce
Identity Provider
@param [Hash] opts the optional parameters @return [Salesforce]
# File lib/purecloud/api/identity_provider_api.rb, line 1021 def get_salesforce(opts = {}) data, status_code, headers = get_salesforce_with_http_info(opts) return data end
Get Salesforce
Identity Provider
@param [Hash] opts the optional parameters @return [Array<(Salesforce
, Fixnum, Hash)>] Salesforce
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 1030 def get_salesforce_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_salesforce ..." end # resource path local_var_path = "/api/v2/identityproviders/salesforce".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Salesforce') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#get_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update/Create ADFS
Identity Provider
@param body Provider @param [Hash] opts the optional parameters @return [OAuthProvider]
# File lib/purecloud/api/identity_provider_api.rb, line 1077 def put_adfs(body, opts = {}) data, status_code, headers = put_adfs_with_http_info(body, opts) return data end
Update/Create ADFS
Identity Provider
@param body Provider @param [Hash] opts the optional parameters @return [Array<(OAuthProvider
, Fixnum, Hash)>] OAuthProvider
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 1087 def put_adfs_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#put_adfs ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_adfs" if body.nil? # resource path local_var_path = "/api/v2/identityproviders/adfs".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'OAuthProvider') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#put_adfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update/Create Customer Interaction Center (CIC) Identity Provider
@param body Provider @param [Hash] opts the optional parameters @return [OAuthProvider]
# File lib/purecloud/api/identity_provider_api.rb, line 1137 def put_cic(body, opts = {}) data, status_code, headers = put_cic_with_http_info(body, opts) return data end
Update/Create Customer Interaction Center (CIC) Identity Provider
@param body Provider @param [Hash] opts the optional parameters @return [Array<(OAuthProvider
, Fixnum, Hash)>] OAuthProvider
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 1147 def put_cic_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#put_cic ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_cic" if body.nil? # resource path local_var_path = "/api/v2/identityproviders/cic".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'OAuthProvider') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#put_cic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update/Create G Suite Identity Provider
@param body Provider @param [Hash] opts the optional parameters @return [OAuthProvider]
# File lib/purecloud/api/identity_provider_api.rb, line 1197 def put_gsuite(body, opts = {}) data, status_code, headers = put_gsuite_with_http_info(body, opts) return data end
Update/Create G Suite Identity Provider
@param body Provider @param [Hash] opts the optional parameters @return [Array<(OAuthProvider
, Fixnum, Hash)>] OAuthProvider
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 1207 def put_gsuite_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#put_gsuite ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_gsuite" if body.nil? # resource path local_var_path = "/api/v2/identityproviders/gsuite".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'OAuthProvider') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#put_gsuite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update/Create IdentityNow
Provider
@param body Provider @param [Hash] opts the optional parameters @return [IdentityNow]
# File lib/purecloud/api/identity_provider_api.rb, line 1257 def put_identitynow(body, opts = {}) data, status_code, headers = put_identitynow_with_http_info(body, opts) return data end
Update/Create IdentityNow
Provider
@param body Provider @param [Hash] opts the optional parameters @return [Array<(IdentityNow
, Fixnum, Hash)>] IdentityNow
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 1267 def put_identitynow_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#put_identitynow ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_identitynow" if body.nil? # resource path local_var_path = "/api/v2/identityproviders/identitynow".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'IdentityNow') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#put_identitynow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update/Create Okta
Identity Provider
@param body Provider @param [Hash] opts the optional parameters @return [OAuthProvider]
# File lib/purecloud/api/identity_provider_api.rb, line 1317 def put_okta(body, opts = {}) data, status_code, headers = put_okta_with_http_info(body, opts) return data end
Update/Create Okta
Identity Provider
@param body Provider @param [Hash] opts the optional parameters @return [Array<(OAuthProvider
, Fixnum, Hash)>] OAuthProvider
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 1327 def put_okta_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#put_okta ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_okta" if body.nil? # resource path local_var_path = "/api/v2/identityproviders/okta".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'OAuthProvider') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#put_okta\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update/Create OneLogin
Identity Provider
@param body Provider @param [Hash] opts the optional parameters @return [OAuthProvider]
# File lib/purecloud/api/identity_provider_api.rb, line 1377 def put_onelogin(body, opts = {}) data, status_code, headers = put_onelogin_with_http_info(body, opts) return data end
Update/Create OneLogin
Identity Provider
@param body Provider @param [Hash] opts the optional parameters @return [Array<(OAuthProvider
, Fixnum, Hash)>] OAuthProvider
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 1387 def put_onelogin_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#put_onelogin ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_onelogin" if body.nil? # resource path local_var_path = "/api/v2/identityproviders/onelogin".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'OAuthProvider') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#put_onelogin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update/Create Ping Identity Provider
@param body Provider @param [Hash] opts the optional parameters @return [OAuthProvider]
# File lib/purecloud/api/identity_provider_api.rb, line 1437 def put_ping(body, opts = {}) data, status_code, headers = put_ping_with_http_info(body, opts) return data end
Update/Create Ping Identity Provider
@param body Provider @param [Hash] opts the optional parameters @return [Array<(OAuthProvider
, Fixnum, Hash)>] OAuthProvider
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 1447 def put_ping_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#put_ping ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_ping" if body.nil? # resource path local_var_path = "/api/v2/identityproviders/ping".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'OAuthProvider') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#put_ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update/Create PureCloud
Identity Provider
@param body Provider @param [Hash] opts the optional parameters @return [OAuthProvider]
# File lib/purecloud/api/identity_provider_api.rb, line 1497 def put_purecloud(body, opts = {}) data, status_code, headers = put_purecloud_with_http_info(body, opts) return data end
Update/Create PureCloud
Identity Provider
@param body Provider @param [Hash] opts the optional parameters @return [Array<(OAuthProvider
, Fixnum, Hash)>] OAuthProvider
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 1507 def put_purecloud_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#put_purecloud ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_purecloud" if body.nil? # resource path local_var_path = "/api/v2/identityproviders/purecloud".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'OAuthProvider') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#put_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update/Create Salesforce
Identity Provider
@param body Provider @param [Hash] opts the optional parameters @return [OAuthProvider]
# File lib/purecloud/api/identity_provider_api.rb, line 1557 def put_salesforce(body, opts = {}) data, status_code, headers = put_salesforce_with_http_info(body, opts) return data end
Update/Create Salesforce
Identity Provider
@param body Provider @param [Hash] opts the optional parameters @return [Array<(OAuthProvider
, Fixnum, Hash)>] OAuthProvider
data, response status code and response headers
# File lib/purecloud/api/identity_provider_api.rb, line 1567 def put_salesforce_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: IdentityProviderApi#put_salesforce ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_salesforce" if body.nil? # resource path local_var_path = "/api/v2/identityproviders/salesforce".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'OAuthProvider') if @api_client.config.debugging @api_client.config.logger.debug "API called: IdentityProviderApi#put_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end