@iblai/iblai-api 4.29.0-core → 4.30.0-core
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/dist/index.cjs.js +223 -213
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +223 -213
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +223 -213
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +11 -0
- package/dist/types/models/SCIMAddress.d.ts +33 -0
- package/dist/types/models/SCIMDepartment.d.ts +26 -0
- package/dist/types/models/SCIMEmail.d.ts +17 -0
- package/dist/types/models/SCIMEnterpriseUser.d.ts +29 -0
- package/dist/types/models/SCIMGroup.d.ts +38 -0
- package/dist/types/models/SCIMMeta.d.ts +25 -0
- package/dist/types/models/SCIMName.d.ts +17 -0
- package/dist/types/models/SCIMPhoneNumber.d.ts +13 -0
- package/dist/types/models/SCIMUserCreateRequest.d.ts +110 -0
- package/dist/types/models/SCIMUserListResponse.d.ts +17 -0
- package/dist/types/models/SCIMUserResponse.d.ts +41 -0
- package/dist/types/services/ScimService.d.ts +165 -162
- package/package.json +1 -1
- package/sdk_schema.yml +1326 -192
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +11 -0
- package/src/models/SCIMAddress.ts +38 -0
- package/src/models/SCIMDepartment.ts +31 -0
- package/src/models/SCIMEmail.ts +22 -0
- package/src/models/SCIMEnterpriseUser.ts +34 -0
- package/src/models/SCIMGroup.ts +43 -0
- package/src/models/SCIMMeta.ts +30 -0
- package/src/models/SCIMName.ts +22 -0
- package/src/models/SCIMPhoneNumber.ts +18 -0
- package/src/models/SCIMUserCreateRequest.ts +115 -0
- package/src/models/SCIMUserListResponse.ts +22 -0
- package/src/models/SCIMUserResponse.ts +46 -0
- package/src/services/ScimService.ts +270 -249
|
@@ -2,623 +2,644 @@
|
|
|
2
2
|
/* istanbul ignore file */
|
|
3
3
|
/* tslint:disable */
|
|
4
4
|
/* eslint-disable */
|
|
5
|
+
import type { SCIMDepartment } from '../models/SCIMDepartment';
|
|
6
|
+
import type { SCIMGroup } from '../models/SCIMGroup';
|
|
7
|
+
import type { SCIMUserCreateRequest } from '../models/SCIMUserCreateRequest';
|
|
8
|
+
import type { SCIMUserListResponse } from '../models/SCIMUserListResponse';
|
|
9
|
+
import type { SCIMUserResponse } from '../models/SCIMUserResponse';
|
|
5
10
|
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
6
11
|
import { OpenAPI } from '../core/OpenAPI';
|
|
7
12
|
import { request as __request } from '../core/request';
|
|
8
13
|
export class ScimService {
|
|
9
14
|
/**
|
|
10
|
-
*
|
|
11
|
-
* List all department members in the system
|
|
12
|
-
* @returns any
|
|
15
|
+
* List all department members in the system
|
|
16
|
+
* List all department members in the system for the specified platform
|
|
17
|
+
* @returns any
|
|
13
18
|
* @throws ApiError
|
|
14
19
|
*/
|
|
15
|
-
public static
|
|
16
|
-
|
|
20
|
+
public static listDepartmentMembers({
|
|
21
|
+
platformKey,
|
|
17
22
|
}: {
|
|
18
|
-
|
|
19
|
-
}): CancelablePromise<any
|
|
23
|
+
platformKey: string,
|
|
24
|
+
}): CancelablePromise<Array<any>> {
|
|
20
25
|
return __request(OpenAPI, {
|
|
21
26
|
method: 'GET',
|
|
22
|
-
url: '/api/orgs/{
|
|
27
|
+
url: '/api/orgs/{platform_key}/scim/v2/DepartmentMembers/',
|
|
23
28
|
path: {
|
|
24
|
-
'
|
|
29
|
+
'platform_key': platformKey,
|
|
25
30
|
},
|
|
26
31
|
});
|
|
27
32
|
}
|
|
28
33
|
/**
|
|
29
|
-
*
|
|
30
|
-
* Create
|
|
31
|
-
* @returns any
|
|
34
|
+
* Create a new department member
|
|
35
|
+
* Create a new department member for the specified platform
|
|
36
|
+
* @returns any
|
|
32
37
|
* @throws ApiError
|
|
33
38
|
*/
|
|
34
|
-
public static
|
|
35
|
-
|
|
39
|
+
public static createDepartmentMember({
|
|
40
|
+
platformKey,
|
|
36
41
|
}: {
|
|
37
|
-
|
|
42
|
+
platformKey: string,
|
|
38
43
|
}): CancelablePromise<any> {
|
|
39
44
|
return __request(OpenAPI, {
|
|
40
45
|
method: 'POST',
|
|
41
|
-
url: '/api/orgs/{
|
|
46
|
+
url: '/api/orgs/{platform_key}/scim/v2/DepartmentMembers/',
|
|
42
47
|
path: {
|
|
43
|
-
'
|
|
48
|
+
'platform_key': platformKey,
|
|
44
49
|
},
|
|
45
50
|
});
|
|
46
51
|
}
|
|
47
52
|
/**
|
|
48
|
-
*
|
|
49
|
-
* Get department members for a specific department (
|
|
50
|
-
* @returns any
|
|
53
|
+
* Get department members for a specific department
|
|
54
|
+
* Get department members for a specific department (by department id) for the specified platform
|
|
55
|
+
* @returns any
|
|
51
56
|
* @throws ApiError
|
|
52
57
|
*/
|
|
53
|
-
public static
|
|
58
|
+
public static retrieveDepartmentMembers({
|
|
54
59
|
id,
|
|
55
|
-
|
|
60
|
+
platformKey,
|
|
56
61
|
}: {
|
|
57
62
|
id: string,
|
|
58
|
-
|
|
63
|
+
platformKey: string,
|
|
59
64
|
}): CancelablePromise<any> {
|
|
60
65
|
return __request(OpenAPI, {
|
|
61
66
|
method: 'GET',
|
|
62
|
-
url: '/api/orgs/{
|
|
67
|
+
url: '/api/orgs/{platform_key}/scim/v2/DepartmentMembers/{id}/',
|
|
63
68
|
path: {
|
|
64
69
|
'id': id,
|
|
65
|
-
'
|
|
70
|
+
'platform_key': platformKey,
|
|
66
71
|
},
|
|
67
72
|
});
|
|
68
73
|
}
|
|
69
74
|
/**
|
|
70
|
-
*
|
|
71
|
-
* Update a department member
|
|
72
|
-
* @returns any
|
|
75
|
+
* Update a department member
|
|
76
|
+
* Update a department member for the specified platform
|
|
77
|
+
* @returns any
|
|
73
78
|
* @throws ApiError
|
|
74
79
|
*/
|
|
75
|
-
public static
|
|
80
|
+
public static updateDepartmentMember({
|
|
76
81
|
id,
|
|
77
|
-
|
|
82
|
+
platformKey,
|
|
78
83
|
}: {
|
|
79
84
|
id: string,
|
|
80
|
-
|
|
85
|
+
platformKey: string,
|
|
81
86
|
}): CancelablePromise<any> {
|
|
82
87
|
return __request(OpenAPI, {
|
|
83
88
|
method: 'PUT',
|
|
84
|
-
url: '/api/orgs/{
|
|
89
|
+
url: '/api/orgs/{platform_key}/scim/v2/DepartmentMembers/{id}/',
|
|
85
90
|
path: {
|
|
86
91
|
'id': id,
|
|
87
|
-
'
|
|
92
|
+
'platform_key': platformKey,
|
|
88
93
|
},
|
|
89
94
|
});
|
|
90
95
|
}
|
|
91
96
|
/**
|
|
92
|
-
*
|
|
93
|
-
* Delete a department member
|
|
97
|
+
* Delete a department member
|
|
98
|
+
* Delete a department member from the system
|
|
94
99
|
* @returns void
|
|
95
100
|
* @throws ApiError
|
|
96
101
|
*/
|
|
97
|
-
public static
|
|
102
|
+
public static deleteDepartmentMember({
|
|
98
103
|
id,
|
|
99
|
-
|
|
104
|
+
platformKey,
|
|
100
105
|
}: {
|
|
101
106
|
id: string,
|
|
102
|
-
|
|
107
|
+
platformKey: string,
|
|
103
108
|
}): CancelablePromise<void> {
|
|
104
109
|
return __request(OpenAPI, {
|
|
105
110
|
method: 'DELETE',
|
|
106
|
-
url: '/api/orgs/{
|
|
111
|
+
url: '/api/orgs/{platform_key}/scim/v2/DepartmentMembers/{id}/',
|
|
107
112
|
path: {
|
|
108
113
|
'id': id,
|
|
109
|
-
'
|
|
114
|
+
'platform_key': platformKey,
|
|
110
115
|
},
|
|
111
116
|
});
|
|
112
117
|
}
|
|
113
118
|
/**
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
* @returns any No response body
|
|
119
|
+
* List departments in the system
|
|
120
|
+
* List departments in the system for the specified platform
|
|
121
|
+
* @returns any
|
|
118
122
|
* @throws ApiError
|
|
119
123
|
*/
|
|
120
|
-
public static
|
|
121
|
-
|
|
124
|
+
public static listDepartments({
|
|
125
|
+
platformKey,
|
|
122
126
|
}: {
|
|
123
|
-
|
|
124
|
-
}): CancelablePromise<any
|
|
127
|
+
platformKey: string,
|
|
128
|
+
}): CancelablePromise<Array<any>> {
|
|
125
129
|
return __request(OpenAPI, {
|
|
126
130
|
method: 'GET',
|
|
127
|
-
url: '/api/orgs/{
|
|
131
|
+
url: '/api/orgs/{platform_key}/scim/v2/Departments/',
|
|
128
132
|
path: {
|
|
129
|
-
'
|
|
133
|
+
'platform_key': platformKey,
|
|
130
134
|
},
|
|
131
135
|
});
|
|
132
136
|
}
|
|
133
137
|
/**
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
* @returns any No response body
|
|
138
|
+
* Create a new department
|
|
139
|
+
* Create a new department for the specified platform
|
|
140
|
+
* @returns SCIMDepartment
|
|
138
141
|
* @throws ApiError
|
|
139
142
|
*/
|
|
140
|
-
public static
|
|
141
|
-
|
|
143
|
+
public static createDepartment({
|
|
144
|
+
platformKey,
|
|
145
|
+
requestBody,
|
|
142
146
|
}: {
|
|
143
|
-
|
|
144
|
-
|
|
147
|
+
platformKey: string,
|
|
148
|
+
requestBody: SCIMDepartment,
|
|
149
|
+
}): CancelablePromise<SCIMDepartment> {
|
|
145
150
|
return __request(OpenAPI, {
|
|
146
151
|
method: 'POST',
|
|
147
|
-
url: '/api/orgs/{
|
|
152
|
+
url: '/api/orgs/{platform_key}/scim/v2/Departments/',
|
|
148
153
|
path: {
|
|
149
|
-
'
|
|
154
|
+
'platform_key': platformKey,
|
|
150
155
|
},
|
|
156
|
+
body: requestBody,
|
|
157
|
+
mediaType: 'application/json',
|
|
151
158
|
});
|
|
152
159
|
}
|
|
153
160
|
/**
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
*
|
|
157
|
-
* @returns any No response body
|
|
161
|
+
* Get details of a specific department
|
|
162
|
+
* Get details of a specific department by ID for the specified platform
|
|
163
|
+
* @returns SCIMDepartment
|
|
158
164
|
* @throws ApiError
|
|
159
165
|
*/
|
|
160
|
-
public static
|
|
166
|
+
public static retrieveDepartment({
|
|
161
167
|
id,
|
|
162
|
-
|
|
168
|
+
platformKey,
|
|
163
169
|
}: {
|
|
164
170
|
id: string,
|
|
165
|
-
|
|
166
|
-
}): CancelablePromise<
|
|
171
|
+
platformKey: string,
|
|
172
|
+
}): CancelablePromise<SCIMDepartment> {
|
|
167
173
|
return __request(OpenAPI, {
|
|
168
174
|
method: 'GET',
|
|
169
|
-
url: '/api/orgs/{
|
|
175
|
+
url: '/api/orgs/{platform_key}/scim/v2/Departments/{id}/',
|
|
170
176
|
path: {
|
|
171
177
|
'id': id,
|
|
172
|
-
'
|
|
178
|
+
'platform_key': platformKey,
|
|
173
179
|
},
|
|
174
180
|
});
|
|
175
181
|
}
|
|
176
182
|
/**
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
* @returns any No response body
|
|
183
|
+
* Update a department
|
|
184
|
+
* Update a department for the specified platform
|
|
185
|
+
* @returns SCIMDepartment
|
|
181
186
|
* @throws ApiError
|
|
182
187
|
*/
|
|
183
|
-
public static
|
|
188
|
+
public static updateDepartment({
|
|
184
189
|
id,
|
|
185
|
-
|
|
190
|
+
platformKey,
|
|
191
|
+
requestBody,
|
|
186
192
|
}: {
|
|
187
193
|
id: string,
|
|
188
|
-
|
|
189
|
-
|
|
194
|
+
platformKey: string,
|
|
195
|
+
requestBody: SCIMDepartment,
|
|
196
|
+
}): CancelablePromise<SCIMDepartment> {
|
|
190
197
|
return __request(OpenAPI, {
|
|
191
198
|
method: 'PUT',
|
|
192
|
-
url: '/api/orgs/{
|
|
199
|
+
url: '/api/orgs/{platform_key}/scim/v2/Departments/{id}/',
|
|
193
200
|
path: {
|
|
194
201
|
'id': id,
|
|
195
|
-
'
|
|
202
|
+
'platform_key': platformKey,
|
|
196
203
|
},
|
|
204
|
+
body: requestBody,
|
|
205
|
+
mediaType: 'application/json',
|
|
197
206
|
});
|
|
198
207
|
}
|
|
199
208
|
/**
|
|
200
|
-
*
|
|
201
|
-
*
|
|
202
|
-
* Delete a department from the system.
|
|
209
|
+
* Delete a department
|
|
210
|
+
* Delete a department from the system
|
|
203
211
|
* @returns void
|
|
204
212
|
* @throws ApiError
|
|
205
213
|
*/
|
|
206
|
-
public static
|
|
214
|
+
public static deleteDepartment({
|
|
207
215
|
id,
|
|
208
|
-
|
|
216
|
+
platformKey,
|
|
209
217
|
}: {
|
|
210
218
|
id: string,
|
|
211
|
-
|
|
219
|
+
platformKey: string,
|
|
212
220
|
}): CancelablePromise<void> {
|
|
213
221
|
return __request(OpenAPI, {
|
|
214
222
|
method: 'DELETE',
|
|
215
|
-
url: '/api/orgs/{
|
|
223
|
+
url: '/api/orgs/{platform_key}/scim/v2/Departments/{id}/',
|
|
216
224
|
path: {
|
|
217
225
|
'id': id,
|
|
218
|
-
'
|
|
226
|
+
'platform_key': platformKey,
|
|
219
227
|
},
|
|
220
228
|
});
|
|
221
229
|
}
|
|
222
230
|
/**
|
|
223
|
-
*
|
|
224
|
-
*
|
|
225
|
-
*
|
|
226
|
-
* @returns any No response body
|
|
231
|
+
* Add members to a department
|
|
232
|
+
* Add members to a department using SCIM patch operations
|
|
233
|
+
* @returns any
|
|
227
234
|
* @throws ApiError
|
|
228
235
|
*/
|
|
229
|
-
public static
|
|
236
|
+
public static addDepartmentMembers({
|
|
230
237
|
id,
|
|
231
|
-
|
|
238
|
+
platformKey,
|
|
232
239
|
}: {
|
|
233
240
|
id: string,
|
|
234
|
-
|
|
241
|
+
platformKey: string,
|
|
235
242
|
}): CancelablePromise<any> {
|
|
236
243
|
return __request(OpenAPI, {
|
|
237
244
|
method: 'POST',
|
|
238
|
-
url: '/api/orgs/{
|
|
245
|
+
url: '/api/orgs/{platform_key}/scim/v2/Departments/{id}/add_members/',
|
|
239
246
|
path: {
|
|
240
247
|
'id': id,
|
|
241
|
-
'
|
|
248
|
+
'platform_key': platformKey,
|
|
242
249
|
},
|
|
243
250
|
});
|
|
244
251
|
}
|
|
245
252
|
/**
|
|
246
|
-
*
|
|
247
|
-
*
|
|
248
|
-
*
|
|
249
|
-
* @returns any No response body
|
|
253
|
+
* Remove members from a department
|
|
254
|
+
* Remove members from a department using SCIM patch operations
|
|
255
|
+
* @returns any
|
|
250
256
|
* @throws ApiError
|
|
251
257
|
*/
|
|
252
|
-
public static
|
|
258
|
+
public static removeDepartmentMembers({
|
|
253
259
|
id,
|
|
254
|
-
|
|
260
|
+
platformKey,
|
|
255
261
|
}: {
|
|
256
262
|
id: string,
|
|
257
|
-
|
|
263
|
+
platformKey: string,
|
|
258
264
|
}): CancelablePromise<any> {
|
|
259
265
|
return __request(OpenAPI, {
|
|
260
266
|
method: 'POST',
|
|
261
|
-
url: '/api/orgs/{
|
|
267
|
+
url: '/api/orgs/{platform_key}/scim/v2/Departments/{id}/remove_members/',
|
|
262
268
|
path: {
|
|
263
269
|
'id': id,
|
|
264
|
-
'
|
|
270
|
+
'platform_key': platformKey,
|
|
265
271
|
},
|
|
266
272
|
});
|
|
267
273
|
}
|
|
268
274
|
/**
|
|
269
|
-
*
|
|
270
|
-
*
|
|
275
|
+
* List all group members in the system
|
|
276
|
+
* List all group members in the system for the specified platform
|
|
277
|
+
* @returns any
|
|
271
278
|
* @throws ApiError
|
|
272
279
|
*/
|
|
273
|
-
public static
|
|
274
|
-
|
|
280
|
+
public static listGroupMembers({
|
|
281
|
+
platformKey,
|
|
275
282
|
}: {
|
|
276
|
-
|
|
277
|
-
}): CancelablePromise<any
|
|
283
|
+
platformKey: string,
|
|
284
|
+
}): CancelablePromise<Array<any>> {
|
|
278
285
|
return __request(OpenAPI, {
|
|
279
286
|
method: 'GET',
|
|
280
|
-
url: '/api/orgs/{
|
|
287
|
+
url: '/api/orgs/{platform_key}/scim/v2/GroupMembers/',
|
|
281
288
|
path: {
|
|
282
|
-
'
|
|
289
|
+
'platform_key': platformKey,
|
|
283
290
|
},
|
|
284
291
|
});
|
|
285
292
|
}
|
|
286
293
|
/**
|
|
287
|
-
*
|
|
288
|
-
*
|
|
294
|
+
* Create a new group member
|
|
295
|
+
* Create a new group member for the specified platform
|
|
296
|
+
* @returns any
|
|
289
297
|
* @throws ApiError
|
|
290
298
|
*/
|
|
291
|
-
public static
|
|
292
|
-
|
|
299
|
+
public static createGroupMember({
|
|
300
|
+
platformKey,
|
|
293
301
|
}: {
|
|
294
|
-
|
|
302
|
+
platformKey: string,
|
|
295
303
|
}): CancelablePromise<any> {
|
|
296
304
|
return __request(OpenAPI, {
|
|
297
305
|
method: 'POST',
|
|
298
|
-
url: '/api/orgs/{
|
|
306
|
+
url: '/api/orgs/{platform_key}/scim/v2/GroupMembers/',
|
|
299
307
|
path: {
|
|
300
|
-
'
|
|
308
|
+
'platform_key': platformKey,
|
|
301
309
|
},
|
|
302
310
|
});
|
|
303
311
|
}
|
|
304
312
|
/**
|
|
305
|
-
*
|
|
306
|
-
*
|
|
313
|
+
* Get details of a specific group member
|
|
314
|
+
* Get details of a specific group member by ID for the specified platform
|
|
315
|
+
* @returns any
|
|
307
316
|
* @throws ApiError
|
|
308
317
|
*/
|
|
309
|
-
public static
|
|
318
|
+
public static retrieveGroupMember({
|
|
310
319
|
id,
|
|
311
|
-
|
|
320
|
+
platformKey,
|
|
312
321
|
}: {
|
|
313
322
|
id: string,
|
|
314
|
-
|
|
323
|
+
platformKey: string,
|
|
315
324
|
}): CancelablePromise<any> {
|
|
316
325
|
return __request(OpenAPI, {
|
|
317
326
|
method: 'GET',
|
|
318
|
-
url: '/api/orgs/{
|
|
327
|
+
url: '/api/orgs/{platform_key}/scim/v2/GroupMembers/{id}/',
|
|
319
328
|
path: {
|
|
320
329
|
'id': id,
|
|
321
|
-
'
|
|
330
|
+
'platform_key': platformKey,
|
|
322
331
|
},
|
|
323
332
|
});
|
|
324
333
|
}
|
|
325
334
|
/**
|
|
326
|
-
*
|
|
327
|
-
*
|
|
335
|
+
* Update a group member
|
|
336
|
+
* Update a group member for the specified platform
|
|
337
|
+
* @returns any
|
|
328
338
|
* @throws ApiError
|
|
329
339
|
*/
|
|
330
|
-
public static
|
|
340
|
+
public static updateGroupMember({
|
|
331
341
|
id,
|
|
332
|
-
|
|
342
|
+
platformKey,
|
|
333
343
|
}: {
|
|
334
344
|
id: string,
|
|
335
|
-
|
|
345
|
+
platformKey: string,
|
|
336
346
|
}): CancelablePromise<any> {
|
|
337
347
|
return __request(OpenAPI, {
|
|
338
348
|
method: 'PUT',
|
|
339
|
-
url: '/api/orgs/{
|
|
349
|
+
url: '/api/orgs/{platform_key}/scim/v2/GroupMembers/{id}/',
|
|
340
350
|
path: {
|
|
341
351
|
'id': id,
|
|
342
|
-
'
|
|
352
|
+
'platform_key': platformKey,
|
|
343
353
|
},
|
|
344
354
|
});
|
|
345
355
|
}
|
|
346
356
|
/**
|
|
347
|
-
*
|
|
357
|
+
* Delete a group member
|
|
358
|
+
* Delete a group member from the system
|
|
348
359
|
* @returns void
|
|
349
360
|
* @throws ApiError
|
|
350
361
|
*/
|
|
351
|
-
public static
|
|
362
|
+
public static deleteGroupMember({
|
|
352
363
|
id,
|
|
353
|
-
|
|
364
|
+
platformKey,
|
|
354
365
|
}: {
|
|
355
366
|
id: string,
|
|
356
|
-
|
|
367
|
+
platformKey: string,
|
|
357
368
|
}): CancelablePromise<void> {
|
|
358
369
|
return __request(OpenAPI, {
|
|
359
370
|
method: 'DELETE',
|
|
360
|
-
url: '/api/orgs/{
|
|
371
|
+
url: '/api/orgs/{platform_key}/scim/v2/GroupMembers/{id}/',
|
|
361
372
|
path: {
|
|
362
373
|
'id': id,
|
|
363
|
-
'
|
|
374
|
+
'platform_key': platformKey,
|
|
364
375
|
},
|
|
365
376
|
});
|
|
366
377
|
}
|
|
367
378
|
/**
|
|
368
|
-
*
|
|
369
|
-
*
|
|
379
|
+
* List user groups in the system
|
|
380
|
+
* List user groups in the system for the specified platform
|
|
381
|
+
* @returns any
|
|
370
382
|
* @throws ApiError
|
|
371
383
|
*/
|
|
372
|
-
public static
|
|
373
|
-
|
|
384
|
+
public static listGroups({
|
|
385
|
+
platformKey,
|
|
374
386
|
}: {
|
|
375
|
-
|
|
376
|
-
}): CancelablePromise<any
|
|
387
|
+
platformKey: string,
|
|
388
|
+
}): CancelablePromise<Array<any>> {
|
|
377
389
|
return __request(OpenAPI, {
|
|
378
390
|
method: 'GET',
|
|
379
|
-
url: '/api/orgs/{
|
|
391
|
+
url: '/api/orgs/{platform_key}/scim/v2/Groups/',
|
|
380
392
|
path: {
|
|
381
|
-
'
|
|
393
|
+
'platform_key': platformKey,
|
|
382
394
|
},
|
|
383
395
|
});
|
|
384
396
|
}
|
|
385
397
|
/**
|
|
386
|
-
*
|
|
387
|
-
*
|
|
398
|
+
* Create a new user group
|
|
399
|
+
* Create a new user group for the specified platform
|
|
400
|
+
* @returns SCIMGroup
|
|
388
401
|
* @throws ApiError
|
|
389
402
|
*/
|
|
390
|
-
public static
|
|
391
|
-
|
|
403
|
+
public static createGroup({
|
|
404
|
+
platformKey,
|
|
405
|
+
requestBody,
|
|
392
406
|
}: {
|
|
393
|
-
|
|
394
|
-
|
|
407
|
+
platformKey: string,
|
|
408
|
+
requestBody: SCIMGroup,
|
|
409
|
+
}): CancelablePromise<SCIMGroup> {
|
|
395
410
|
return __request(OpenAPI, {
|
|
396
411
|
method: 'POST',
|
|
397
|
-
url: '/api/orgs/{
|
|
412
|
+
url: '/api/orgs/{platform_key}/scim/v2/Groups/',
|
|
398
413
|
path: {
|
|
399
|
-
'
|
|
414
|
+
'platform_key': platformKey,
|
|
400
415
|
},
|
|
416
|
+
body: requestBody,
|
|
417
|
+
mediaType: 'application/json',
|
|
401
418
|
});
|
|
402
419
|
}
|
|
403
420
|
/**
|
|
404
|
-
*
|
|
405
|
-
*
|
|
406
|
-
*
|
|
407
|
-
* @returns any No response body
|
|
421
|
+
* Get details of a specific group
|
|
422
|
+
* Get details of a specific group by ID for the specified platform
|
|
423
|
+
* @returns SCIMGroup
|
|
408
424
|
* @throws ApiError
|
|
409
425
|
*/
|
|
410
|
-
public static
|
|
426
|
+
public static retrieveGroup({
|
|
411
427
|
id,
|
|
412
|
-
|
|
428
|
+
platformKey,
|
|
413
429
|
}: {
|
|
414
430
|
id: string,
|
|
415
|
-
|
|
416
|
-
}): CancelablePromise<
|
|
431
|
+
platformKey: string,
|
|
432
|
+
}): CancelablePromise<SCIMGroup> {
|
|
417
433
|
return __request(OpenAPI, {
|
|
418
434
|
method: 'GET',
|
|
419
|
-
url: '/api/orgs/{
|
|
435
|
+
url: '/api/orgs/{platform_key}/scim/v2/Groups/{id}/',
|
|
420
436
|
path: {
|
|
421
437
|
'id': id,
|
|
422
|
-
'
|
|
438
|
+
'platform_key': platformKey,
|
|
423
439
|
},
|
|
424
440
|
});
|
|
425
441
|
}
|
|
426
442
|
/**
|
|
427
|
-
*
|
|
428
|
-
*
|
|
429
|
-
*
|
|
430
|
-
* @returns any No response body
|
|
443
|
+
* Update a user group
|
|
444
|
+
* Update a user group for the specified platform
|
|
445
|
+
* @returns SCIMGroup
|
|
431
446
|
* @throws ApiError
|
|
432
447
|
*/
|
|
433
|
-
public static
|
|
448
|
+
public static updateGroup({
|
|
434
449
|
id,
|
|
435
|
-
|
|
450
|
+
platformKey,
|
|
451
|
+
requestBody,
|
|
436
452
|
}: {
|
|
437
453
|
id: string,
|
|
438
|
-
|
|
439
|
-
|
|
454
|
+
platformKey: string,
|
|
455
|
+
requestBody: SCIMGroup,
|
|
456
|
+
}): CancelablePromise<SCIMGroup> {
|
|
440
457
|
return __request(OpenAPI, {
|
|
441
458
|
method: 'PUT',
|
|
442
|
-
url: '/api/orgs/{
|
|
459
|
+
url: '/api/orgs/{platform_key}/scim/v2/Groups/{id}/',
|
|
443
460
|
path: {
|
|
444
461
|
'id': id,
|
|
445
|
-
'
|
|
462
|
+
'platform_key': platformKey,
|
|
446
463
|
},
|
|
464
|
+
body: requestBody,
|
|
465
|
+
mediaType: 'application/json',
|
|
447
466
|
});
|
|
448
467
|
}
|
|
449
468
|
/**
|
|
450
|
-
*
|
|
451
|
-
*
|
|
452
|
-
* Delete a user group from the system.
|
|
469
|
+
* Delete a user group
|
|
470
|
+
* Delete a user group from the system
|
|
453
471
|
* @returns void
|
|
454
472
|
* @throws ApiError
|
|
455
473
|
*/
|
|
456
|
-
public static
|
|
474
|
+
public static deleteGroup({
|
|
457
475
|
id,
|
|
458
|
-
|
|
476
|
+
platformKey,
|
|
459
477
|
}: {
|
|
460
478
|
id: string,
|
|
461
|
-
|
|
479
|
+
platformKey: string,
|
|
462
480
|
}): CancelablePromise<void> {
|
|
463
481
|
return __request(OpenAPI, {
|
|
464
482
|
method: 'DELETE',
|
|
465
|
-
url: '/api/orgs/{
|
|
483
|
+
url: '/api/orgs/{platform_key}/scim/v2/Groups/{id}/',
|
|
466
484
|
path: {
|
|
467
485
|
'id': id,
|
|
468
|
-
'
|
|
486
|
+
'platform_key': platformKey,
|
|
469
487
|
},
|
|
470
488
|
});
|
|
471
489
|
}
|
|
472
490
|
/**
|
|
473
|
-
*
|
|
474
|
-
*
|
|
475
|
-
*
|
|
476
|
-
* @returns any No response body
|
|
491
|
+
* Add members to a user group
|
|
492
|
+
* Add members to a user group using SCIM patch operations
|
|
493
|
+
* @returns any
|
|
477
494
|
* @throws ApiError
|
|
478
495
|
*/
|
|
479
|
-
public static
|
|
496
|
+
public static addGroupMembers({
|
|
480
497
|
id,
|
|
481
|
-
|
|
498
|
+
platformKey,
|
|
482
499
|
}: {
|
|
483
500
|
id: string,
|
|
484
|
-
|
|
501
|
+
platformKey: string,
|
|
485
502
|
}): CancelablePromise<any> {
|
|
486
503
|
return __request(OpenAPI, {
|
|
487
504
|
method: 'POST',
|
|
488
|
-
url: '/api/orgs/{
|
|
505
|
+
url: '/api/orgs/{platform_key}/scim/v2/Groups/{id}/add_members/',
|
|
489
506
|
path: {
|
|
490
507
|
'id': id,
|
|
491
|
-
'
|
|
508
|
+
'platform_key': platformKey,
|
|
492
509
|
},
|
|
493
510
|
});
|
|
494
511
|
}
|
|
495
512
|
/**
|
|
496
|
-
*
|
|
497
|
-
*
|
|
498
|
-
*
|
|
499
|
-
* @returns any No response body
|
|
513
|
+
* Remove members from a user group
|
|
514
|
+
* Remove members from a user group using SCIM patch operations
|
|
515
|
+
* @returns any
|
|
500
516
|
* @throws ApiError
|
|
501
517
|
*/
|
|
502
|
-
public static
|
|
518
|
+
public static removeGroupMembers({
|
|
503
519
|
id,
|
|
504
|
-
|
|
520
|
+
platformKey,
|
|
505
521
|
}: {
|
|
506
522
|
id: string,
|
|
507
|
-
|
|
523
|
+
platformKey: string,
|
|
508
524
|
}): CancelablePromise<any> {
|
|
509
525
|
return __request(OpenAPI, {
|
|
510
526
|
method: 'POST',
|
|
511
|
-
url: '/api/orgs/{
|
|
527
|
+
url: '/api/orgs/{platform_key}/scim/v2/Groups/{id}/remove_members/',
|
|
512
528
|
path: {
|
|
513
529
|
'id': id,
|
|
514
|
-
'
|
|
530
|
+
'platform_key': platformKey,
|
|
515
531
|
},
|
|
516
532
|
});
|
|
517
533
|
}
|
|
518
534
|
/**
|
|
519
|
-
*
|
|
520
|
-
*
|
|
521
|
-
*
|
|
522
|
-
* @returns any No response body
|
|
535
|
+
* List users in the system
|
|
536
|
+
* List users in the system for the specified platform
|
|
537
|
+
* @returns SCIMUserListResponse
|
|
523
538
|
* @throws ApiError
|
|
524
539
|
*/
|
|
525
|
-
public static
|
|
526
|
-
|
|
540
|
+
public static listUsers({
|
|
541
|
+
platformKey,
|
|
527
542
|
}: {
|
|
528
|
-
|
|
529
|
-
}): CancelablePromise<
|
|
543
|
+
platformKey: string,
|
|
544
|
+
}): CancelablePromise<Array<SCIMUserListResponse>> {
|
|
530
545
|
return __request(OpenAPI, {
|
|
531
546
|
method: 'GET',
|
|
532
|
-
url: '/api/orgs/{
|
|
547
|
+
url: '/api/orgs/{platform_key}/scim/v2/Users/',
|
|
533
548
|
path: {
|
|
534
|
-
'
|
|
549
|
+
'platform_key': platformKey,
|
|
535
550
|
},
|
|
536
551
|
});
|
|
537
552
|
}
|
|
538
553
|
/**
|
|
539
|
-
*
|
|
540
|
-
*
|
|
541
|
-
*
|
|
542
|
-
* @returns any No response body
|
|
554
|
+
* Create a new user in the system
|
|
555
|
+
* Create a new user in the system for the specified platform
|
|
556
|
+
* @returns SCIMUserResponse
|
|
543
557
|
* @throws ApiError
|
|
544
558
|
*/
|
|
545
|
-
public static
|
|
546
|
-
|
|
559
|
+
public static createUser({
|
|
560
|
+
platformKey,
|
|
561
|
+
requestBody,
|
|
547
562
|
}: {
|
|
548
|
-
|
|
549
|
-
|
|
563
|
+
platformKey: string,
|
|
564
|
+
requestBody: SCIMUserCreateRequest,
|
|
565
|
+
}): CancelablePromise<SCIMUserResponse> {
|
|
550
566
|
return __request(OpenAPI, {
|
|
551
567
|
method: 'POST',
|
|
552
|
-
url: '/api/orgs/{
|
|
568
|
+
url: '/api/orgs/{platform_key}/scim/v2/Users/',
|
|
553
569
|
path: {
|
|
554
|
-
'
|
|
570
|
+
'platform_key': platformKey,
|
|
555
571
|
},
|
|
572
|
+
body: requestBody,
|
|
573
|
+
mediaType: 'application/json',
|
|
556
574
|
});
|
|
557
575
|
}
|
|
558
576
|
/**
|
|
559
|
-
*
|
|
560
|
-
*
|
|
561
|
-
*
|
|
562
|
-
* @returns any No response body
|
|
577
|
+
* Get details of a specific user
|
|
578
|
+
* Get details of a specific user by ID for the specified platform
|
|
579
|
+
* @returns SCIMUserResponse
|
|
563
580
|
* @throws ApiError
|
|
564
581
|
*/
|
|
565
|
-
public static
|
|
582
|
+
public static retrieveUser({
|
|
566
583
|
id,
|
|
567
|
-
|
|
584
|
+
platformKey,
|
|
568
585
|
}: {
|
|
569
586
|
id: string,
|
|
570
|
-
|
|
571
|
-
}): CancelablePromise<
|
|
587
|
+
platformKey: string,
|
|
588
|
+
}): CancelablePromise<SCIMUserResponse> {
|
|
572
589
|
return __request(OpenAPI, {
|
|
573
590
|
method: 'GET',
|
|
574
|
-
url: '/api/orgs/{
|
|
591
|
+
url: '/api/orgs/{platform_key}/scim/v2/Users/{id}/',
|
|
575
592
|
path: {
|
|
576
593
|
'id': id,
|
|
577
|
-
'
|
|
594
|
+
'platform_key': platformKey,
|
|
578
595
|
},
|
|
579
596
|
});
|
|
580
597
|
}
|
|
581
598
|
/**
|
|
582
|
-
*
|
|
583
|
-
*
|
|
584
|
-
*
|
|
585
|
-
* @returns any No response body
|
|
599
|
+
* Update a user
|
|
600
|
+
* Update a user for the specified platform
|
|
601
|
+
* @returns SCIMUserResponse
|
|
586
602
|
* @throws ApiError
|
|
587
603
|
*/
|
|
588
|
-
public static
|
|
604
|
+
public static updateUser({
|
|
589
605
|
id,
|
|
590
|
-
|
|
606
|
+
platformKey,
|
|
607
|
+
requestBody,
|
|
591
608
|
}: {
|
|
592
609
|
id: string,
|
|
593
|
-
|
|
594
|
-
|
|
610
|
+
platformKey: string,
|
|
611
|
+
requestBody: SCIMUserCreateRequest,
|
|
612
|
+
}): CancelablePromise<SCIMUserResponse> {
|
|
595
613
|
return __request(OpenAPI, {
|
|
596
614
|
method: 'PUT',
|
|
597
|
-
url: '/api/orgs/{
|
|
615
|
+
url: '/api/orgs/{platform_key}/scim/v2/Users/{id}/',
|
|
598
616
|
path: {
|
|
599
617
|
'id': id,
|
|
600
|
-
'
|
|
618
|
+
'platform_key': platformKey,
|
|
601
619
|
},
|
|
620
|
+
body: requestBody,
|
|
621
|
+
mediaType: 'application/json',
|
|
602
622
|
});
|
|
603
623
|
}
|
|
604
624
|
/**
|
|
605
|
-
*
|
|
625
|
+
* Delete a user (not supported)
|
|
626
|
+
* Delete a user for the specified platform (not supported)
|
|
606
627
|
* @returns void
|
|
607
628
|
* @throws ApiError
|
|
608
629
|
*/
|
|
609
|
-
public static
|
|
630
|
+
public static deleteUser({
|
|
610
631
|
id,
|
|
611
|
-
|
|
632
|
+
platformKey,
|
|
612
633
|
}: {
|
|
613
634
|
id: string,
|
|
614
|
-
|
|
635
|
+
platformKey: string,
|
|
615
636
|
}): CancelablePromise<void> {
|
|
616
637
|
return __request(OpenAPI, {
|
|
617
638
|
method: 'DELETE',
|
|
618
|
-
url: '/api/orgs/{
|
|
639
|
+
url: '/api/orgs/{platform_key}/scim/v2/Users/{id}/',
|
|
619
640
|
path: {
|
|
620
641
|
'id': id,
|
|
621
|
-
'
|
|
642
|
+
'platform_key': platformKey,
|
|
622
643
|
},
|
|
623
644
|
});
|
|
624
645
|
}
|