purecloud 0.38.1 → 0.39.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/config-ruby.json +1 -1
- data/doc_out/AuthorizationApi.html.md +0 -57
- data/doc_out/AvailableLanguageList.html.md +13 -0
- data/doc_out/BillingContact.html.md +20 -0
- data/doc_out/{FlowHistoryResultItemEntityListing.html.md → BillingContactListing.html.md} +3 -3
- data/doc_out/CallRecord.html.md +2 -2
- data/doc_out/CallableContactsDiagnostic.html.md +3 -3
- data/doc_out/CallableTimeSet.html.md +3 -3
- data/doc_out/Campaign.html.md +3 -3
- data/doc_out/CampaignDiagnostics.html.md +3 -3
- data/doc_out/CampaignSchedule.html.md +6 -6
- data/doc_out/CampaignSequence.html.md +8 -8
- data/doc_out/CampaignStats.html.md +4 -4
- data/doc_out/Condition.html.md +7 -7
- data/doc_out/ConnectRate.html.md +3 -3
- data/doc_out/ContactCallbackRequest.html.md +5 -5
- data/doc_out/ContactList.html.md +9 -9
- data/doc_out/ContactPhoneNumberColumn.html.md +3 -3
- data/doc_out/CreateCallbackCommand.html.md +1 -0
- data/doc_out/CreateUser.html.md +1 -1
- data/doc_out/CustomerInteractionCenter.html.md +18 -0
- data/doc_out/DialerAction.html.md +4 -4
- data/doc_out/DialerContact.html.md +5 -5
- data/doc_out/DialerRule.html.md +6 -6
- data/doc_out/DncList.html.md +6 -7
- data/doc_out/ExternalContact.html.md +1 -0
- data/doc_out/ExternalDataSource.html.md +14 -0
- data/doc_out/ExternalOrganization.html.md +1 -0
- data/doc_out/IdentityProviderApi.html.md +1011 -0
- data/doc_out/ImportStatus.html.md +5 -5
- data/doc_out/InitiateScreenRecording.html.md +15 -0
- data/doc_out/JsonNode.html.md +3 -3
- data/doc_out/Keyword.html.md +19 -0
- data/doc_out/KeywordSet.html.md +21 -0
- data/doc_out/KeywordSetEntityListing.html.md +22 -0
- data/doc_out/OAuthApi.html.md +45 -886
- data/doc_out/OAuthClient.html.md +2 -2
- data/doc_out/Okta.html.md +1 -1
- data/doc_out/OneLogin.html.md +1 -1
- data/doc_out/OrgMediaUtilization.html.md +1 -0
- data/doc_out/OutboundApi.html.md +3 -3
- data/doc_out/PaymentMethod.html.md +3 -0
- data/doc_out/PhoneNumberStatus.html.md +1 -1
- data/doc_out/PolicyActions.html.md +1 -0
- data/doc_out/PresenceApi.html.md +68 -17
- data/doc_out/QualityApi.html.md +361 -0
- data/doc_out/QueueUtilizationDiagnostic.html.md +8 -8
- data/doc_out/ResponseSet.html.md +3 -3
- data/doc_out/RoutingApi.html.md +15 -12
- data/doc_out/RoutingSkill.html.md +1 -2
- data/doc_out/RuleSet.html.md +6 -6
- data/doc_out/Salesforce.html.md +1 -1
- data/doc_out/ScheduleInterval.html.md +14 -0
- data/doc_out/SequenceSchedule.html.md +6 -6
- data/doc_out/Station.html.md +1 -0
- data/doc_out/StationsApi.html.md +3 -1
- data/doc_out/SupportCredit.html.md +16 -0
- data/doc_out/SupportCreditListing.html.md +22 -0
- data/doc_out/SystemPresence.html.md +15 -0
- data/doc_out/TelephonyProvidersEdgeApi.html.md +112 -1
- data/doc_out/TrunkRecordingEnabledCount.html.md +14 -0
- data/doc_out/UserImage.html.md +1 -1
- data/doc_out/UserMe.html.md +5 -1
- data/doc_out/UserRoutingSkill.html.md +2 -2
- data/doc_out/UsersApi.html.md +182 -0
- data/doc_out/WrapUpCodeMapping.html.md +5 -5
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +15 -3
- data/lib/purecloud/api/authorization_api.rb +0 -60
- data/lib/purecloud/api/identity_provider_api.rb +1072 -0
- data/lib/purecloud/api/o_auth_api.rb +26 -906
- data/lib/purecloud/api/outbound_api.rb +2 -2
- data/lib/purecloud/api/presence_api.rb +67 -12
- data/lib/purecloud/api/quality_api.rb +378 -0
- data/lib/purecloud/api/routing_api.rb +21 -16
- data/lib/purecloud/api/stations_api.rb +3 -0
- data/lib/purecloud/api/telephony_providers_edge_api.rb +120 -0
- data/lib/purecloud/api/users_api.rb +189 -0
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/analytics_session.rb +1 -1
- data/lib/purecloud/models/available_language_list.rb +167 -0
- data/lib/purecloud/models/billing_contact.rb +237 -0
- data/lib/purecloud/models/{flow_history_result_item_entity_listing.rb → billing_contact_listing.rb} +2 -2
- data/lib/purecloud/models/call_record.rb +2 -1
- data/lib/purecloud/models/callable_contacts_diagnostic.rb +3 -0
- data/lib/purecloud/models/callable_time_set.rb +3 -3
- data/lib/purecloud/models/campaign.rb +3 -3
- data/lib/purecloud/models/campaign_diagnostics.rb +3 -0
- data/lib/purecloud/models/campaign_schedule.rb +7 -4
- data/lib/purecloud/models/campaign_sequence.rb +8 -3
- data/lib/purecloud/models/campaign_stats.rb +4 -0
- data/lib/purecloud/models/condition.rb +16 -0
- data/lib/purecloud/models/connect_rate.rb +3 -0
- data/lib/purecloud/models/contact_callback_request.rb +5 -0
- data/lib/purecloud/models/contact_list.rb +9 -3
- data/lib/purecloud/models/contact_phone_number_column.rb +3 -0
- data/lib/purecloud/models/create_callback_command.rb +12 -1
- data/lib/purecloud/models/create_user.rb +1 -0
- data/lib/purecloud/models/customer_interaction_center.rb +217 -0
- data/lib/purecloud/models/dialer_action.rb +31 -0
- data/lib/purecloud/models/dialer_contact.rb +5 -0
- data/lib/purecloud/models/dialer_rule.rb +15 -0
- data/lib/purecloud/models/dnc_list.rb +7 -14
- data/lib/purecloud/models/external_contact.rb +14 -1
- data/lib/purecloud/models/external_data_source.rb +176 -0
- data/lib/purecloud/models/external_organization.rb +14 -1
- data/lib/purecloud/models/import_status.rb +5 -0
- data/lib/purecloud/models/initiate_screen_recording.rb +187 -0
- data/lib/purecloud/models/json_node.rb +37 -37
- data/lib/purecloud/models/keyword.rb +227 -0
- data/lib/purecloud/models/keyword_set.rb +253 -0
- data/lib/purecloud/models/keyword_set_entity_listing.rb +257 -0
- data/lib/purecloud/models/o_auth_client.rb +3 -3
- data/lib/purecloud/models/okta.rb +11 -11
- data/lib/purecloud/models/one_login.rb +11 -11
- data/lib/purecloud/models/org_media_utilization.rb +17 -4
- data/lib/purecloud/models/organization_presence.rb +0 -9
- data/lib/purecloud/models/payment_method.rb +42 -1
- data/lib/purecloud/models/phone_number_status.rb +1 -0
- data/lib/purecloud/models/policy_actions.rb +14 -4
- data/lib/purecloud/models/queue_utilization_diagnostic.rb +8 -0
- data/lib/purecloud/models/response_set.rb +3 -3
- data/lib/purecloud/models/routing_skill.rb +2 -12
- data/lib/purecloud/models/routing_status.rb +1 -1
- data/lib/purecloud/models/rule_set.rb +6 -3
- data/lib/purecloud/models/salesforce.rb +11 -11
- data/lib/purecloud/models/{campaign_schedule_intervals.rb → schedule_interval.rb} +5 -5
- data/lib/purecloud/models/sequence_schedule.rb +7 -4
- data/lib/purecloud/models/station.rb +11 -1
- data/lib/purecloud/models/support_credit.rb +197 -0
- data/lib/purecloud/models/support_credit_listing.rb +257 -0
- data/lib/purecloud/models/system_presence.rb +187 -0
- data/lib/purecloud/models/trunk_recording_enabled_count.rb +177 -0
- data/lib/purecloud/models/user_image.rb +1 -0
- data/lib/purecloud/models/user_me.rb +50 -2
- data/lib/purecloud/models/user_routing_skill.rb +18 -11
- data/lib/purecloud/models/wrap_up_code_mapping.rb +5 -3
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +32 -8
- data/doc_out/CampaignScheduleIntervals.html.md +0 -14
- data/doc_out/ObjectsApi.html.md +0 -69
- data/lib/purecloud/api/objects_api.rb +0 -87
data/doc_out/DialerRule.html.md
CHANGED
@@ -7,12 +7,12 @@ title: DialerRule
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **id** | **String** |
|
11
|
-
| **name** | **String** |
|
12
|
-
| **order** | **Integer** |
|
13
|
-
| **category** | **String** |
|
14
|
-
| **conditions** | [**Array<Condition>**](Condition.html) |
|
15
|
-
| **actions** | [**Array<DialerAction>**](DialerAction.html) |
|
10
|
+
| **id** | **String** | The identifier of the rule | [optional] |
|
11
|
+
| **name** | **String** | The name of the rule | |
|
12
|
+
| **order** | **Integer** | The ranked order of the rule; rules are processed from lowest number to highest | [optional] |
|
13
|
+
| **category** | **String** | The category of the rule | |
|
14
|
+
| **conditions** | [**Array<Condition>**](Condition.html) | The list of rule conditions; all must evaluate to true to trigger the rule actions | |
|
15
|
+
| **actions** | [**Array<DialerAction>**](DialerAction.html) | The list of rule actions to be taken if the conditions are true | [optional] |
|
16
16
|
{: class="table table-striped"}
|
17
17
|
|
18
18
|
|
data/doc_out/DncList.html.md
CHANGED
@@ -9,13 +9,12 @@ title: DncList
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
11
|
| **name** | **String** | | [optional] |
|
12
|
-
| **date_created** | **DateTime** |
|
13
|
-
| **date_modified** | **DateTime** |
|
14
|
-
| **version** | **Integer** |
|
15
|
-
| **phone_number_columns** | **Array<String>** |
|
16
|
-
| **import_status** | [**ImportStatus**](ImportStatus.html) |
|
17
|
-
| **
|
18
|
-
| **size** | **Integer** | | [optional] |
|
12
|
+
| **date_created** | **DateTime** | Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
13
|
+
| **date_modified** | **DateTime** | Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
14
|
+
| **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
|
15
|
+
| **phone_number_columns** | **Array<String>** | the name of the columns containing the numbers not to be called | |
|
16
|
+
| **import_status** | [**ImportStatus**](ImportStatus.html) | the status of the import process | [optional] |
|
17
|
+
| **size** | **Integer** | the number of phone numbers in the do not call list | [optional] |
|
19
18
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
20
19
|
{: class="table table-striped"}
|
21
20
|
|
@@ -24,6 +24,7 @@ title: ExternalContact
|
|
24
24
|
| **modify_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
25
25
|
| **create_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
26
26
|
| **external_organization** | [**ExternalOrganization**](ExternalOrganization.html) | | [optional] |
|
27
|
+
| **external_data_sources** | [**Array<ExternalDataSource>**](ExternalDataSource.html) | Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param. | [optional] |
|
27
28
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
28
29
|
{: class="table table-striped"}
|
29
30
|
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: ExternalDataSource
|
3
|
+
---
|
4
|
+
## PureCloud::ExternalDataSource
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **platform** | **String** | | [optional] |
|
11
|
+
| **url** | **String** | | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -22,6 +22,7 @@ title: ExternalOrganization
|
|
22
22
|
| **tickers** | [**Array<Ticker>**](Ticker.html) | | [optional] |
|
23
23
|
| **modify_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
24
24
|
| **create_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
25
|
+
| **external_data_sources** | [**Array<ExternalDataSource>**](ExternalDataSource.html) | Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param. | [optional] |
|
25
26
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
26
27
|
{: class="table table-striped"}
|
27
28
|
|
@@ -0,0 +1,1011 @@
|
|
1
|
+
---
|
2
|
+
title: IdentityProviderApi
|
3
|
+
---
|
4
|
+
|
5
|
+
## PureCloud::IdentityProviderApi
|
6
|
+
|
7
|
+
All URIs are relative to *https://api.mypurecloud.com*
|
8
|
+
|
9
|
+
Method | HTTP request | Description
|
10
|
+
------------- | ------------- | -------------
|
11
|
+
|[**delete_cic**](IdentityProviderApi.html#delete_cic) | **DELETE** /api/v2/identityproviders/cic | Delete Customer Interaction Center (CIC) Identity Provider|
|
12
|
+
|[**delete_okta**](IdentityProviderApi.html#delete_okta) | **DELETE** /api/v2/identityproviders/okta | Delete Okta Identity Provider|
|
13
|
+
|[**delete_onelogin**](IdentityProviderApi.html#delete_onelogin) | **DELETE** /api/v2/identityproviders/onelogin | Delete OneLogin Identity Provider|
|
14
|
+
|[**delete_provider_id**](IdentityProviderApi.html#delete_provider_id) | **DELETE** /api/v2/identityproviders/{providerId} | Delete an identity provider|
|
15
|
+
|[**delete_purecloud**](IdentityProviderApi.html#delete_purecloud) | **DELETE** /api/v2/identityproviders/purecloud | Delete PureCloud Identity Provider|
|
16
|
+
|[**delete_salesforce**](IdentityProviderApi.html#delete_salesforce) | **DELETE** /api/v2/identityproviders/salesforce | Delete Salesforce Identity Provider|
|
17
|
+
|[**get_cic**](IdentityProviderApi.html#get_cic) | **GET** /api/v2/identityproviders/cic | Get Customer Interaction Center (CIC) Identity Provider|
|
18
|
+
|[**get_identityproviders**](IdentityProviderApi.html#get_identityproviders) | **GET** /api/v2/identityproviders | The list of identity providers|
|
19
|
+
|[**get_okta**](IdentityProviderApi.html#get_okta) | **GET** /api/v2/identityproviders/okta | Get Okta Identity Provider|
|
20
|
+
|[**get_onelogin**](IdentityProviderApi.html#get_onelogin) | **GET** /api/v2/identityproviders/onelogin | Get OneLogin Identity Provider|
|
21
|
+
|[**get_provider_id**](IdentityProviderApi.html#get_provider_id) | **GET** /api/v2/identityproviders/{providerId} | Get an identity provider|
|
22
|
+
|[**get_purecloud**](IdentityProviderApi.html#get_purecloud) | **GET** /api/v2/identityproviders/purecloud | Get PureCloud Identity Provider|
|
23
|
+
|[**get_salesforce**](IdentityProviderApi.html#get_salesforce) | **GET** /api/v2/identityproviders/salesforce | Get Salesforce Identity Provider|
|
24
|
+
|[**put_cic**](IdentityProviderApi.html#put_cic) | **PUT** /api/v2/identityproviders/cic | Update/Create Customer Interaction Center (CIC) Identity Provider|
|
25
|
+
|[**put_okta**](IdentityProviderApi.html#put_okta) | **PUT** /api/v2/identityproviders/okta | Update/Create Okta Identity Provider|
|
26
|
+
|[**put_onelogin**](IdentityProviderApi.html#put_onelogin) | **PUT** /api/v2/identityproviders/onelogin | Update/Create OneLogin Identity Provider|
|
27
|
+
|[**put_provider_id**](IdentityProviderApi.html#put_provider_id) | **PUT** /api/v2/identityproviders/{providerId} | Update an identity provider|
|
28
|
+
|[**put_purecloud**](IdentityProviderApi.html#put_purecloud) | **PUT** /api/v2/identityproviders/purecloud | Update/Create PureCloud Identity Provider|
|
29
|
+
|[**put_salesforce**](IdentityProviderApi.html#put_salesforce) | **PUT** /api/v2/identityproviders/salesforce | Update/Create Salesforce Identity Provider|
|
30
|
+
{: class="table table-striped"}
|
31
|
+
|
32
|
+
<a name="delete_cic"></a>
|
33
|
+
|
34
|
+
## - delete_cic
|
35
|
+
|
36
|
+
Delete Customer Interaction Center (CIC) Identity Provider
|
37
|
+
|
38
|
+
|
39
|
+
|
40
|
+
### Example
|
41
|
+
~~~ruby
|
42
|
+
# load the gem
|
43
|
+
require 'purecloud'
|
44
|
+
# setup authorization
|
45
|
+
@secret = ENV['PURECLOUD_SECRET']
|
46
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
47
|
+
environment = "mypurecloud.com"
|
48
|
+
|
49
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
50
|
+
|
51
|
+
PureCloud.configure do |config|
|
52
|
+
config.access_token = @authToken
|
53
|
+
end
|
54
|
+
|
55
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
56
|
+
|
57
|
+
begin
|
58
|
+
#Delete Customer Interaction Center (CIC) Identity Provider
|
59
|
+
api_instance.delete_cic
|
60
|
+
rescue PureCloud::ApiError => e
|
61
|
+
puts "Exception when calling IdentityProviderApi->delete_cic: #{e}"
|
62
|
+
end
|
63
|
+
~~~
|
64
|
+
|
65
|
+
### Parameters
|
66
|
+
This endpoint does not need any parameter.
|
67
|
+
{: class="table table-striped"}
|
68
|
+
|
69
|
+
|
70
|
+
### Return type
|
71
|
+
|
72
|
+
nil (empty response body)
|
73
|
+
|
74
|
+
### HTTP request headers
|
75
|
+
|
76
|
+
- **Content-Type**: application/json
|
77
|
+
- **Accept**: application/json
|
78
|
+
|
79
|
+
|
80
|
+
|
81
|
+
<a name="delete_okta"></a>
|
82
|
+
|
83
|
+
## - delete_okta
|
84
|
+
|
85
|
+
Delete Okta Identity Provider
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
### Example
|
90
|
+
~~~ruby
|
91
|
+
# load the gem
|
92
|
+
require 'purecloud'
|
93
|
+
# setup authorization
|
94
|
+
@secret = ENV['PURECLOUD_SECRET']
|
95
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
96
|
+
environment = "mypurecloud.com"
|
97
|
+
|
98
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
99
|
+
|
100
|
+
PureCloud.configure do |config|
|
101
|
+
config.access_token = @authToken
|
102
|
+
end
|
103
|
+
|
104
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
105
|
+
|
106
|
+
begin
|
107
|
+
#Delete Okta Identity Provider
|
108
|
+
api_instance.delete_okta
|
109
|
+
rescue PureCloud::ApiError => e
|
110
|
+
puts "Exception when calling IdentityProviderApi->delete_okta: #{e}"
|
111
|
+
end
|
112
|
+
~~~
|
113
|
+
|
114
|
+
### Parameters
|
115
|
+
This endpoint does not need any parameter.
|
116
|
+
{: class="table table-striped"}
|
117
|
+
|
118
|
+
|
119
|
+
### Return type
|
120
|
+
|
121
|
+
nil (empty response body)
|
122
|
+
|
123
|
+
### HTTP request headers
|
124
|
+
|
125
|
+
- **Content-Type**: application/json
|
126
|
+
- **Accept**: application/json
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
<a name="delete_onelogin"></a>
|
131
|
+
|
132
|
+
## - delete_onelogin
|
133
|
+
|
134
|
+
Delete OneLogin Identity Provider
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
### Example
|
139
|
+
~~~ruby
|
140
|
+
# load the gem
|
141
|
+
require 'purecloud'
|
142
|
+
# setup authorization
|
143
|
+
@secret = ENV['PURECLOUD_SECRET']
|
144
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
145
|
+
environment = "mypurecloud.com"
|
146
|
+
|
147
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
148
|
+
|
149
|
+
PureCloud.configure do |config|
|
150
|
+
config.access_token = @authToken
|
151
|
+
end
|
152
|
+
|
153
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
154
|
+
|
155
|
+
begin
|
156
|
+
#Delete OneLogin Identity Provider
|
157
|
+
api_instance.delete_onelogin
|
158
|
+
rescue PureCloud::ApiError => e
|
159
|
+
puts "Exception when calling IdentityProviderApi->delete_onelogin: #{e}"
|
160
|
+
end
|
161
|
+
~~~
|
162
|
+
|
163
|
+
### Parameters
|
164
|
+
This endpoint does not need any parameter.
|
165
|
+
{: class="table table-striped"}
|
166
|
+
|
167
|
+
|
168
|
+
### Return type
|
169
|
+
|
170
|
+
nil (empty response body)
|
171
|
+
|
172
|
+
### HTTP request headers
|
173
|
+
|
174
|
+
- **Content-Type**: application/json
|
175
|
+
- **Accept**: application/json
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
<a name="delete_provider_id"></a>
|
180
|
+
|
181
|
+
## - delete_provider_id
|
182
|
+
|
183
|
+
Delete an identity provider
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
### Example
|
188
|
+
~~~ruby
|
189
|
+
# load the gem
|
190
|
+
require 'purecloud'
|
191
|
+
# setup authorization
|
192
|
+
@secret = ENV['PURECLOUD_SECRET']
|
193
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
194
|
+
environment = "mypurecloud.com"
|
195
|
+
|
196
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
197
|
+
|
198
|
+
PureCloud.configure do |config|
|
199
|
+
config.access_token = @authToken
|
200
|
+
end
|
201
|
+
|
202
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
203
|
+
|
204
|
+
begin
|
205
|
+
#Delete an identity provider
|
206
|
+
api_instance.delete_provider_id
|
207
|
+
rescue PureCloud::ApiError => e
|
208
|
+
puts "Exception when calling IdentityProviderApi->delete_provider_id: #{e}"
|
209
|
+
end
|
210
|
+
~~~
|
211
|
+
|
212
|
+
### Parameters
|
213
|
+
This endpoint does not need any parameter.
|
214
|
+
{: class="table table-striped"}
|
215
|
+
|
216
|
+
|
217
|
+
### Return type
|
218
|
+
|
219
|
+
nil (empty response body)
|
220
|
+
|
221
|
+
### HTTP request headers
|
222
|
+
|
223
|
+
- **Content-Type**: application/json
|
224
|
+
- **Accept**: application/json
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
<a name="delete_purecloud"></a>
|
229
|
+
|
230
|
+
## - delete_purecloud
|
231
|
+
|
232
|
+
Delete PureCloud Identity Provider
|
233
|
+
|
234
|
+
|
235
|
+
|
236
|
+
### Example
|
237
|
+
~~~ruby
|
238
|
+
# load the gem
|
239
|
+
require 'purecloud'
|
240
|
+
# setup authorization
|
241
|
+
@secret = ENV['PURECLOUD_SECRET']
|
242
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
243
|
+
environment = "mypurecloud.com"
|
244
|
+
|
245
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
246
|
+
|
247
|
+
PureCloud.configure do |config|
|
248
|
+
config.access_token = @authToken
|
249
|
+
end
|
250
|
+
|
251
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
252
|
+
|
253
|
+
begin
|
254
|
+
#Delete PureCloud Identity Provider
|
255
|
+
api_instance.delete_purecloud
|
256
|
+
rescue PureCloud::ApiError => e
|
257
|
+
puts "Exception when calling IdentityProviderApi->delete_purecloud: #{e}"
|
258
|
+
end
|
259
|
+
~~~
|
260
|
+
|
261
|
+
### Parameters
|
262
|
+
This endpoint does not need any parameter.
|
263
|
+
{: class="table table-striped"}
|
264
|
+
|
265
|
+
|
266
|
+
### Return type
|
267
|
+
|
268
|
+
nil (empty response body)
|
269
|
+
|
270
|
+
### HTTP request headers
|
271
|
+
|
272
|
+
- **Content-Type**: application/json
|
273
|
+
- **Accept**: application/json
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
<a name="delete_salesforce"></a>
|
278
|
+
|
279
|
+
## - delete_salesforce
|
280
|
+
|
281
|
+
Delete Salesforce Identity Provider
|
282
|
+
|
283
|
+
|
284
|
+
|
285
|
+
### Example
|
286
|
+
~~~ruby
|
287
|
+
# load the gem
|
288
|
+
require 'purecloud'
|
289
|
+
# setup authorization
|
290
|
+
@secret = ENV['PURECLOUD_SECRET']
|
291
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
292
|
+
environment = "mypurecloud.com"
|
293
|
+
|
294
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
295
|
+
|
296
|
+
PureCloud.configure do |config|
|
297
|
+
config.access_token = @authToken
|
298
|
+
end
|
299
|
+
|
300
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
301
|
+
|
302
|
+
begin
|
303
|
+
#Delete Salesforce Identity Provider
|
304
|
+
api_instance.delete_salesforce
|
305
|
+
rescue PureCloud::ApiError => e
|
306
|
+
puts "Exception when calling IdentityProviderApi->delete_salesforce: #{e}"
|
307
|
+
end
|
308
|
+
~~~
|
309
|
+
|
310
|
+
### Parameters
|
311
|
+
This endpoint does not need any parameter.
|
312
|
+
{: class="table table-striped"}
|
313
|
+
|
314
|
+
|
315
|
+
### Return type
|
316
|
+
|
317
|
+
nil (empty response body)
|
318
|
+
|
319
|
+
### HTTP request headers
|
320
|
+
|
321
|
+
- **Content-Type**: application/json
|
322
|
+
- **Accept**: application/json
|
323
|
+
|
324
|
+
|
325
|
+
|
326
|
+
<a name="get_cic"></a>
|
327
|
+
|
328
|
+
## -[**CustomerInteractionCenter**](CustomerInteractionCenter.html) get_cic
|
329
|
+
|
330
|
+
Get Customer Interaction Center (CIC) Identity Provider
|
331
|
+
|
332
|
+
|
333
|
+
|
334
|
+
### Example
|
335
|
+
~~~ruby
|
336
|
+
# load the gem
|
337
|
+
require 'purecloud'
|
338
|
+
# setup authorization
|
339
|
+
@secret = ENV['PURECLOUD_SECRET']
|
340
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
341
|
+
environment = "mypurecloud.com"
|
342
|
+
|
343
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
344
|
+
|
345
|
+
PureCloud.configure do |config|
|
346
|
+
config.access_token = @authToken
|
347
|
+
end
|
348
|
+
|
349
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
350
|
+
|
351
|
+
begin
|
352
|
+
#Get Customer Interaction Center (CIC) Identity Provider
|
353
|
+
result = api_instance.get_cic
|
354
|
+
p result
|
355
|
+
rescue PureCloud::ApiError => e
|
356
|
+
puts "Exception when calling IdentityProviderApi->get_cic: #{e}"
|
357
|
+
end
|
358
|
+
~~~
|
359
|
+
|
360
|
+
### Parameters
|
361
|
+
This endpoint does not need any parameter.
|
362
|
+
{: class="table table-striped"}
|
363
|
+
|
364
|
+
|
365
|
+
### Return type
|
366
|
+
|
367
|
+
[**CustomerInteractionCenter**](CustomerInteractionCenter.html)
|
368
|
+
|
369
|
+
### HTTP request headers
|
370
|
+
|
371
|
+
- **Content-Type**: application/json
|
372
|
+
- **Accept**: application/json
|
373
|
+
|
374
|
+
|
375
|
+
|
376
|
+
<a name="get_identityproviders"></a>
|
377
|
+
|
378
|
+
## -[**OAuthProviderEntityListing**](OAuthProviderEntityListing.html) get_identityproviders
|
379
|
+
|
380
|
+
The list of identity providers
|
381
|
+
|
382
|
+
|
383
|
+
|
384
|
+
### Example
|
385
|
+
~~~ruby
|
386
|
+
# load the gem
|
387
|
+
require 'purecloud'
|
388
|
+
# setup authorization
|
389
|
+
@secret = ENV['PURECLOUD_SECRET']
|
390
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
391
|
+
environment = "mypurecloud.com"
|
392
|
+
|
393
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
394
|
+
|
395
|
+
PureCloud.configure do |config|
|
396
|
+
config.access_token = @authToken
|
397
|
+
end
|
398
|
+
|
399
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
400
|
+
|
401
|
+
begin
|
402
|
+
#The list of identity providers
|
403
|
+
result = api_instance.get_identityproviders
|
404
|
+
p result
|
405
|
+
rescue PureCloud::ApiError => e
|
406
|
+
puts "Exception when calling IdentityProviderApi->get_identityproviders: #{e}"
|
407
|
+
end
|
408
|
+
~~~
|
409
|
+
|
410
|
+
### Parameters
|
411
|
+
This endpoint does not need any parameter.
|
412
|
+
{: class="table table-striped"}
|
413
|
+
|
414
|
+
|
415
|
+
### Return type
|
416
|
+
|
417
|
+
[**OAuthProviderEntityListing**](OAuthProviderEntityListing.html)
|
418
|
+
|
419
|
+
### HTTP request headers
|
420
|
+
|
421
|
+
- **Content-Type**: application/json
|
422
|
+
- **Accept**: application/json
|
423
|
+
|
424
|
+
|
425
|
+
|
426
|
+
<a name="get_okta"></a>
|
427
|
+
|
428
|
+
## -[**Okta**](Okta.html) get_okta
|
429
|
+
|
430
|
+
Get Okta Identity Provider
|
431
|
+
|
432
|
+
|
433
|
+
|
434
|
+
### Example
|
435
|
+
~~~ruby
|
436
|
+
# load the gem
|
437
|
+
require 'purecloud'
|
438
|
+
# setup authorization
|
439
|
+
@secret = ENV['PURECLOUD_SECRET']
|
440
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
441
|
+
environment = "mypurecloud.com"
|
442
|
+
|
443
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
444
|
+
|
445
|
+
PureCloud.configure do |config|
|
446
|
+
config.access_token = @authToken
|
447
|
+
end
|
448
|
+
|
449
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
450
|
+
|
451
|
+
begin
|
452
|
+
#Get Okta Identity Provider
|
453
|
+
result = api_instance.get_okta
|
454
|
+
p result
|
455
|
+
rescue PureCloud::ApiError => e
|
456
|
+
puts "Exception when calling IdentityProviderApi->get_okta: #{e}"
|
457
|
+
end
|
458
|
+
~~~
|
459
|
+
|
460
|
+
### Parameters
|
461
|
+
This endpoint does not need any parameter.
|
462
|
+
{: class="table table-striped"}
|
463
|
+
|
464
|
+
|
465
|
+
### Return type
|
466
|
+
|
467
|
+
[**Okta**](Okta.html)
|
468
|
+
|
469
|
+
### HTTP request headers
|
470
|
+
|
471
|
+
- **Content-Type**: application/json
|
472
|
+
- **Accept**: application/json
|
473
|
+
|
474
|
+
|
475
|
+
|
476
|
+
<a name="get_onelogin"></a>
|
477
|
+
|
478
|
+
## -[**OneLogin**](OneLogin.html) get_onelogin
|
479
|
+
|
480
|
+
Get OneLogin Identity Provider
|
481
|
+
|
482
|
+
|
483
|
+
|
484
|
+
### Example
|
485
|
+
~~~ruby
|
486
|
+
# load the gem
|
487
|
+
require 'purecloud'
|
488
|
+
# setup authorization
|
489
|
+
@secret = ENV['PURECLOUD_SECRET']
|
490
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
491
|
+
environment = "mypurecloud.com"
|
492
|
+
|
493
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
494
|
+
|
495
|
+
PureCloud.configure do |config|
|
496
|
+
config.access_token = @authToken
|
497
|
+
end
|
498
|
+
|
499
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
500
|
+
|
501
|
+
begin
|
502
|
+
#Get OneLogin Identity Provider
|
503
|
+
result = api_instance.get_onelogin
|
504
|
+
p result
|
505
|
+
rescue PureCloud::ApiError => e
|
506
|
+
puts "Exception when calling IdentityProviderApi->get_onelogin: #{e}"
|
507
|
+
end
|
508
|
+
~~~
|
509
|
+
|
510
|
+
### Parameters
|
511
|
+
This endpoint does not need any parameter.
|
512
|
+
{: class="table table-striped"}
|
513
|
+
|
514
|
+
|
515
|
+
### Return type
|
516
|
+
|
517
|
+
[**OneLogin**](OneLogin.html)
|
518
|
+
|
519
|
+
### HTTP request headers
|
520
|
+
|
521
|
+
- **Content-Type**: application/json
|
522
|
+
- **Accept**: application/json
|
523
|
+
|
524
|
+
|
525
|
+
|
526
|
+
<a name="get_provider_id"></a>
|
527
|
+
|
528
|
+
## -[**OAuthProvider**](OAuthProvider.html) get_provider_id
|
529
|
+
|
530
|
+
Get an identity provider
|
531
|
+
|
532
|
+
|
533
|
+
|
534
|
+
### Example
|
535
|
+
~~~ruby
|
536
|
+
# load the gem
|
537
|
+
require 'purecloud'
|
538
|
+
# setup authorization
|
539
|
+
@secret = ENV['PURECLOUD_SECRET']
|
540
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
541
|
+
environment = "mypurecloud.com"
|
542
|
+
|
543
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
544
|
+
|
545
|
+
PureCloud.configure do |config|
|
546
|
+
config.access_token = @authToken
|
547
|
+
end
|
548
|
+
|
549
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
550
|
+
|
551
|
+
begin
|
552
|
+
#Get an identity provider
|
553
|
+
result = api_instance.get_provider_id
|
554
|
+
p result
|
555
|
+
rescue PureCloud::ApiError => e
|
556
|
+
puts "Exception when calling IdentityProviderApi->get_provider_id: #{e}"
|
557
|
+
end
|
558
|
+
~~~
|
559
|
+
|
560
|
+
### Parameters
|
561
|
+
This endpoint does not need any parameter.
|
562
|
+
{: class="table table-striped"}
|
563
|
+
|
564
|
+
|
565
|
+
### Return type
|
566
|
+
|
567
|
+
[**OAuthProvider**](OAuthProvider.html)
|
568
|
+
|
569
|
+
### HTTP request headers
|
570
|
+
|
571
|
+
- **Content-Type**: application/json
|
572
|
+
- **Accept**: application/json
|
573
|
+
|
574
|
+
|
575
|
+
|
576
|
+
<a name="get_purecloud"></a>
|
577
|
+
|
578
|
+
## -[**PureCloud**](PureCloud.html) get_purecloud
|
579
|
+
|
580
|
+
Get PureCloud Identity Provider
|
581
|
+
|
582
|
+
|
583
|
+
|
584
|
+
### Example
|
585
|
+
~~~ruby
|
586
|
+
# load the gem
|
587
|
+
require 'purecloud'
|
588
|
+
# setup authorization
|
589
|
+
@secret = ENV['PURECLOUD_SECRET']
|
590
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
591
|
+
environment = "mypurecloud.com"
|
592
|
+
|
593
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
594
|
+
|
595
|
+
PureCloud.configure do |config|
|
596
|
+
config.access_token = @authToken
|
597
|
+
end
|
598
|
+
|
599
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
600
|
+
|
601
|
+
begin
|
602
|
+
#Get PureCloud Identity Provider
|
603
|
+
result = api_instance.get_purecloud
|
604
|
+
p result
|
605
|
+
rescue PureCloud::ApiError => e
|
606
|
+
puts "Exception when calling IdentityProviderApi->get_purecloud: #{e}"
|
607
|
+
end
|
608
|
+
~~~
|
609
|
+
|
610
|
+
### Parameters
|
611
|
+
This endpoint does not need any parameter.
|
612
|
+
{: class="table table-striped"}
|
613
|
+
|
614
|
+
|
615
|
+
### Return type
|
616
|
+
|
617
|
+
[**PureCloud**](PureCloud.html)
|
618
|
+
|
619
|
+
### HTTP request headers
|
620
|
+
|
621
|
+
- **Content-Type**: application/json
|
622
|
+
- **Accept**: application/json
|
623
|
+
|
624
|
+
|
625
|
+
|
626
|
+
<a name="get_salesforce"></a>
|
627
|
+
|
628
|
+
## -[**Salesforce**](Salesforce.html) get_salesforce
|
629
|
+
|
630
|
+
Get Salesforce Identity Provider
|
631
|
+
|
632
|
+
|
633
|
+
|
634
|
+
### Example
|
635
|
+
~~~ruby
|
636
|
+
# load the gem
|
637
|
+
require 'purecloud'
|
638
|
+
# setup authorization
|
639
|
+
@secret = ENV['PURECLOUD_SECRET']
|
640
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
641
|
+
environment = "mypurecloud.com"
|
642
|
+
|
643
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
644
|
+
|
645
|
+
PureCloud.configure do |config|
|
646
|
+
config.access_token = @authToken
|
647
|
+
end
|
648
|
+
|
649
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
650
|
+
|
651
|
+
begin
|
652
|
+
#Get Salesforce Identity Provider
|
653
|
+
result = api_instance.get_salesforce
|
654
|
+
p result
|
655
|
+
rescue PureCloud::ApiError => e
|
656
|
+
puts "Exception when calling IdentityProviderApi->get_salesforce: #{e}"
|
657
|
+
end
|
658
|
+
~~~
|
659
|
+
|
660
|
+
### Parameters
|
661
|
+
This endpoint does not need any parameter.
|
662
|
+
{: class="table table-striped"}
|
663
|
+
|
664
|
+
|
665
|
+
### Return type
|
666
|
+
|
667
|
+
[**Salesforce**](Salesforce.html)
|
668
|
+
|
669
|
+
### HTTP request headers
|
670
|
+
|
671
|
+
- **Content-Type**: application/json
|
672
|
+
- **Accept**: application/json
|
673
|
+
|
674
|
+
|
675
|
+
|
676
|
+
<a name="put_cic"></a>
|
677
|
+
|
678
|
+
## - put_cic(opts)
|
679
|
+
|
680
|
+
Update/Create Customer Interaction Center (CIC) Identity Provider
|
681
|
+
|
682
|
+
|
683
|
+
|
684
|
+
### Example
|
685
|
+
~~~ruby
|
686
|
+
# load the gem
|
687
|
+
require 'purecloud'
|
688
|
+
# setup authorization
|
689
|
+
@secret = ENV['PURECLOUD_SECRET']
|
690
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
691
|
+
environment = "mypurecloud.com"
|
692
|
+
|
693
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
694
|
+
|
695
|
+
PureCloud.configure do |config|
|
696
|
+
config.access_token = @authToken
|
697
|
+
end
|
698
|
+
|
699
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
700
|
+
|
701
|
+
opts = {
|
702
|
+
body: PureCloud::CustomerInteractionCenter.new # CustomerInteractionCenter | Provider
|
703
|
+
}
|
704
|
+
|
705
|
+
begin
|
706
|
+
#Update/Create Customer Interaction Center (CIC) Identity Provider
|
707
|
+
api_instance.put_cic(opts)
|
708
|
+
rescue PureCloud::ApiError => e
|
709
|
+
puts "Exception when calling IdentityProviderApi->put_cic: #{e}"
|
710
|
+
end
|
711
|
+
~~~
|
712
|
+
|
713
|
+
### Parameters
|
714
|
+
|
715
|
+
Name | Type | Description | Notes
|
716
|
+
------------- | ------------- | ------------- | -------------
|
717
|
+
**body** | [**CustomerInteractionCenter**](CustomerInteractionCenter.html)| Provider | [optional]
|
718
|
+
{: class="table table-striped"}
|
719
|
+
|
720
|
+
|
721
|
+
### Return type
|
722
|
+
|
723
|
+
nil (empty response body)
|
724
|
+
|
725
|
+
### HTTP request headers
|
726
|
+
|
727
|
+
- **Content-Type**: application/json
|
728
|
+
- **Accept**: application/json
|
729
|
+
|
730
|
+
|
731
|
+
|
732
|
+
<a name="put_okta"></a>
|
733
|
+
|
734
|
+
## - put_okta(opts)
|
735
|
+
|
736
|
+
Update/Create Okta Identity Provider
|
737
|
+
|
738
|
+
|
739
|
+
|
740
|
+
### Example
|
741
|
+
~~~ruby
|
742
|
+
# load the gem
|
743
|
+
require 'purecloud'
|
744
|
+
# setup authorization
|
745
|
+
@secret = ENV['PURECLOUD_SECRET']
|
746
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
747
|
+
environment = "mypurecloud.com"
|
748
|
+
|
749
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
750
|
+
|
751
|
+
PureCloud.configure do |config|
|
752
|
+
config.access_token = @authToken
|
753
|
+
end
|
754
|
+
|
755
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
756
|
+
|
757
|
+
opts = {
|
758
|
+
body: PureCloud::Okta.new # Okta | Provider
|
759
|
+
}
|
760
|
+
|
761
|
+
begin
|
762
|
+
#Update/Create Okta Identity Provider
|
763
|
+
api_instance.put_okta(opts)
|
764
|
+
rescue PureCloud::ApiError => e
|
765
|
+
puts "Exception when calling IdentityProviderApi->put_okta: #{e}"
|
766
|
+
end
|
767
|
+
~~~
|
768
|
+
|
769
|
+
### Parameters
|
770
|
+
|
771
|
+
Name | Type | Description | Notes
|
772
|
+
------------- | ------------- | ------------- | -------------
|
773
|
+
**body** | [**Okta**](Okta.html)| Provider | [optional]
|
774
|
+
{: class="table table-striped"}
|
775
|
+
|
776
|
+
|
777
|
+
### Return type
|
778
|
+
|
779
|
+
nil (empty response body)
|
780
|
+
|
781
|
+
### HTTP request headers
|
782
|
+
|
783
|
+
- **Content-Type**: application/json
|
784
|
+
- **Accept**: application/json
|
785
|
+
|
786
|
+
|
787
|
+
|
788
|
+
<a name="put_onelogin"></a>
|
789
|
+
|
790
|
+
## - put_onelogin(opts)
|
791
|
+
|
792
|
+
Update/Create OneLogin Identity Provider
|
793
|
+
|
794
|
+
|
795
|
+
|
796
|
+
### Example
|
797
|
+
~~~ruby
|
798
|
+
# load the gem
|
799
|
+
require 'purecloud'
|
800
|
+
# setup authorization
|
801
|
+
@secret = ENV['PURECLOUD_SECRET']
|
802
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
803
|
+
environment = "mypurecloud.com"
|
804
|
+
|
805
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
806
|
+
|
807
|
+
PureCloud.configure do |config|
|
808
|
+
config.access_token = @authToken
|
809
|
+
end
|
810
|
+
|
811
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
812
|
+
|
813
|
+
opts = {
|
814
|
+
body: PureCloud::OneLogin.new # OneLogin | Provider
|
815
|
+
}
|
816
|
+
|
817
|
+
begin
|
818
|
+
#Update/Create OneLogin Identity Provider
|
819
|
+
api_instance.put_onelogin(opts)
|
820
|
+
rescue PureCloud::ApiError => e
|
821
|
+
puts "Exception when calling IdentityProviderApi->put_onelogin: #{e}"
|
822
|
+
end
|
823
|
+
~~~
|
824
|
+
|
825
|
+
### Parameters
|
826
|
+
|
827
|
+
Name | Type | Description | Notes
|
828
|
+
------------- | ------------- | ------------- | -------------
|
829
|
+
**body** | [**OneLogin**](OneLogin.html)| Provider | [optional]
|
830
|
+
{: class="table table-striped"}
|
831
|
+
|
832
|
+
|
833
|
+
### Return type
|
834
|
+
|
835
|
+
nil (empty response body)
|
836
|
+
|
837
|
+
### HTTP request headers
|
838
|
+
|
839
|
+
- **Content-Type**: application/json
|
840
|
+
- **Accept**: application/json
|
841
|
+
|
842
|
+
|
843
|
+
|
844
|
+
<a name="put_provider_id"></a>
|
845
|
+
|
846
|
+
## - put_provider_id(opts)
|
847
|
+
|
848
|
+
Update an identity provider
|
849
|
+
|
850
|
+
|
851
|
+
|
852
|
+
### Example
|
853
|
+
~~~ruby
|
854
|
+
# load the gem
|
855
|
+
require 'purecloud'
|
856
|
+
# setup authorization
|
857
|
+
@secret = ENV['PURECLOUD_SECRET']
|
858
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
859
|
+
environment = "mypurecloud.com"
|
860
|
+
|
861
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
862
|
+
|
863
|
+
PureCloud.configure do |config|
|
864
|
+
config.access_token = @authToken
|
865
|
+
end
|
866
|
+
|
867
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
868
|
+
|
869
|
+
opts = {
|
870
|
+
body: PureCloud::OAuthProvider.new # OAuthProvider | Provider
|
871
|
+
}
|
872
|
+
|
873
|
+
begin
|
874
|
+
#Update an identity provider
|
875
|
+
api_instance.put_provider_id(opts)
|
876
|
+
rescue PureCloud::ApiError => e
|
877
|
+
puts "Exception when calling IdentityProviderApi->put_provider_id: #{e}"
|
878
|
+
end
|
879
|
+
~~~
|
880
|
+
|
881
|
+
### Parameters
|
882
|
+
|
883
|
+
Name | Type | Description | Notes
|
884
|
+
------------- | ------------- | ------------- | -------------
|
885
|
+
**body** | [**OAuthProvider**](OAuthProvider.html)| Provider | [optional]
|
886
|
+
{: class="table table-striped"}
|
887
|
+
|
888
|
+
|
889
|
+
### Return type
|
890
|
+
|
891
|
+
nil (empty response body)
|
892
|
+
|
893
|
+
### HTTP request headers
|
894
|
+
|
895
|
+
- **Content-Type**: application/json
|
896
|
+
- **Accept**: application/json
|
897
|
+
|
898
|
+
|
899
|
+
|
900
|
+
<a name="put_purecloud"></a>
|
901
|
+
|
902
|
+
## - put_purecloud(opts)
|
903
|
+
|
904
|
+
Update/Create PureCloud Identity Provider
|
905
|
+
|
906
|
+
|
907
|
+
|
908
|
+
### Example
|
909
|
+
~~~ruby
|
910
|
+
# load the gem
|
911
|
+
require 'purecloud'
|
912
|
+
# setup authorization
|
913
|
+
@secret = ENV['PURECLOUD_SECRET']
|
914
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
915
|
+
environment = "mypurecloud.com"
|
916
|
+
|
917
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
918
|
+
|
919
|
+
PureCloud.configure do |config|
|
920
|
+
config.access_token = @authToken
|
921
|
+
end
|
922
|
+
|
923
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
924
|
+
|
925
|
+
opts = {
|
926
|
+
body: PureCloud::PureCloud.new # PureCloud | Provider
|
927
|
+
}
|
928
|
+
|
929
|
+
begin
|
930
|
+
#Update/Create PureCloud Identity Provider
|
931
|
+
api_instance.put_purecloud(opts)
|
932
|
+
rescue PureCloud::ApiError => e
|
933
|
+
puts "Exception when calling IdentityProviderApi->put_purecloud: #{e}"
|
934
|
+
end
|
935
|
+
~~~
|
936
|
+
|
937
|
+
### Parameters
|
938
|
+
|
939
|
+
Name | Type | Description | Notes
|
940
|
+
------------- | ------------- | ------------- | -------------
|
941
|
+
**body** | [**PureCloud**](PureCloud.html)| Provider | [optional]
|
942
|
+
{: class="table table-striped"}
|
943
|
+
|
944
|
+
|
945
|
+
### Return type
|
946
|
+
|
947
|
+
nil (empty response body)
|
948
|
+
|
949
|
+
### HTTP request headers
|
950
|
+
|
951
|
+
- **Content-Type**: application/json
|
952
|
+
- **Accept**: application/json
|
953
|
+
|
954
|
+
|
955
|
+
|
956
|
+
<a name="put_salesforce"></a>
|
957
|
+
|
958
|
+
## - put_salesforce(opts)
|
959
|
+
|
960
|
+
Update/Create Salesforce Identity Provider
|
961
|
+
|
962
|
+
|
963
|
+
|
964
|
+
### Example
|
965
|
+
~~~ruby
|
966
|
+
# load the gem
|
967
|
+
require 'purecloud'
|
968
|
+
# setup authorization
|
969
|
+
@secret = ENV['PURECLOUD_SECRET']
|
970
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
971
|
+
environment = "mypurecloud.com"
|
972
|
+
|
973
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
974
|
+
|
975
|
+
PureCloud.configure do |config|
|
976
|
+
config.access_token = @authToken
|
977
|
+
end
|
978
|
+
|
979
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
980
|
+
|
981
|
+
opts = {
|
982
|
+
body: PureCloud::Salesforce.new # Salesforce | Provider
|
983
|
+
}
|
984
|
+
|
985
|
+
begin
|
986
|
+
#Update/Create Salesforce Identity Provider
|
987
|
+
api_instance.put_salesforce(opts)
|
988
|
+
rescue PureCloud::ApiError => e
|
989
|
+
puts "Exception when calling IdentityProviderApi->put_salesforce: #{e}"
|
990
|
+
end
|
991
|
+
~~~
|
992
|
+
|
993
|
+
### Parameters
|
994
|
+
|
995
|
+
Name | Type | Description | Notes
|
996
|
+
------------- | ------------- | ------------- | -------------
|
997
|
+
**body** | [**Salesforce**](Salesforce.html)| Provider | [optional]
|
998
|
+
{: class="table table-striped"}
|
999
|
+
|
1000
|
+
|
1001
|
+
### Return type
|
1002
|
+
|
1003
|
+
nil (empty response body)
|
1004
|
+
|
1005
|
+
### HTTP request headers
|
1006
|
+
|
1007
|
+
- **Content-Type**: application/json
|
1008
|
+
- **Accept**: application/json
|
1009
|
+
|
1010
|
+
|
1011
|
+
|