--- title: IdentityProviderApi --- ## PureCloud::IdentityProviderApi All URIs are relative to *https://api.mypurecloud.com* Method | HTTP request | Description ------------- | ------------- | ------------- |[**delete_adfs**](IdentityProviderApi.html#delete_adfs) | **DELETE** /api/v2/identityproviders/adfs | Delete ADFS Identity Provider| |[**delete_cic**](IdentityProviderApi.html#delete_cic) | **DELETE** /api/v2/identityproviders/cic | Delete Customer Interaction Center (CIC) Identity Provider| |[**delete_okta**](IdentityProviderApi.html#delete_okta) | **DELETE** /api/v2/identityproviders/okta | Delete Okta Identity Provider| |[**delete_onelogin**](IdentityProviderApi.html#delete_onelogin) | **DELETE** /api/v2/identityproviders/onelogin | Delete OneLogin Identity Provider| |[**delete_provider_id**](IdentityProviderApi.html#delete_provider_id) | **DELETE** /api/v2/identityproviders/{providerId} | Delete an identity provider| |[**delete_purecloud**](IdentityProviderApi.html#delete_purecloud) | **DELETE** /api/v2/identityproviders/purecloud | Delete PureCloud Identity Provider| |[**delete_salesforce**](IdentityProviderApi.html#delete_salesforce) | **DELETE** /api/v2/identityproviders/salesforce | Delete Salesforce Identity Provider| |[**get_adfs**](IdentityProviderApi.html#get_adfs) | **GET** /api/v2/identityproviders/adfs | Get ADFS Identity Provider| |[**get_cic**](IdentityProviderApi.html#get_cic) | **GET** /api/v2/identityproviders/cic | Get Customer Interaction Center (CIC) Identity Provider| |[**get_identityproviders**](IdentityProviderApi.html#get_identityproviders) | **GET** /api/v2/identityproviders | The list of identity providers| |[**get_okta**](IdentityProviderApi.html#get_okta) | **GET** /api/v2/identityproviders/okta | Get Okta Identity Provider| |[**get_onelogin**](IdentityProviderApi.html#get_onelogin) | **GET** /api/v2/identityproviders/onelogin | Get OneLogin Identity Provider| |[**get_provider_id**](IdentityProviderApi.html#get_provider_id) | **GET** /api/v2/identityproviders/{providerId} | Get an identity provider| |[**get_purecloud**](IdentityProviderApi.html#get_purecloud) | **GET** /api/v2/identityproviders/purecloud | Get PureCloud Identity Provider| |[**get_salesforce**](IdentityProviderApi.html#get_salesforce) | **GET** /api/v2/identityproviders/salesforce | Get Salesforce Identity Provider| |[**put_adfs**](IdentityProviderApi.html#put_adfs) | **PUT** /api/v2/identityproviders/adfs | Update/Create ADFS Identity Provider| |[**put_cic**](IdentityProviderApi.html#put_cic) | **PUT** /api/v2/identityproviders/cic | Update/Create Customer Interaction Center (CIC) Identity Provider| |[**put_okta**](IdentityProviderApi.html#put_okta) | **PUT** /api/v2/identityproviders/okta | Update/Create Okta Identity Provider| |[**put_onelogin**](IdentityProviderApi.html#put_onelogin) | **PUT** /api/v2/identityproviders/onelogin | Update/Create OneLogin Identity Provider| |[**put_provider_id**](IdentityProviderApi.html#put_provider_id) | **PUT** /api/v2/identityproviders/{providerId} | Update an identity provider| |[**put_purecloud**](IdentityProviderApi.html#put_purecloud) | **PUT** /api/v2/identityproviders/purecloud | Update/Create PureCloud Identity Provider| |[**put_salesforce**](IdentityProviderApi.html#put_salesforce) | **PUT** /api/v2/identityproviders/salesforce | Update/Create Salesforce Identity Provider| {: class="table table-striped"} ## - delete_adfs Delete ADFS Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new begin #Delete ADFS Identity Provider api_instance.delete_adfs rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->delete_adfs: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - delete_cic Delete Customer Interaction Center (CIC) Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new begin #Delete Customer Interaction Center (CIC) Identity Provider api_instance.delete_cic rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->delete_cic: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - delete_okta Delete Okta Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new begin #Delete Okta Identity Provider api_instance.delete_okta rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->delete_okta: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - delete_onelogin Delete OneLogin Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new begin #Delete OneLogin Identity Provider api_instance.delete_onelogin rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->delete_onelogin: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - delete_provider_id Delete an identity provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new begin #Delete an identity provider api_instance.delete_provider_id rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->delete_provider_id: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - delete_purecloud Delete PureCloud Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new begin #Delete PureCloud Identity Provider api_instance.delete_purecloud rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->delete_purecloud: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - delete_salesforce Delete Salesforce Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new begin #Delete Salesforce Identity Provider api_instance.delete_salesforce rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->delete_salesforce: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ADFS**](ADFS.html) get_adfs Get ADFS Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new begin #Get ADFS Identity Provider result = api_instance.get_adfs p result rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->get_adfs: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**ADFS**](ADFS.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CustomerInteractionCenter**](CustomerInteractionCenter.html) get_cic Get Customer Interaction Center (CIC) Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new begin #Get Customer Interaction Center (CIC) Identity Provider result = api_instance.get_cic p result rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->get_cic: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**CustomerInteractionCenter**](CustomerInteractionCenter.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**OAuthProviderEntityListing**](OAuthProviderEntityListing.html) get_identityproviders The list of identity providers ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new begin #The list of identity providers result = api_instance.get_identityproviders p result rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->get_identityproviders: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**OAuthProviderEntityListing**](OAuthProviderEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Okta**](Okta.html) get_okta Get Okta Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new begin #Get Okta Identity Provider result = api_instance.get_okta p result rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->get_okta: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**Okta**](Okta.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**OneLogin**](OneLogin.html) get_onelogin Get OneLogin Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new begin #Get OneLogin Identity Provider result = api_instance.get_onelogin p result rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->get_onelogin: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**OneLogin**](OneLogin.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**OAuthProvider**](OAuthProvider.html) get_provider_id Get an identity provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new begin #Get an identity provider result = api_instance.get_provider_id p result rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->get_provider_id: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**OAuthProvider**](OAuthProvider.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**PureCloud**](PureCloud.html) get_purecloud Get PureCloud Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new begin #Get PureCloud Identity Provider result = api_instance.get_purecloud p result rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->get_purecloud: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**PureCloud**](PureCloud.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Salesforce**](Salesforce.html) get_salesforce Get Salesforce Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new begin #Get Salesforce Identity Provider result = api_instance.get_salesforce p result rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->get_salesforce: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**Salesforce**](Salesforce.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - put_adfs(body) Update/Create ADFS Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new body = PureCloud::ADFS.new # ADFS | Provider begin #Update/Create ADFS Identity Provider api_instance.put_adfs(body) rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->put_adfs: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**ADFS**](ADFS.html)| Provider | {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - put_cic(body) Update/Create Customer Interaction Center (CIC) Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new body = PureCloud::CustomerInteractionCenter.new # CustomerInteractionCenter | Provider begin #Update/Create Customer Interaction Center (CIC) Identity Provider api_instance.put_cic(body) rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->put_cic: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**CustomerInteractionCenter**](CustomerInteractionCenter.html)| Provider | {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - put_okta(body) Update/Create Okta Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new body = PureCloud::Okta.new # Okta | Provider begin #Update/Create Okta Identity Provider api_instance.put_okta(body) rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->put_okta: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Okta**](Okta.html)| Provider | {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - put_onelogin(body) Update/Create OneLogin Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new body = PureCloud::OneLogin.new # OneLogin | Provider begin #Update/Create OneLogin Identity Provider api_instance.put_onelogin(body) rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->put_onelogin: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OneLogin**](OneLogin.html)| Provider | {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - put_provider_id(body) Update an identity provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new body = PureCloud::OAuthProvider.new # OAuthProvider | Provider begin #Update an identity provider api_instance.put_provider_id(body) rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->put_provider_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OAuthProvider**](OAuthProvider.html)| Provider | {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - put_purecloud(body) Update/Create PureCloud Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new body = PureCloud::PureCloud.new # PureCloud | Provider begin #Update/Create PureCloud Identity Provider api_instance.put_purecloud(body) rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->put_purecloud: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**PureCloud**](PureCloud.html)| Provider | {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - put_salesforce(body) Update/Create Salesforce Identity Provider ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::IdentityProviderApi.new body = PureCloud::Salesforce.new # Salesforce | Provider begin #Update/Create Salesforce Identity Provider api_instance.put_salesforce(body) rescue PureCloud::ApiError => e puts "Exception when calling IdentityProviderApi->put_salesforce: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Salesforce**](Salesforce.html)| Provider | {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json