purecloud-platform-client-v2 136.1.0 → 137.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +9544 -9538
- package/dist/web-amd/purecloud-platform-client-v2.js +9544 -9538
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +9544 -9538
- package/dist/web-cjs/purecloud-platform-client-v2.js +9544 -9538
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +5262 -74
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +14 -5
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +56 -56
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +231 -231
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +534 -534
- package/src/purecloud-platform-client-v2/api/AuditApi.js +31 -31
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +212 -212
- package/src/purecloud-platform-client-v2/api/BillingApi.js +12 -12
- package/src/purecloud-platform-client-v2/api/ChatApi.js +16 -16
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +96 -96
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +192 -192
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +808 -808
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +17 -17
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +337 -337
- package/src/purecloud-platform-client-v2/api/FaxApi.js +31 -31
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +11 -11
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +246 -246
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +21 -21
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +26 -26
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +88 -88
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +72 -72
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +171 -171
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +311 -311
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +146 -146
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +131 -131
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +151 -151
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +51 -51
- package/src/purecloud-platform-client-v2/api/LearningApi.js +107 -107
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +49 -49
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +41 -41
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +26 -26
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +26 -26
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +43 -43
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +67 -67
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +50 -50
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +81 -81
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +162 -162
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +608 -608
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +64 -64
- package/src/purecloud-platform-client-v2/api/QualityApi.js +285 -285
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +302 -302
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +86 -86
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +536 -536
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +195 -195
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +66 -66
- package/src/purecloud-platform-client-v2/api/SearchApi.js +96 -96
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +194 -194
- package/src/purecloud-platform-client-v2/api/StationsApi.js +28 -28
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +21 -21
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +16 -16
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +657 -657
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +23 -23
- package/src/purecloud-platform-client-v2/api/TokensApi.js +21 -21
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +26 -26
- package/src/purecloud-platform-client-v2/api/UsageApi.js +11 -11
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +31 -31
- package/src/purecloud-platform-client-v2/api/UsersApi.js +413 -413
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +21 -21
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +140 -140
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +97 -97
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +66 -66
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +26 -26
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +765 -765
- package/src/purecloud-platform-client-v2/index.js +145 -149
|
@@ -5,7 +5,7 @@ class SCIMApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* SCIM service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 137.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -25,7 +25,7 @@ class SCIMApi {
|
|
|
25
25
|
*
|
|
26
26
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/users.
|
|
27
27
|
* @param {Object} opts Optional parameters
|
|
28
|
-
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example:
|
|
28
|
+
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: 42. If the ETag is different from the version on the server, returns 400 with a scimType of invalidVers.
|
|
29
29
|
*/
|
|
30
30
|
deleteScimUser(userId, opts) {
|
|
31
31
|
opts = opts || {};
|
|
@@ -38,13 +38,13 @@ class SCIMApi {
|
|
|
38
38
|
return this.apiClient.callApi(
|
|
39
39
|
'/api/v2/scim/users/{userId}',
|
|
40
40
|
'DELETE',
|
|
41
|
-
{ 'userId': userId },
|
|
42
|
-
{ },
|
|
43
|
-
{ 'If-Match': opts['ifMatch'] },
|
|
44
|
-
{ },
|
|
41
|
+
{ 'userId': userId },
|
|
42
|
+
{ },
|
|
43
|
+
{ 'If-Match': opts['ifMatch'] },
|
|
44
|
+
{ },
|
|
45
45
|
null,
|
|
46
46
|
['PureCloud OAuth'],
|
|
47
|
-
['application/
|
|
47
|
+
['application/json'],
|
|
48
48
|
['application/scim+json', 'application/json']
|
|
49
49
|
);
|
|
50
50
|
}
|
|
@@ -54,7 +54,7 @@ class SCIMApi {
|
|
|
54
54
|
*
|
|
55
55
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
56
56
|
* @param {Object} opts Optional parameters
|
|
57
|
-
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example:
|
|
57
|
+
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: 42. If the ETag is different from the version on the server, returns 400 with a scimType of invalidVers.
|
|
58
58
|
*/
|
|
59
59
|
deleteScimV2User(userId, opts) {
|
|
60
60
|
opts = opts || {};
|
|
@@ -67,13 +67,13 @@ class SCIMApi {
|
|
|
67
67
|
return this.apiClient.callApi(
|
|
68
68
|
'/api/v2/scim/v2/users/{userId}',
|
|
69
69
|
'DELETE',
|
|
70
|
-
{ 'userId': userId },
|
|
71
|
-
{ },
|
|
72
|
-
{ 'If-Match': opts['ifMatch'] },
|
|
73
|
-
{ },
|
|
70
|
+
{ 'userId': userId },
|
|
71
|
+
{ },
|
|
72
|
+
{ 'If-Match': opts['ifMatch'] },
|
|
73
|
+
{ },
|
|
74
74
|
null,
|
|
75
75
|
['PureCloud OAuth'],
|
|
76
|
-
['application/
|
|
76
|
+
['application/json'],
|
|
77
77
|
['application/scim+json', 'application/json']
|
|
78
78
|
);
|
|
79
79
|
}
|
|
@@ -83,9 +83,9 @@ class SCIMApi {
|
|
|
83
83
|
*
|
|
84
84
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
85
85
|
* @param {Object} opts Optional parameters
|
|
86
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
87
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus
|
|
88
|
-
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example:
|
|
86
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the id, active, and meta attributes. Use attributes to avoid expensive secondary calls for the default attributes.
|
|
87
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus excludedAttributes. Always returns id, active, and meta attributes. Use excludedAttributes to avoid expensive secondary calls for the default attributes.
|
|
88
|
+
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: 42. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
89
89
|
*/
|
|
90
90
|
getScimGroup(groupId, opts) {
|
|
91
91
|
opts = opts || {};
|
|
@@ -98,13 +98,13 @@ class SCIMApi {
|
|
|
98
98
|
return this.apiClient.callApi(
|
|
99
99
|
'/api/v2/scim/groups/{groupId}',
|
|
100
100
|
'GET',
|
|
101
|
-
{ 'groupId': groupId },
|
|
102
|
-
{ 'attributes': this.apiClient.buildCollectionParam(opts['attributes'], 'multi'),'excludedAttributes': this.apiClient.buildCollectionParam(opts['excludedAttributes'], 'multi') },
|
|
103
|
-
{ 'If-None-Match': opts['ifNoneMatch'] },
|
|
104
|
-
{ },
|
|
101
|
+
{ 'groupId': groupId },
|
|
102
|
+
{ 'attributes': this.apiClient.buildCollectionParam(opts['attributes'], 'multi'),'excludedAttributes': this.apiClient.buildCollectionParam(opts['excludedAttributes'], 'multi') },
|
|
103
|
+
{ 'If-None-Match': opts['ifNoneMatch'] },
|
|
104
|
+
{ },
|
|
105
105
|
null,
|
|
106
106
|
['PureCloud OAuth'],
|
|
107
|
-
['application/
|
|
107
|
+
['application/json'],
|
|
108
108
|
['application/scim+json', 'application/json']
|
|
109
109
|
);
|
|
110
110
|
}
|
|
@@ -114,10 +114,10 @@ class SCIMApi {
|
|
|
114
114
|
*
|
|
115
115
|
* @param {Object} opts Optional parameters
|
|
116
116
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
117
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns
|
|
118
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
119
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus
|
|
120
|
-
* @param {String} opts.filter Filters results. If nothing is specified, returns all groups. Examples of valid values:
|
|
117
|
+
* @param {Number} opts.count The requested number of items per page. A value of 0 returns totalResults. A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the excludedAttributes or attributes query parameters to exclude or only include secondary lookup values such as externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, or urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills. (default to 25)
|
|
118
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the id, active, and meta attributes. Use attributes to avoid expensive secondary calls for the default attributes.
|
|
119
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus excludedAttributes. Always returns id, active, and meta attributes. Use excludedAttributes to avoid expensive secondary calls for the default attributes.
|
|
120
|
+
* @param {String} opts.filter Filters results. If nothing is specified, returns all groups. Examples of valid values: id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3, displayname eq Sales.
|
|
121
121
|
*/
|
|
122
122
|
getScimGroups(opts) {
|
|
123
123
|
opts = opts || {};
|
|
@@ -126,13 +126,13 @@ class SCIMApi {
|
|
|
126
126
|
return this.apiClient.callApi(
|
|
127
127
|
'/api/v2/scim/groups',
|
|
128
128
|
'GET',
|
|
129
|
-
{ },
|
|
130
|
-
{ 'startIndex': opts['startIndex'],'count': opts['count'],'attributes': this.apiClient.buildCollectionParam(opts['attributes'], 'multi'),'excludedAttributes': this.apiClient.buildCollectionParam(opts['excludedAttributes'], 'multi'),'filter': opts['filter'] },
|
|
131
|
-
{ },
|
|
132
|
-
{ },
|
|
129
|
+
{ },
|
|
130
|
+
{ 'startIndex': opts['startIndex'],'count': opts['count'],'attributes': this.apiClient.buildCollectionParam(opts['attributes'], 'multi'),'excludedAttributes': this.apiClient.buildCollectionParam(opts['excludedAttributes'], 'multi'),'filter': opts['filter'] },
|
|
131
|
+
{ },
|
|
132
|
+
{ },
|
|
133
133
|
null,
|
|
134
134
|
['PureCloud OAuth'],
|
|
135
|
-
['application/
|
|
135
|
+
['application/json'],
|
|
136
136
|
['application/scim+json', 'application/json']
|
|
137
137
|
);
|
|
138
138
|
}
|
|
@@ -151,13 +151,13 @@ class SCIMApi {
|
|
|
151
151
|
return this.apiClient.callApi(
|
|
152
152
|
'/api/v2/scim/resourcetypes/{resourceType}',
|
|
153
153
|
'GET',
|
|
154
|
-
{ 'resourceType': resourceType },
|
|
155
|
-
{ },
|
|
156
|
-
{ },
|
|
157
|
-
{ },
|
|
154
|
+
{ 'resourceType': resourceType },
|
|
155
|
+
{ },
|
|
156
|
+
{ },
|
|
157
|
+
{ },
|
|
158
158
|
null,
|
|
159
159
|
['PureCloud OAuth'],
|
|
160
|
-
['application/
|
|
160
|
+
['application/json'],
|
|
161
161
|
['application/scim+json', 'application/json']
|
|
162
162
|
);
|
|
163
163
|
}
|
|
@@ -171,13 +171,13 @@ class SCIMApi {
|
|
|
171
171
|
return this.apiClient.callApi(
|
|
172
172
|
'/api/v2/scim/resourcetypes',
|
|
173
173
|
'GET',
|
|
174
|
-
{ },
|
|
175
|
-
{ },
|
|
176
|
-
{ },
|
|
177
|
-
{ },
|
|
174
|
+
{ },
|
|
175
|
+
{ },
|
|
176
|
+
{ },
|
|
177
|
+
{ },
|
|
178
178
|
null,
|
|
179
179
|
['PureCloud OAuth'],
|
|
180
|
-
['application/
|
|
180
|
+
['application/json'],
|
|
181
181
|
['application/scim+json', 'application/json']
|
|
182
182
|
);
|
|
183
183
|
}
|
|
@@ -196,13 +196,13 @@ class SCIMApi {
|
|
|
196
196
|
return this.apiClient.callApi(
|
|
197
197
|
'/api/v2/scim/schemas/{schemaId}',
|
|
198
198
|
'GET',
|
|
199
|
-
{ 'schemaId': schemaId },
|
|
200
|
-
{ },
|
|
201
|
-
{ },
|
|
202
|
-
{ },
|
|
199
|
+
{ 'schemaId': schemaId },
|
|
200
|
+
{ },
|
|
201
|
+
{ },
|
|
202
|
+
{ },
|
|
203
203
|
null,
|
|
204
204
|
['PureCloud OAuth'],
|
|
205
|
-
['application/
|
|
205
|
+
['application/json'],
|
|
206
206
|
['application/scim+json', 'application/json']
|
|
207
207
|
);
|
|
208
208
|
}
|
|
@@ -220,22 +220,22 @@ class SCIMApi {
|
|
|
220
220
|
return this.apiClient.callApi(
|
|
221
221
|
'/api/v2/scim/schemas',
|
|
222
222
|
'GET',
|
|
223
|
-
{ },
|
|
224
|
-
{ 'filter': opts['filter'] },
|
|
225
|
-
{ },
|
|
226
|
-
{ },
|
|
223
|
+
{ },
|
|
224
|
+
{ 'filter': opts['filter'] },
|
|
225
|
+
{ },
|
|
226
|
+
{ },
|
|
227
227
|
null,
|
|
228
228
|
['PureCloud OAuth'],
|
|
229
|
-
['application/
|
|
229
|
+
['application/json'],
|
|
230
230
|
['application/scim+json', 'application/json']
|
|
231
231
|
);
|
|
232
232
|
}
|
|
233
233
|
|
|
234
234
|
/**
|
|
235
|
-
* Get a service provider
|
|
235
|
+
* Get a service provider's configuration
|
|
236
236
|
*
|
|
237
237
|
* @param {Object} opts Optional parameters
|
|
238
|
-
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/serviceproviderconfig. Example:
|
|
238
|
+
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/serviceproviderconfig. Example: 42. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
239
239
|
*/
|
|
240
240
|
getScimServiceproviderconfig(opts) {
|
|
241
241
|
opts = opts || {};
|
|
@@ -244,13 +244,13 @@ class SCIMApi {
|
|
|
244
244
|
return this.apiClient.callApi(
|
|
245
245
|
'/api/v2/scim/serviceproviderconfig',
|
|
246
246
|
'GET',
|
|
247
|
-
{ },
|
|
248
|
-
{ },
|
|
249
|
-
{ 'If-None-Match': opts['ifNoneMatch'] },
|
|
250
|
-
{ },
|
|
247
|
+
{ },
|
|
248
|
+
{ },
|
|
249
|
+
{ 'If-None-Match': opts['ifNoneMatch'] },
|
|
250
|
+
{ },
|
|
251
251
|
null,
|
|
252
252
|
['PureCloud OAuth'],
|
|
253
|
-
['application/
|
|
253
|
+
['application/json'],
|
|
254
254
|
['application/scim+json', 'application/json']
|
|
255
255
|
);
|
|
256
256
|
}
|
|
@@ -260,9 +260,9 @@ class SCIMApi {
|
|
|
260
260
|
*
|
|
261
261
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/users.
|
|
262
262
|
* @param {Object} opts Optional parameters
|
|
263
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
264
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus
|
|
265
|
-
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example:
|
|
263
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the id, userName, active, and meta attributes. Use attributes to avoid expensive secondary calls for the default attributes.
|
|
264
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus excludedAttributes. Always returns the id, userName, active, and meta attributes. Use excludedAttributes to avoid expensive secondary calls for the default attributes.
|
|
265
|
+
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: 42. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
266
266
|
*/
|
|
267
267
|
getScimUser(userId, opts) {
|
|
268
268
|
opts = opts || {};
|
|
@@ -275,26 +275,26 @@ class SCIMApi {
|
|
|
275
275
|
return this.apiClient.callApi(
|
|
276
276
|
'/api/v2/scim/users/{userId}',
|
|
277
277
|
'GET',
|
|
278
|
-
{ 'userId': userId },
|
|
279
|
-
{ 'attributes': this.apiClient.buildCollectionParam(opts['attributes'], 'multi'),'excludedAttributes': this.apiClient.buildCollectionParam(opts['excludedAttributes'], 'multi') },
|
|
280
|
-
{ 'If-None-Match': opts['ifNoneMatch'] },
|
|
281
|
-
{ },
|
|
278
|
+
{ 'userId': userId },
|
|
279
|
+
{ 'attributes': this.apiClient.buildCollectionParam(opts['attributes'], 'multi'),'excludedAttributes': this.apiClient.buildCollectionParam(opts['excludedAttributes'], 'multi') },
|
|
280
|
+
{ 'If-None-Match': opts['ifNoneMatch'] },
|
|
281
|
+
{ },
|
|
282
282
|
null,
|
|
283
283
|
['PureCloud OAuth'],
|
|
284
|
-
['application/
|
|
284
|
+
['application/json'],
|
|
285
285
|
['application/scim+json', 'application/json']
|
|
286
286
|
);
|
|
287
287
|
}
|
|
288
288
|
|
|
289
289
|
/**
|
|
290
290
|
* Get a list of users
|
|
291
|
-
* To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to
|
|
291
|
+
* To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to "active eq false". By default, returns SCIM attributes "externalId", "enterprise-user:manager", and "roles". To exclude these attributes, set the attributes parameter to "id,active" or the excludeAttributes parameter to "externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division".
|
|
292
292
|
* @param {Object} opts Optional parameters
|
|
293
293
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
294
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns
|
|
295
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
296
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus
|
|
297
|
-
* @param {String} opts.filter Filters results. If nothing is specified, returns all active users. Examples of valid values:
|
|
294
|
+
* @param {Number} opts.count The requested number of items per page. A value of 0 returns totalResults. A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the excludedAttributes or attributes query parameters to exclude or only include secondary lookup values such as externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, or urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills. (default to 25)
|
|
295
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the id, userName, active, and meta attributes. Use attributes to avoid expensive secondary calls for the default attributes.
|
|
296
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus excludedAttributes. Always returns the id, userName, active, and meta attributes. Use excludedAttributes to avoid expensive secondary calls for the default attributes.
|
|
297
|
+
* @param {String} opts.filter Filters results. If nothing is specified, returns all active users. Examples of valid values: id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9, userName eq search@sample.org, manager eq 16e10e2f-1136-43fe-bb84-eac073168a49, email eq search@sample.org, division eq divisionName, externalId eq 167844, active eq false, employeeNumber eq 9876543210.
|
|
298
298
|
*/
|
|
299
299
|
getScimUsers(opts) {
|
|
300
300
|
opts = opts || {};
|
|
@@ -303,13 +303,13 @@ class SCIMApi {
|
|
|
303
303
|
return this.apiClient.callApi(
|
|
304
304
|
'/api/v2/scim/users',
|
|
305
305
|
'GET',
|
|
306
|
-
{ },
|
|
307
|
-
{ 'startIndex': opts['startIndex'],'count': opts['count'],'attributes': this.apiClient.buildCollectionParam(opts['attributes'], 'multi'),'excludedAttributes': this.apiClient.buildCollectionParam(opts['excludedAttributes'], 'multi'),'filter': opts['filter'] },
|
|
308
|
-
{ },
|
|
309
|
-
{ },
|
|
306
|
+
{ },
|
|
307
|
+
{ 'startIndex': opts['startIndex'],'count': opts['count'],'attributes': this.apiClient.buildCollectionParam(opts['attributes'], 'multi'),'excludedAttributes': this.apiClient.buildCollectionParam(opts['excludedAttributes'], 'multi'),'filter': opts['filter'] },
|
|
308
|
+
{ },
|
|
309
|
+
{ },
|
|
310
310
|
null,
|
|
311
311
|
['PureCloud OAuth'],
|
|
312
|
-
['application/
|
|
312
|
+
['application/json'],
|
|
313
313
|
['application/scim+json', 'application/json']
|
|
314
314
|
);
|
|
315
315
|
}
|
|
@@ -319,9 +319,9 @@ class SCIMApi {
|
|
|
319
319
|
*
|
|
320
320
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
321
321
|
* @param {Object} opts Optional parameters
|
|
322
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
323
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus
|
|
324
|
-
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example:
|
|
322
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the id, active, and meta attributes. Use attributes to avoid expensive secondary calls for the default attributes.
|
|
323
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus excludedAttributes. Always returns id, active, and meta attributes. Use excludedAttributes to avoid expensive secondary calls for the default attributes.
|
|
324
|
+
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: 42. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
325
325
|
*/
|
|
326
326
|
getScimV2Group(groupId, opts) {
|
|
327
327
|
opts = opts || {};
|
|
@@ -334,13 +334,13 @@ class SCIMApi {
|
|
|
334
334
|
return this.apiClient.callApi(
|
|
335
335
|
'/api/v2/scim/v2/groups/{groupId}',
|
|
336
336
|
'GET',
|
|
337
|
-
{ 'groupId': groupId },
|
|
338
|
-
{ 'attributes': this.apiClient.buildCollectionParam(opts['attributes'], 'multi'),'excludedAttributes': this.apiClient.buildCollectionParam(opts['excludedAttributes'], 'multi') },
|
|
339
|
-
{ 'If-None-Match': opts['ifNoneMatch'] },
|
|
340
|
-
{ },
|
|
337
|
+
{ 'groupId': groupId },
|
|
338
|
+
{ 'attributes': this.apiClient.buildCollectionParam(opts['attributes'], 'multi'),'excludedAttributes': this.apiClient.buildCollectionParam(opts['excludedAttributes'], 'multi') },
|
|
339
|
+
{ 'If-None-Match': opts['ifNoneMatch'] },
|
|
340
|
+
{ },
|
|
341
341
|
null,
|
|
342
342
|
['PureCloud OAuth'],
|
|
343
|
-
['application/
|
|
343
|
+
['application/json'],
|
|
344
344
|
['application/scim+json', 'application/json']
|
|
345
345
|
);
|
|
346
346
|
}
|
|
@@ -348,12 +348,12 @@ class SCIMApi {
|
|
|
348
348
|
/**
|
|
349
349
|
* Get a list of groups
|
|
350
350
|
*
|
|
351
|
-
* @param {String} filter Filters results. If nothing is specified, returns all groups. Examples of valid values:
|
|
351
|
+
* @param {String} filter Filters results. If nothing is specified, returns all groups. Examples of valid values: id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3, displayname eq Sales.
|
|
352
352
|
* @param {Object} opts Optional parameters
|
|
353
353
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
354
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns
|
|
355
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
356
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus
|
|
354
|
+
* @param {Number} opts.count The requested number of items per page. A value of 0 returns totalResults. A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the excludedAttributes or attributes query parameters to exclude or only include secondary lookup values such as externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, or urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills. (default to 25)
|
|
355
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the id, active, and meta attributes. Use attributes to avoid expensive secondary calls for the default attributes.
|
|
356
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus excludedAttributes. Always returns id, active, and meta attributes. Use excludedAttributes to avoid expensive secondary calls for the default attributes.
|
|
357
357
|
*/
|
|
358
358
|
getScimV2Groups(filter, opts) {
|
|
359
359
|
opts = opts || {};
|
|
@@ -366,13 +366,13 @@ class SCIMApi {
|
|
|
366
366
|
return this.apiClient.callApi(
|
|
367
367
|
'/api/v2/scim/v2/groups',
|
|
368
368
|
'GET',
|
|
369
|
-
{ },
|
|
370
|
-
{ 'startIndex': opts['startIndex'],'count': opts['count'],'attributes': this.apiClient.buildCollectionParam(opts['attributes'], 'multi'),'excludedAttributes': this.apiClient.buildCollectionParam(opts['excludedAttributes'], 'multi'),'filter': filter },
|
|
371
|
-
{ },
|
|
372
|
-
{ },
|
|
369
|
+
{ },
|
|
370
|
+
{ 'startIndex': opts['startIndex'],'count': opts['count'],'attributes': this.apiClient.buildCollectionParam(opts['attributes'], 'multi'),'excludedAttributes': this.apiClient.buildCollectionParam(opts['excludedAttributes'], 'multi'),'filter': filter },
|
|
371
|
+
{ },
|
|
372
|
+
{ },
|
|
373
373
|
null,
|
|
374
374
|
['PureCloud OAuth'],
|
|
375
|
-
['application/
|
|
375
|
+
['application/json'],
|
|
376
376
|
['application/scim+json', 'application/json']
|
|
377
377
|
);
|
|
378
378
|
}
|
|
@@ -391,13 +391,13 @@ class SCIMApi {
|
|
|
391
391
|
return this.apiClient.callApi(
|
|
392
392
|
'/api/v2/scim/v2/resourcetypes/{resourceType}',
|
|
393
393
|
'GET',
|
|
394
|
-
{ 'resourceType': resourceType },
|
|
395
|
-
{ },
|
|
396
|
-
{ },
|
|
397
|
-
{ },
|
|
394
|
+
{ 'resourceType': resourceType },
|
|
395
|
+
{ },
|
|
396
|
+
{ },
|
|
397
|
+
{ },
|
|
398
398
|
null,
|
|
399
399
|
['PureCloud OAuth'],
|
|
400
|
-
['application/
|
|
400
|
+
['application/json'],
|
|
401
401
|
['application/scim+json', 'application/json']
|
|
402
402
|
);
|
|
403
403
|
}
|
|
@@ -411,13 +411,13 @@ class SCIMApi {
|
|
|
411
411
|
return this.apiClient.callApi(
|
|
412
412
|
'/api/v2/scim/v2/resourcetypes',
|
|
413
413
|
'GET',
|
|
414
|
-
{ },
|
|
415
|
-
{ },
|
|
416
|
-
{ },
|
|
417
|
-
{ },
|
|
414
|
+
{ },
|
|
415
|
+
{ },
|
|
416
|
+
{ },
|
|
417
|
+
{ },
|
|
418
418
|
null,
|
|
419
419
|
['PureCloud OAuth'],
|
|
420
|
-
['application/
|
|
420
|
+
['application/json'],
|
|
421
421
|
['application/scim+json', 'application/json']
|
|
422
422
|
);
|
|
423
423
|
}
|
|
@@ -436,13 +436,13 @@ class SCIMApi {
|
|
|
436
436
|
return this.apiClient.callApi(
|
|
437
437
|
'/api/v2/scim/v2/schemas/{schemaId}',
|
|
438
438
|
'GET',
|
|
439
|
-
{ 'schemaId': schemaId },
|
|
440
|
-
{ },
|
|
441
|
-
{ },
|
|
442
|
-
{ },
|
|
439
|
+
{ 'schemaId': schemaId },
|
|
440
|
+
{ },
|
|
441
|
+
{ },
|
|
442
|
+
{ },
|
|
443
443
|
null,
|
|
444
444
|
['PureCloud OAuth'],
|
|
445
|
-
['application/
|
|
445
|
+
['application/json'],
|
|
446
446
|
['application/scim+json', 'application/json']
|
|
447
447
|
);
|
|
448
448
|
}
|
|
@@ -460,22 +460,22 @@ class SCIMApi {
|
|
|
460
460
|
return this.apiClient.callApi(
|
|
461
461
|
'/api/v2/scim/v2/schemas',
|
|
462
462
|
'GET',
|
|
463
|
-
{ },
|
|
464
|
-
{ 'filter': opts['filter'] },
|
|
465
|
-
{ },
|
|
466
|
-
{ },
|
|
463
|
+
{ },
|
|
464
|
+
{ 'filter': opts['filter'] },
|
|
465
|
+
{ },
|
|
466
|
+
{ },
|
|
467
467
|
null,
|
|
468
468
|
['PureCloud OAuth'],
|
|
469
|
-
['application/
|
|
469
|
+
['application/json'],
|
|
470
470
|
['application/scim+json', 'application/json']
|
|
471
471
|
);
|
|
472
472
|
}
|
|
473
473
|
|
|
474
474
|
/**
|
|
475
|
-
* Get a service provider
|
|
475
|
+
* Get a service provider's configuration
|
|
476
476
|
*
|
|
477
477
|
* @param {Object} opts Optional parameters
|
|
478
|
-
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/serviceproviderconfig. Example:
|
|
478
|
+
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/serviceproviderconfig. Example: 42. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
479
479
|
*/
|
|
480
480
|
getScimV2Serviceproviderconfig(opts) {
|
|
481
481
|
opts = opts || {};
|
|
@@ -484,13 +484,13 @@ class SCIMApi {
|
|
|
484
484
|
return this.apiClient.callApi(
|
|
485
485
|
'/api/v2/scim/v2/serviceproviderconfig',
|
|
486
486
|
'GET',
|
|
487
|
-
{ },
|
|
488
|
-
{ },
|
|
489
|
-
{ 'If-None-Match': opts['ifNoneMatch'] },
|
|
490
|
-
{ },
|
|
487
|
+
{ },
|
|
488
|
+
{ },
|
|
489
|
+
{ 'If-None-Match': opts['ifNoneMatch'] },
|
|
490
|
+
{ },
|
|
491
491
|
null,
|
|
492
492
|
['PureCloud OAuth'],
|
|
493
|
-
['application/
|
|
493
|
+
['application/json'],
|
|
494
494
|
['application/scim+json', 'application/json']
|
|
495
495
|
);
|
|
496
496
|
}
|
|
@@ -500,9 +500,9 @@ class SCIMApi {
|
|
|
500
500
|
*
|
|
501
501
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
502
502
|
* @param {Object} opts Optional parameters
|
|
503
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
504
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus
|
|
505
|
-
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example:
|
|
503
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the id, userName, active, and meta attributes. Use attributes to avoid expensive secondary calls for the default attributes.
|
|
504
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus excludedAttributes. Always returns the id, userName, active, and meta attributes. Use excludedAttributes to avoid expensive secondary calls for the default attributes.
|
|
505
|
+
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: 42. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
506
506
|
*/
|
|
507
507
|
getScimV2User(userId, opts) {
|
|
508
508
|
opts = opts || {};
|
|
@@ -515,26 +515,26 @@ class SCIMApi {
|
|
|
515
515
|
return this.apiClient.callApi(
|
|
516
516
|
'/api/v2/scim/v2/users/{userId}',
|
|
517
517
|
'GET',
|
|
518
|
-
{ 'userId': userId },
|
|
519
|
-
{ 'attributes': this.apiClient.buildCollectionParam(opts['attributes'], 'multi'),'excludedAttributes': this.apiClient.buildCollectionParam(opts['excludedAttributes'], 'multi') },
|
|
520
|
-
{ 'If-None-Match': opts['ifNoneMatch'] },
|
|
521
|
-
{ },
|
|
518
|
+
{ 'userId': userId },
|
|
519
|
+
{ 'attributes': this.apiClient.buildCollectionParam(opts['attributes'], 'multi'),'excludedAttributes': this.apiClient.buildCollectionParam(opts['excludedAttributes'], 'multi') },
|
|
520
|
+
{ 'If-None-Match': opts['ifNoneMatch'] },
|
|
521
|
+
{ },
|
|
522
522
|
null,
|
|
523
523
|
['PureCloud OAuth'],
|
|
524
|
-
['application/
|
|
524
|
+
['application/json'],
|
|
525
525
|
['application/scim+json', 'application/json']
|
|
526
526
|
);
|
|
527
527
|
}
|
|
528
528
|
|
|
529
529
|
/**
|
|
530
530
|
* Get a list of users
|
|
531
|
-
* To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to
|
|
531
|
+
* To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to "active eq false". By default, returns SCIM attributes "externalId", "enterprise-user:manager", and "roles". To exclude these attributes, set the attributes parameter to "id,active" or the excludeAttributes parameter to "externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division".
|
|
532
532
|
* @param {Object} opts Optional parameters
|
|
533
533
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
534
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns
|
|
535
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
536
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus
|
|
537
|
-
* @param {String} opts.filter Filters results. If nothing is specified, returns all active users. Examples of valid values:
|
|
534
|
+
* @param {Number} opts.count The requested number of items per page. A value of 0 returns totalResults. A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the excludedAttributes or attributes query parameters to exclude or only include secondary lookup values such as externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, or urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills. (default to 25)
|
|
535
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the id, userName, active, and meta attributes. Use attributes to avoid expensive secondary calls for the default attributes.
|
|
536
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus excludedAttributes. Always returns the id, userName, active, and meta attributes. Use excludedAttributes to avoid expensive secondary calls for the default attributes.
|
|
537
|
+
* @param {String} opts.filter Filters results. If nothing is specified, returns all active users. Examples of valid values: id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9, userName eq search@sample.org, manager eq 16e10e2f-1136-43fe-bb84-eac073168a49, email eq search@sample.org, division eq divisionName, externalId eq 167844, active eq false, employeeNumber eq 9876543210.
|
|
538
538
|
*/
|
|
539
539
|
getScimV2Users(opts) {
|
|
540
540
|
opts = opts || {};
|
|
@@ -543,13 +543,13 @@ class SCIMApi {
|
|
|
543
543
|
return this.apiClient.callApi(
|
|
544
544
|
'/api/v2/scim/v2/users',
|
|
545
545
|
'GET',
|
|
546
|
-
{ },
|
|
547
|
-
{ 'startIndex': opts['startIndex'],'count': opts['count'],'attributes': this.apiClient.buildCollectionParam(opts['attributes'], 'multi'),'excludedAttributes': this.apiClient.buildCollectionParam(opts['excludedAttributes'], 'multi'),'filter': opts['filter'] },
|
|
548
|
-
{ },
|
|
549
|
-
{ },
|
|
546
|
+
{ },
|
|
547
|
+
{ 'startIndex': opts['startIndex'],'count': opts['count'],'attributes': this.apiClient.buildCollectionParam(opts['attributes'], 'multi'),'excludedAttributes': this.apiClient.buildCollectionParam(opts['excludedAttributes'], 'multi'),'filter': opts['filter'] },
|
|
548
|
+
{ },
|
|
549
|
+
{ },
|
|
550
550
|
null,
|
|
551
551
|
['PureCloud OAuth'],
|
|
552
|
-
['application/
|
|
552
|
+
['application/json'],
|
|
553
553
|
['application/scim+json', 'application/json']
|
|
554
554
|
);
|
|
555
555
|
}
|
|
@@ -560,7 +560,7 @@ class SCIMApi {
|
|
|
560
560
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
561
561
|
* @param {Object} body The information used to modify a group.
|
|
562
562
|
* @param {Object} opts Optional parameters
|
|
563
|
-
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example:
|
|
563
|
+
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: 42. If the ETag is different from the version on the server, returns 400 with a scimType of invalidVers.
|
|
564
564
|
*/
|
|
565
565
|
patchScimGroup(groupId, body, opts) {
|
|
566
566
|
opts = opts || {};
|
|
@@ -577,13 +577,13 @@ class SCIMApi {
|
|
|
577
577
|
return this.apiClient.callApi(
|
|
578
578
|
'/api/v2/scim/groups/{groupId}',
|
|
579
579
|
'PATCH',
|
|
580
|
-
{ 'groupId': groupId },
|
|
581
|
-
{ },
|
|
582
|
-
{ 'If-Match': opts['ifMatch'] },
|
|
583
|
-
{ },
|
|
580
|
+
{ 'groupId': groupId },
|
|
581
|
+
{ },
|
|
582
|
+
{ 'If-Match': opts['ifMatch'] },
|
|
583
|
+
{ },
|
|
584
584
|
body,
|
|
585
585
|
['PureCloud OAuth'],
|
|
586
|
-
['application/scim+json', 'application/json'],
|
|
586
|
+
['application/scim+json', 'application/json'],
|
|
587
587
|
['application/scim+json', 'application/json']
|
|
588
588
|
);
|
|
589
589
|
}
|
|
@@ -594,7 +594,7 @@ class SCIMApi {
|
|
|
594
594
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/users.
|
|
595
595
|
* @param {Object} body The information used to modify a user.
|
|
596
596
|
* @param {Object} opts Optional parameters
|
|
597
|
-
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example:
|
|
597
|
+
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: 42. If the ETag is different from the version on the server, returns 400 with a scimType of invalidVers.
|
|
598
598
|
*/
|
|
599
599
|
patchScimUser(userId, body, opts) {
|
|
600
600
|
opts = opts || {};
|
|
@@ -611,13 +611,13 @@ class SCIMApi {
|
|
|
611
611
|
return this.apiClient.callApi(
|
|
612
612
|
'/api/v2/scim/users/{userId}',
|
|
613
613
|
'PATCH',
|
|
614
|
-
{ 'userId': userId },
|
|
615
|
-
{ },
|
|
616
|
-
{ 'If-Match': opts['ifMatch'] },
|
|
617
|
-
{ },
|
|
614
|
+
{ 'userId': userId },
|
|
615
|
+
{ },
|
|
616
|
+
{ 'If-Match': opts['ifMatch'] },
|
|
617
|
+
{ },
|
|
618
618
|
body,
|
|
619
619
|
['PureCloud OAuth'],
|
|
620
|
-
['application/scim+json', 'application/json'],
|
|
620
|
+
['application/scim+json', 'application/json'],
|
|
621
621
|
['application/scim+json', 'application/json']
|
|
622
622
|
);
|
|
623
623
|
}
|
|
@@ -628,7 +628,7 @@ class SCIMApi {
|
|
|
628
628
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
629
629
|
* @param {Object} body The information used to modify a group.
|
|
630
630
|
* @param {Object} opts Optional parameters
|
|
631
|
-
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example:
|
|
631
|
+
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: 42. If the ETag is different from the version on the server, returns 400 with a scimType of invalidVers.
|
|
632
632
|
*/
|
|
633
633
|
patchScimV2Group(groupId, body, opts) {
|
|
634
634
|
opts = opts || {};
|
|
@@ -645,13 +645,13 @@ class SCIMApi {
|
|
|
645
645
|
return this.apiClient.callApi(
|
|
646
646
|
'/api/v2/scim/v2/groups/{groupId}',
|
|
647
647
|
'PATCH',
|
|
648
|
-
{ 'groupId': groupId },
|
|
649
|
-
{ },
|
|
650
|
-
{ 'If-Match': opts['ifMatch'] },
|
|
651
|
-
{ },
|
|
648
|
+
{ 'groupId': groupId },
|
|
649
|
+
{ },
|
|
650
|
+
{ 'If-Match': opts['ifMatch'] },
|
|
651
|
+
{ },
|
|
652
652
|
body,
|
|
653
653
|
['PureCloud OAuth'],
|
|
654
|
-
['application/scim+json', 'application/json'],
|
|
654
|
+
['application/scim+json', 'application/json'],
|
|
655
655
|
['application/scim+json', 'application/json']
|
|
656
656
|
);
|
|
657
657
|
}
|
|
@@ -662,7 +662,7 @@ class SCIMApi {
|
|
|
662
662
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
663
663
|
* @param {Object} body The information used to modify a user.
|
|
664
664
|
* @param {Object} opts Optional parameters
|
|
665
|
-
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example:
|
|
665
|
+
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: 42. If the ETag is different from the version on the server, returns 400 with a scimType of invalidVers.
|
|
666
666
|
*/
|
|
667
667
|
patchScimV2User(userId, body, opts) {
|
|
668
668
|
opts = opts || {};
|
|
@@ -679,13 +679,13 @@ class SCIMApi {
|
|
|
679
679
|
return this.apiClient.callApi(
|
|
680
680
|
'/api/v2/scim/v2/users/{userId}',
|
|
681
681
|
'PATCH',
|
|
682
|
-
{ 'userId': userId },
|
|
683
|
-
{ },
|
|
684
|
-
{ 'If-Match': opts['ifMatch'] },
|
|
685
|
-
{ },
|
|
682
|
+
{ 'userId': userId },
|
|
683
|
+
{ },
|
|
684
|
+
{ 'If-Match': opts['ifMatch'] },
|
|
685
|
+
{ },
|
|
686
686
|
body,
|
|
687
687
|
['PureCloud OAuth'],
|
|
688
|
-
['application/scim+json', 'application/json'],
|
|
688
|
+
['application/scim+json', 'application/json'],
|
|
689
689
|
['application/scim+json', 'application/json']
|
|
690
690
|
);
|
|
691
691
|
}
|
|
@@ -704,13 +704,13 @@ class SCIMApi {
|
|
|
704
704
|
return this.apiClient.callApi(
|
|
705
705
|
'/api/v2/scim/users',
|
|
706
706
|
'POST',
|
|
707
|
-
{ },
|
|
708
|
-
{ },
|
|
709
|
-
{ },
|
|
710
|
-
{ },
|
|
707
|
+
{ },
|
|
708
|
+
{ },
|
|
709
|
+
{ },
|
|
710
|
+
{ },
|
|
711
711
|
body,
|
|
712
712
|
['PureCloud OAuth'],
|
|
713
|
-
['application/scim+json', 'application/json'],
|
|
713
|
+
['application/scim+json', 'application/json'],
|
|
714
714
|
['application/scim+json', 'application/json']
|
|
715
715
|
);
|
|
716
716
|
}
|
|
@@ -729,13 +729,13 @@ class SCIMApi {
|
|
|
729
729
|
return this.apiClient.callApi(
|
|
730
730
|
'/api/v2/scim/v2/users',
|
|
731
731
|
'POST',
|
|
732
|
-
{ },
|
|
733
|
-
{ },
|
|
734
|
-
{ },
|
|
735
|
-
{ },
|
|
732
|
+
{ },
|
|
733
|
+
{ },
|
|
734
|
+
{ },
|
|
735
|
+
{ },
|
|
736
736
|
body,
|
|
737
737
|
['PureCloud OAuth'],
|
|
738
|
-
['application/scim+json', 'application/json'],
|
|
738
|
+
['application/scim+json', 'application/json'],
|
|
739
739
|
['application/scim+json', 'application/json']
|
|
740
740
|
);
|
|
741
741
|
}
|
|
@@ -746,7 +746,7 @@ class SCIMApi {
|
|
|
746
746
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
747
747
|
* @param {Object} body The information used to replace a group.
|
|
748
748
|
* @param {Object} opts Optional parameters
|
|
749
|
-
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example:
|
|
749
|
+
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: 42. If the ETag is different from the version on the server, returns 400 with a scimType of invalidVers.
|
|
750
750
|
*/
|
|
751
751
|
putScimGroup(groupId, body, opts) {
|
|
752
752
|
opts = opts || {};
|
|
@@ -763,13 +763,13 @@ class SCIMApi {
|
|
|
763
763
|
return this.apiClient.callApi(
|
|
764
764
|
'/api/v2/scim/groups/{groupId}',
|
|
765
765
|
'PUT',
|
|
766
|
-
{ 'groupId': groupId },
|
|
767
|
-
{ },
|
|
768
|
-
{ 'If-Match': opts['ifMatch'] },
|
|
769
|
-
{ },
|
|
766
|
+
{ 'groupId': groupId },
|
|
767
|
+
{ },
|
|
768
|
+
{ 'If-Match': opts['ifMatch'] },
|
|
769
|
+
{ },
|
|
770
770
|
body,
|
|
771
771
|
['PureCloud OAuth'],
|
|
772
|
-
['application/scim+json', 'application/json'],
|
|
772
|
+
['application/scim+json', 'application/json'],
|
|
773
773
|
['application/scim+json', 'application/json']
|
|
774
774
|
);
|
|
775
775
|
}
|
|
@@ -780,7 +780,7 @@ class SCIMApi {
|
|
|
780
780
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/users.
|
|
781
781
|
* @param {Object} body The information used to replace a user.
|
|
782
782
|
* @param {Object} opts Optional parameters
|
|
783
|
-
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example:
|
|
783
|
+
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: 42. If the ETag is different from the version on the server, returns 400 with a scimType of invalidVers.
|
|
784
784
|
*/
|
|
785
785
|
putScimUser(userId, body, opts) {
|
|
786
786
|
opts = opts || {};
|
|
@@ -797,13 +797,13 @@ class SCIMApi {
|
|
|
797
797
|
return this.apiClient.callApi(
|
|
798
798
|
'/api/v2/scim/users/{userId}',
|
|
799
799
|
'PUT',
|
|
800
|
-
{ 'userId': userId },
|
|
801
|
-
{ },
|
|
802
|
-
{ 'If-Match': opts['ifMatch'] },
|
|
803
|
-
{ },
|
|
800
|
+
{ 'userId': userId },
|
|
801
|
+
{ },
|
|
802
|
+
{ 'If-Match': opts['ifMatch'] },
|
|
803
|
+
{ },
|
|
804
804
|
body,
|
|
805
805
|
['PureCloud OAuth'],
|
|
806
|
-
['application/scim+json', 'application/json'],
|
|
806
|
+
['application/scim+json', 'application/json'],
|
|
807
807
|
['application/scim+json', 'application/json']
|
|
808
808
|
);
|
|
809
809
|
}
|
|
@@ -814,7 +814,7 @@ class SCIMApi {
|
|
|
814
814
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
815
815
|
* @param {Object} body The information used to replace a group.
|
|
816
816
|
* @param {Object} opts Optional parameters
|
|
817
|
-
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example:
|
|
817
|
+
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: 42. If the ETag is different from the version on the server, returns 400 with a scimType of invalidVers.
|
|
818
818
|
*/
|
|
819
819
|
putScimV2Group(groupId, body, opts) {
|
|
820
820
|
opts = opts || {};
|
|
@@ -831,13 +831,13 @@ class SCIMApi {
|
|
|
831
831
|
return this.apiClient.callApi(
|
|
832
832
|
'/api/v2/scim/v2/groups/{groupId}',
|
|
833
833
|
'PUT',
|
|
834
|
-
{ 'groupId': groupId },
|
|
835
|
-
{ },
|
|
836
|
-
{ 'If-Match': opts['ifMatch'] },
|
|
837
|
-
{ },
|
|
834
|
+
{ 'groupId': groupId },
|
|
835
|
+
{ },
|
|
836
|
+
{ 'If-Match': opts['ifMatch'] },
|
|
837
|
+
{ },
|
|
838
838
|
body,
|
|
839
839
|
['PureCloud OAuth'],
|
|
840
|
-
['application/scim+json', 'application/json'],
|
|
840
|
+
['application/scim+json', 'application/json'],
|
|
841
841
|
['application/scim+json', 'application/json']
|
|
842
842
|
);
|
|
843
843
|
}
|
|
@@ -848,7 +848,7 @@ class SCIMApi {
|
|
|
848
848
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
849
849
|
* @param {Object} body The information used to replace a user.
|
|
850
850
|
* @param {Object} opts Optional parameters
|
|
851
|
-
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example:
|
|
851
|
+
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: 42. If the ETag is different from the version on the server, returns 400 with a scimType of invalidVers.
|
|
852
852
|
*/
|
|
853
853
|
putScimV2User(userId, body, opts) {
|
|
854
854
|
opts = opts || {};
|
|
@@ -865,13 +865,13 @@ class SCIMApi {
|
|
|
865
865
|
return this.apiClient.callApi(
|
|
866
866
|
'/api/v2/scim/v2/users/{userId}',
|
|
867
867
|
'PUT',
|
|
868
|
-
{ 'userId': userId },
|
|
869
|
-
{ },
|
|
870
|
-
{ 'If-Match': opts['ifMatch'] },
|
|
871
|
-
{ },
|
|
868
|
+
{ 'userId': userId },
|
|
869
|
+
{ },
|
|
870
|
+
{ 'If-Match': opts['ifMatch'] },
|
|
871
|
+
{ },
|
|
872
872
|
body,
|
|
873
873
|
['PureCloud OAuth'],
|
|
874
|
-
['application/scim+json', 'application/json'],
|
|
874
|
+
['application/scim+json', 'application/json'],
|
|
875
875
|
['application/scim+json', 'application/json']
|
|
876
876
|
);
|
|
877
877
|
}
|