@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
|
@@ -1,291 +1,294 @@
|
|
|
1
|
+
import type { SCIMDepartment } from '../models/SCIMDepartment';
|
|
2
|
+
import type { SCIMGroup } from '../models/SCIMGroup';
|
|
3
|
+
import type { SCIMUserCreateRequest } from '../models/SCIMUserCreateRequest';
|
|
4
|
+
import type { SCIMUserListResponse } from '../models/SCIMUserListResponse';
|
|
5
|
+
import type { SCIMUserResponse } from '../models/SCIMUserResponse';
|
|
1
6
|
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
2
7
|
export declare class ScimService {
|
|
3
8
|
/**
|
|
4
|
-
*
|
|
5
|
-
* List all department members in the system
|
|
6
|
-
* @returns any
|
|
9
|
+
* List all department members in the system
|
|
10
|
+
* List all department members in the system for the specified platform
|
|
11
|
+
* @returns any
|
|
7
12
|
* @throws ApiError
|
|
8
13
|
*/
|
|
9
|
-
static
|
|
10
|
-
|
|
11
|
-
}): CancelablePromise<any
|
|
14
|
+
static listDepartmentMembers({ platformKey, }: {
|
|
15
|
+
platformKey: string;
|
|
16
|
+
}): CancelablePromise<Array<any>>;
|
|
12
17
|
/**
|
|
13
|
-
*
|
|
14
|
-
* Create
|
|
15
|
-
* @returns any
|
|
18
|
+
* Create a new department member
|
|
19
|
+
* Create a new department member for the specified platform
|
|
20
|
+
* @returns any
|
|
16
21
|
* @throws ApiError
|
|
17
22
|
*/
|
|
18
|
-
static
|
|
19
|
-
|
|
23
|
+
static createDepartmentMember({ platformKey, }: {
|
|
24
|
+
platformKey: string;
|
|
20
25
|
}): CancelablePromise<any>;
|
|
21
26
|
/**
|
|
22
|
-
*
|
|
23
|
-
* Get department members for a specific department (
|
|
24
|
-
* @returns any
|
|
27
|
+
* Get department members for a specific department
|
|
28
|
+
* Get department members for a specific department (by department id) for the specified platform
|
|
29
|
+
* @returns any
|
|
25
30
|
* @throws ApiError
|
|
26
31
|
*/
|
|
27
|
-
static
|
|
32
|
+
static retrieveDepartmentMembers({ id, platformKey, }: {
|
|
28
33
|
id: string;
|
|
29
|
-
|
|
34
|
+
platformKey: string;
|
|
30
35
|
}): CancelablePromise<any>;
|
|
31
36
|
/**
|
|
32
|
-
*
|
|
33
|
-
* Update a department member
|
|
34
|
-
* @returns any
|
|
37
|
+
* Update a department member
|
|
38
|
+
* Update a department member for the specified platform
|
|
39
|
+
* @returns any
|
|
35
40
|
* @throws ApiError
|
|
36
41
|
*/
|
|
37
|
-
static
|
|
42
|
+
static updateDepartmentMember({ id, platformKey, }: {
|
|
38
43
|
id: string;
|
|
39
|
-
|
|
44
|
+
platformKey: string;
|
|
40
45
|
}): CancelablePromise<any>;
|
|
41
46
|
/**
|
|
42
|
-
*
|
|
43
|
-
* Delete a department member
|
|
47
|
+
* Delete a department member
|
|
48
|
+
* Delete a department member from the system
|
|
44
49
|
* @returns void
|
|
45
50
|
* @throws ApiError
|
|
46
51
|
*/
|
|
47
|
-
static
|
|
52
|
+
static deleteDepartmentMember({ id, platformKey, }: {
|
|
48
53
|
id: string;
|
|
49
|
-
|
|
54
|
+
platformKey: string;
|
|
50
55
|
}): CancelablePromise<void>;
|
|
51
56
|
/**
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
* @returns any No response body
|
|
57
|
+
* List departments in the system
|
|
58
|
+
* List departments in the system for the specified platform
|
|
59
|
+
* @returns any
|
|
56
60
|
* @throws ApiError
|
|
57
61
|
*/
|
|
58
|
-
static
|
|
59
|
-
|
|
60
|
-
}): CancelablePromise<any
|
|
62
|
+
static listDepartments({ platformKey, }: {
|
|
63
|
+
platformKey: string;
|
|
64
|
+
}): CancelablePromise<Array<any>>;
|
|
61
65
|
/**
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
* @returns any No response body
|
|
66
|
+
* Create a new department
|
|
67
|
+
* Create a new department for the specified platform
|
|
68
|
+
* @returns SCIMDepartment
|
|
66
69
|
* @throws ApiError
|
|
67
70
|
*/
|
|
68
|
-
static
|
|
69
|
-
|
|
70
|
-
|
|
71
|
+
static createDepartment({ platformKey, requestBody, }: {
|
|
72
|
+
platformKey: string;
|
|
73
|
+
requestBody: SCIMDepartment;
|
|
74
|
+
}): CancelablePromise<SCIMDepartment>;
|
|
71
75
|
/**
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
* @returns any No response body
|
|
76
|
+
* Get details of a specific department
|
|
77
|
+
* Get details of a specific department by ID for the specified platform
|
|
78
|
+
* @returns SCIMDepartment
|
|
76
79
|
* @throws ApiError
|
|
77
80
|
*/
|
|
78
|
-
static
|
|
81
|
+
static retrieveDepartment({ id, platformKey, }: {
|
|
79
82
|
id: string;
|
|
80
|
-
|
|
81
|
-
}): CancelablePromise<
|
|
83
|
+
platformKey: string;
|
|
84
|
+
}): CancelablePromise<SCIMDepartment>;
|
|
82
85
|
/**
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
* @returns any No response body
|
|
86
|
+
* Update a department
|
|
87
|
+
* Update a department for the specified platform
|
|
88
|
+
* @returns SCIMDepartment
|
|
87
89
|
* @throws ApiError
|
|
88
90
|
*/
|
|
89
|
-
static
|
|
91
|
+
static updateDepartment({ id, platformKey, requestBody, }: {
|
|
90
92
|
id: string;
|
|
91
|
-
|
|
92
|
-
|
|
93
|
+
platformKey: string;
|
|
94
|
+
requestBody: SCIMDepartment;
|
|
95
|
+
}): CancelablePromise<SCIMDepartment>;
|
|
93
96
|
/**
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
* Delete a department from the system.
|
|
97
|
+
* Delete a department
|
|
98
|
+
* Delete a department from the system
|
|
97
99
|
* @returns void
|
|
98
100
|
* @throws ApiError
|
|
99
101
|
*/
|
|
100
|
-
static
|
|
102
|
+
static deleteDepartment({ id, platformKey, }: {
|
|
101
103
|
id: string;
|
|
102
|
-
|
|
104
|
+
platformKey: string;
|
|
103
105
|
}): CancelablePromise<void>;
|
|
104
106
|
/**
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
* @returns any No response body
|
|
107
|
+
* Add members to a department
|
|
108
|
+
* Add members to a department using SCIM patch operations
|
|
109
|
+
* @returns any
|
|
109
110
|
* @throws ApiError
|
|
110
111
|
*/
|
|
111
|
-
static
|
|
112
|
+
static addDepartmentMembers({ id, platformKey, }: {
|
|
112
113
|
id: string;
|
|
113
|
-
|
|
114
|
+
platformKey: string;
|
|
114
115
|
}): CancelablePromise<any>;
|
|
115
116
|
/**
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
* @returns any No response body
|
|
117
|
+
* Remove members from a department
|
|
118
|
+
* Remove members from a department using SCIM patch operations
|
|
119
|
+
* @returns any
|
|
120
120
|
* @throws ApiError
|
|
121
121
|
*/
|
|
122
|
-
static
|
|
122
|
+
static removeDepartmentMembers({ id, platformKey, }: {
|
|
123
123
|
id: string;
|
|
124
|
-
|
|
124
|
+
platformKey: string;
|
|
125
125
|
}): CancelablePromise<any>;
|
|
126
126
|
/**
|
|
127
|
-
*
|
|
128
|
-
*
|
|
127
|
+
* List all group members in the system
|
|
128
|
+
* List all group members in the system for the specified platform
|
|
129
|
+
* @returns any
|
|
129
130
|
* @throws ApiError
|
|
130
131
|
*/
|
|
131
|
-
static
|
|
132
|
-
|
|
133
|
-
}): CancelablePromise<any
|
|
132
|
+
static listGroupMembers({ platformKey, }: {
|
|
133
|
+
platformKey: string;
|
|
134
|
+
}): CancelablePromise<Array<any>>;
|
|
134
135
|
/**
|
|
135
|
-
*
|
|
136
|
-
*
|
|
136
|
+
* Create a new group member
|
|
137
|
+
* Create a new group member for the specified platform
|
|
138
|
+
* @returns any
|
|
137
139
|
* @throws ApiError
|
|
138
140
|
*/
|
|
139
|
-
static
|
|
140
|
-
|
|
141
|
+
static createGroupMember({ platformKey, }: {
|
|
142
|
+
platformKey: string;
|
|
141
143
|
}): CancelablePromise<any>;
|
|
142
144
|
/**
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
+
* Get details of a specific group member
|
|
146
|
+
* Get details of a specific group member by ID for the specified platform
|
|
147
|
+
* @returns any
|
|
145
148
|
* @throws ApiError
|
|
146
149
|
*/
|
|
147
|
-
static
|
|
150
|
+
static retrieveGroupMember({ id, platformKey, }: {
|
|
148
151
|
id: string;
|
|
149
|
-
|
|
152
|
+
platformKey: string;
|
|
150
153
|
}): CancelablePromise<any>;
|
|
151
154
|
/**
|
|
152
|
-
*
|
|
153
|
-
*
|
|
155
|
+
* Update a group member
|
|
156
|
+
* Update a group member for the specified platform
|
|
157
|
+
* @returns any
|
|
154
158
|
* @throws ApiError
|
|
155
159
|
*/
|
|
156
|
-
static
|
|
160
|
+
static updateGroupMember({ id, platformKey, }: {
|
|
157
161
|
id: string;
|
|
158
|
-
|
|
162
|
+
platformKey: string;
|
|
159
163
|
}): CancelablePromise<any>;
|
|
160
164
|
/**
|
|
161
|
-
*
|
|
165
|
+
* Delete a group member
|
|
166
|
+
* Delete a group member from the system
|
|
162
167
|
* @returns void
|
|
163
168
|
* @throws ApiError
|
|
164
169
|
*/
|
|
165
|
-
static
|
|
170
|
+
static deleteGroupMember({ id, platformKey, }: {
|
|
166
171
|
id: string;
|
|
167
|
-
|
|
172
|
+
platformKey: string;
|
|
168
173
|
}): CancelablePromise<void>;
|
|
169
174
|
/**
|
|
170
|
-
*
|
|
171
|
-
*
|
|
175
|
+
* List user groups in the system
|
|
176
|
+
* List user groups in the system for the specified platform
|
|
177
|
+
* @returns any
|
|
172
178
|
* @throws ApiError
|
|
173
179
|
*/
|
|
174
|
-
static
|
|
175
|
-
|
|
176
|
-
}): CancelablePromise<any
|
|
180
|
+
static listGroups({ platformKey, }: {
|
|
181
|
+
platformKey: string;
|
|
182
|
+
}): CancelablePromise<Array<any>>;
|
|
177
183
|
/**
|
|
178
|
-
*
|
|
179
|
-
*
|
|
184
|
+
* Create a new user group
|
|
185
|
+
* Create a new user group for the specified platform
|
|
186
|
+
* @returns SCIMGroup
|
|
180
187
|
* @throws ApiError
|
|
181
188
|
*/
|
|
182
|
-
static
|
|
183
|
-
|
|
184
|
-
|
|
189
|
+
static createGroup({ platformKey, requestBody, }: {
|
|
190
|
+
platformKey: string;
|
|
191
|
+
requestBody: SCIMGroup;
|
|
192
|
+
}): CancelablePromise<SCIMGroup>;
|
|
185
193
|
/**
|
|
186
|
-
*
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
* @returns any No response body
|
|
194
|
+
* Get details of a specific group
|
|
195
|
+
* Get details of a specific group by ID for the specified platform
|
|
196
|
+
* @returns SCIMGroup
|
|
190
197
|
* @throws ApiError
|
|
191
198
|
*/
|
|
192
|
-
static
|
|
199
|
+
static retrieveGroup({ id, platformKey, }: {
|
|
193
200
|
id: string;
|
|
194
|
-
|
|
195
|
-
}): CancelablePromise<
|
|
201
|
+
platformKey: string;
|
|
202
|
+
}): CancelablePromise<SCIMGroup>;
|
|
196
203
|
/**
|
|
197
|
-
*
|
|
198
|
-
*
|
|
199
|
-
*
|
|
200
|
-
* @returns any No response body
|
|
204
|
+
* Update a user group
|
|
205
|
+
* Update a user group for the specified platform
|
|
206
|
+
* @returns SCIMGroup
|
|
201
207
|
* @throws ApiError
|
|
202
208
|
*/
|
|
203
|
-
static
|
|
209
|
+
static updateGroup({ id, platformKey, requestBody, }: {
|
|
204
210
|
id: string;
|
|
205
|
-
|
|
206
|
-
|
|
211
|
+
platformKey: string;
|
|
212
|
+
requestBody: SCIMGroup;
|
|
213
|
+
}): CancelablePromise<SCIMGroup>;
|
|
207
214
|
/**
|
|
208
|
-
*
|
|
209
|
-
*
|
|
210
|
-
* Delete a user group from the system.
|
|
215
|
+
* Delete a user group
|
|
216
|
+
* Delete a user group from the system
|
|
211
217
|
* @returns void
|
|
212
218
|
* @throws ApiError
|
|
213
219
|
*/
|
|
214
|
-
static
|
|
220
|
+
static deleteGroup({ id, platformKey, }: {
|
|
215
221
|
id: string;
|
|
216
|
-
|
|
222
|
+
platformKey: string;
|
|
217
223
|
}): CancelablePromise<void>;
|
|
218
224
|
/**
|
|
219
|
-
*
|
|
220
|
-
*
|
|
221
|
-
*
|
|
222
|
-
* @returns any No response body
|
|
225
|
+
* Add members to a user group
|
|
226
|
+
* Add members to a user group using SCIM patch operations
|
|
227
|
+
* @returns any
|
|
223
228
|
* @throws ApiError
|
|
224
229
|
*/
|
|
225
|
-
static
|
|
230
|
+
static addGroupMembers({ id, platformKey, }: {
|
|
226
231
|
id: string;
|
|
227
|
-
|
|
232
|
+
platformKey: string;
|
|
228
233
|
}): CancelablePromise<any>;
|
|
229
234
|
/**
|
|
230
|
-
*
|
|
231
|
-
*
|
|
232
|
-
*
|
|
233
|
-
* @returns any No response body
|
|
235
|
+
* Remove members from a user group
|
|
236
|
+
* Remove members from a user group using SCIM patch operations
|
|
237
|
+
* @returns any
|
|
234
238
|
* @throws ApiError
|
|
235
239
|
*/
|
|
236
|
-
static
|
|
240
|
+
static removeGroupMembers({ id, platformKey, }: {
|
|
237
241
|
id: string;
|
|
238
|
-
|
|
242
|
+
platformKey: string;
|
|
239
243
|
}): CancelablePromise<any>;
|
|
240
244
|
/**
|
|
241
|
-
*
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
* @returns any No response body
|
|
245
|
+
* List users in the system
|
|
246
|
+
* List users in the system for the specified platform
|
|
247
|
+
* @returns SCIMUserListResponse
|
|
245
248
|
* @throws ApiError
|
|
246
249
|
*/
|
|
247
|
-
static
|
|
248
|
-
|
|
249
|
-
}): CancelablePromise<
|
|
250
|
+
static listUsers({ platformKey, }: {
|
|
251
|
+
platformKey: string;
|
|
252
|
+
}): CancelablePromise<Array<SCIMUserListResponse>>;
|
|
250
253
|
/**
|
|
251
|
-
*
|
|
252
|
-
*
|
|
253
|
-
*
|
|
254
|
-
* @returns any No response body
|
|
254
|
+
* Create a new user in the system
|
|
255
|
+
* Create a new user in the system for the specified platform
|
|
256
|
+
* @returns SCIMUserResponse
|
|
255
257
|
* @throws ApiError
|
|
256
258
|
*/
|
|
257
|
-
static
|
|
258
|
-
|
|
259
|
-
|
|
259
|
+
static createUser({ platformKey, requestBody, }: {
|
|
260
|
+
platformKey: string;
|
|
261
|
+
requestBody: SCIMUserCreateRequest;
|
|
262
|
+
}): CancelablePromise<SCIMUserResponse>;
|
|
260
263
|
/**
|
|
261
|
-
*
|
|
262
|
-
*
|
|
263
|
-
*
|
|
264
|
-
* @returns any No response body
|
|
264
|
+
* Get details of a specific user
|
|
265
|
+
* Get details of a specific user by ID for the specified platform
|
|
266
|
+
* @returns SCIMUserResponse
|
|
265
267
|
* @throws ApiError
|
|
266
268
|
*/
|
|
267
|
-
static
|
|
269
|
+
static retrieveUser({ id, platformKey, }: {
|
|
268
270
|
id: string;
|
|
269
|
-
|
|
270
|
-
}): CancelablePromise<
|
|
271
|
+
platformKey: string;
|
|
272
|
+
}): CancelablePromise<SCIMUserResponse>;
|
|
271
273
|
/**
|
|
272
|
-
*
|
|
273
|
-
*
|
|
274
|
-
*
|
|
275
|
-
* @returns any No response body
|
|
274
|
+
* Update a user
|
|
275
|
+
* Update a user for the specified platform
|
|
276
|
+
* @returns SCIMUserResponse
|
|
276
277
|
* @throws ApiError
|
|
277
278
|
*/
|
|
278
|
-
static
|
|
279
|
+
static updateUser({ id, platformKey, requestBody, }: {
|
|
279
280
|
id: string;
|
|
280
|
-
|
|
281
|
-
|
|
281
|
+
platformKey: string;
|
|
282
|
+
requestBody: SCIMUserCreateRequest;
|
|
283
|
+
}): CancelablePromise<SCIMUserResponse>;
|
|
282
284
|
/**
|
|
283
|
-
*
|
|
285
|
+
* Delete a user (not supported)
|
|
286
|
+
* Delete a user for the specified platform (not supported)
|
|
284
287
|
* @returns void
|
|
285
288
|
* @throws ApiError
|
|
286
289
|
*/
|
|
287
|
-
static
|
|
290
|
+
static deleteUser({ id, platformKey, }: {
|
|
288
291
|
id: string;
|
|
289
|
-
|
|
292
|
+
platformKey: string;
|
|
290
293
|
}): CancelablePromise<void>;
|
|
291
294
|
}
|