@unified-api/typescript-sdk 2.9.3 → 2.9.5
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/FUNCTIONS.md +108 -0
- package/README.md +36 -15
- package/RUNTIMES.md +22 -0
- package/docs/sdks/account/README.md +501 -0
- package/docs/sdks/accounting/README.md +3629 -0
- package/docs/sdks/activity/README.md +501 -0
- package/docs/sdks/apicall/README.md +165 -0
- package/docs/sdks/application/README.md +501 -0
- package/docs/sdks/applicationstatus/README.md +88 -0
- package/docs/sdks/ats/README.md +3710 -0
- package/docs/sdks/auth/README.md +173 -0
- package/docs/sdks/branch/README.md +501 -0
- package/docs/sdks/call/README.md +88 -0
- package/docs/sdks/candidate/README.md +501 -0
- package/docs/sdks/channel/README.md +171 -0
- package/docs/sdks/class/README.md +501 -0
- package/docs/sdks/collection/README.md +501 -0
- package/docs/sdks/commerce/README.md +2477 -0
- package/docs/sdks/commit/README.md +501 -0
- package/docs/sdks/company/README.md +1240 -0
- package/docs/sdks/connection/README.md +485 -0
- package/docs/sdks/contact/README.md +1489 -0
- package/docs/sdks/course/README.md +501 -0
- package/docs/sdks/crm/README.md +2971 -0
- package/docs/sdks/customer/README.md +501 -0
- package/docs/sdks/deal/README.md +501 -0
- package/docs/sdks/document/README.md +501 -0
- package/docs/sdks/employee/README.md +501 -0
- package/docs/sdks/enrich/README.md +169 -0
- package/docs/sdks/event/README.md +501 -0
- package/docs/sdks/file/README.md +501 -0
- package/docs/sdks/genai/README.md +169 -0
- package/docs/sdks/group/README.md +995 -0
- package/docs/sdks/hris/README.md +2311 -0
- package/docs/sdks/instructor/README.md +501 -0
- package/docs/sdks/integration/README.md +248 -0
- package/docs/sdks/interview/README.md +501 -0
- package/docs/sdks/inventory/README.md +501 -0
- package/docs/sdks/invoice/README.md +501 -0
- package/docs/sdks/issue/README.md +84 -0
- package/docs/sdks/item/README.md +501 -0
- package/docs/sdks/job/README.md +501 -0
- package/docs/sdks/journal/README.md +501 -0
- package/docs/sdks/kms/README.md +995 -0
- package/docs/sdks/lead/README.md +501 -0
- package/docs/sdks/link/README.md +501 -0
- package/docs/sdks/list/README.md +501 -0
- package/docs/sdks/lms/README.md +1983 -0
- package/docs/sdks/location/README.md +995 -0
- package/docs/sdks/login/README.md +90 -0
- package/docs/sdks/martech/README.md +995 -0
- package/docs/sdks/member/README.md +501 -0
- package/docs/sdks/message/README.md +501 -0
- package/docs/sdks/messaging/README.md +665 -0
- package/docs/sdks/metadata/README.md +501 -0
- package/docs/sdks/model/README.md +88 -0
- package/docs/sdks/note/README.md +501 -0
- package/docs/sdks/order/README.md +501 -0
- package/docs/sdks/organization/README.md +665 -0
- package/docs/sdks/page/README.md +501 -0
- package/docs/sdks/passthrough/README.md +671 -0
- package/docs/sdks/payment/README.md +1323 -0
- package/docs/sdks/payout/README.md +171 -0
- package/docs/sdks/payslip/README.md +171 -0
- package/docs/sdks/person/README.md +88 -0
- package/docs/sdks/pipeline/README.md +501 -0
- package/docs/sdks/project/README.md +501 -0
- package/docs/sdks/prompt/README.md +88 -0
- package/docs/sdks/pullrequest/README.md +501 -0
- package/docs/sdks/refund/README.md +171 -0
- package/docs/sdks/repo/README.md +2477 -0
- package/docs/sdks/repository/README.md +501 -0
- package/docs/sdks/scim/README.md +995 -0
- package/docs/sdks/scorecard/README.md +501 -0
- package/docs/sdks/space/README.md +501 -0
- package/docs/sdks/storage/README.md +501 -0
- package/docs/sdks/student/README.md +501 -0
- package/docs/sdks/task/README.md +995 -0
- package/docs/sdks/taxrate/README.md +501 -0
- package/docs/sdks/ticket/README.md +501 -0
- package/docs/sdks/ticketing/README.md +1489 -0
- package/docs/sdks/timeoff/README.md +171 -0
- package/docs/sdks/transaction/README.md +501 -0
- package/docs/sdks/uc/README.md +582 -0
- package/docs/sdks/unified/README.md +1601 -0
- package/docs/sdks/unifiedto/README.md +7 -0
- package/docs/sdks/user/README.md +501 -0
- package/docs/sdks/webhook/README.md +647 -0
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/primitives.d.ts +2 -0
- package/lib/primitives.d.ts.map +1 -1
- package/lib/primitives.js +53 -0
- package/lib/primitives.js.map +1 -1
- package/package.json +3 -1
- package/sdk/models/shared/index.d.ts +1 -0
- package/sdk/models/shared/index.d.ts.map +1 -1
- package/sdk/models/shared/index.js +1 -0
- package/sdk/models/shared/index.js.map +1 -1
- package/sdk/models/shared/kmspage.d.ts +5 -0
- package/sdk/models/shared/kmspage.d.ts.map +1 -1
- package/sdk/models/shared/kmspage.js +7 -0
- package/sdk/models/shared/kmspage.js.map +1 -1
- package/sdk/models/shared/kmspagemetadata.d.ts +37 -0
- package/sdk/models/shared/kmspagemetadata.d.ts.map +1 -0
- package/sdk/models/shared/kmspagemetadata.js +63 -0
- package/sdk/models/shared/kmspagemetadata.js.map +1 -0
- package/sdk/models/shared/kmsspace.d.ts +2 -0
- package/sdk/models/shared/kmsspace.d.ts.map +1 -1
- package/sdk/models/shared/kmsspace.js +4 -0
- package/sdk/models/shared/kmsspace.js.map +1 -1
- package/sdk/models/shared/security.d.ts +2 -2
- package/sdk/models/shared/security.d.ts.map +1 -1
- package/sdk/models/shared/security.js +2 -2
- package/sdk/models/shared/security.js.map +1 -1
- package/sdk/types/operations.d.ts +5 -3
- package/sdk/types/operations.d.ts.map +1 -1
- package/sdk/types/operations.js +3 -0
- package/sdk/types/operations.js.map +1 -1
- package/src/lib/config.ts +3 -3
- package/src/lib/primitives.ts +62 -0
- package/src/sdk/models/shared/index.ts +1 -0
- package/src/sdk/models/shared/kmspage.ts +16 -0
- package/src/sdk/models/shared/kmspagemetadata.ts +72 -0
- package/src/sdk/models/shared/kmsspace.ts +6 -0
- package/src/sdk/models/shared/security.ts +4 -4
- package/src/sdk/types/operations.ts +11 -5
|
@@ -0,0 +1,995 @@
|
|
|
1
|
+
# Scim
|
|
2
|
+
(*scim*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [createScimGroups](#createscimgroups) - Create group
|
|
9
|
+
* [createScimUsers](#createscimusers) - Create user
|
|
10
|
+
* [getScimGroups](#getscimgroups) - Get group
|
|
11
|
+
* [getScimUsers](#getscimusers) - Get user
|
|
12
|
+
* [listScimGroups](#listscimgroups) - List groups
|
|
13
|
+
* [listScimUsers](#listscimusers) - List users
|
|
14
|
+
* [patchScimGroups](#patchscimgroups) - Update group
|
|
15
|
+
* [patchScimUsers](#patchscimusers) - Update user
|
|
16
|
+
* [removeScimGroups](#removescimgroups) - Delete group
|
|
17
|
+
* [removeScimUsers](#removescimusers) - Delete user
|
|
18
|
+
* [updateScimGroups](#updatescimgroups) - Update group
|
|
19
|
+
* [updateScimUsers](#updatescimusers) - Update user
|
|
20
|
+
|
|
21
|
+
## createScimGroups
|
|
22
|
+
|
|
23
|
+
Create group
|
|
24
|
+
|
|
25
|
+
### Example Usage
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
29
|
+
|
|
30
|
+
const unifiedTo = new UnifiedTo({
|
|
31
|
+
security: {
|
|
32
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
33
|
+
},
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
async function run() {
|
|
37
|
+
const result = await unifiedTo.scim.createScimGroups({
|
|
38
|
+
connectionId: "<id>",
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
// Handle the result
|
|
42
|
+
console.log(result);
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
run();
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Standalone function
|
|
49
|
+
|
|
50
|
+
The standalone function version of this method:
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
54
|
+
import { scimCreateScimGroups } from "@unified-api/typescript-sdk/funcs/scimCreateScimGroups.js";
|
|
55
|
+
|
|
56
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
57
|
+
// You can create one instance of it to use across an application.
|
|
58
|
+
const unifiedTo = new UnifiedToCore({
|
|
59
|
+
security: {
|
|
60
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
61
|
+
},
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
async function run() {
|
|
65
|
+
const res = await scimCreateScimGroups(unifiedTo, {
|
|
66
|
+
connectionId: "<id>",
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
if (!res.ok) {
|
|
70
|
+
throw res.error;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
const { value: result } = res;
|
|
74
|
+
|
|
75
|
+
// Handle the result
|
|
76
|
+
console.log(result);
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
run();
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Parameters
|
|
83
|
+
|
|
84
|
+
| Parameter | Type | Required | Description |
|
|
85
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
86
|
+
| `request` | [operations.CreateScimGroupsRequest](../../sdk/models/operations/createscimgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
87
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
88
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
89
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
90
|
+
|
|
91
|
+
### Response
|
|
92
|
+
|
|
93
|
+
**Promise\<[shared.ScimGroup](../../sdk/models/shared/scimgroup.md)\>**
|
|
94
|
+
|
|
95
|
+
### Errors
|
|
96
|
+
|
|
97
|
+
| Error Type | Status Code | Content Type |
|
|
98
|
+
| --------------- | --------------- | --------------- |
|
|
99
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
100
|
+
|
|
101
|
+
## createScimUsers
|
|
102
|
+
|
|
103
|
+
Create user
|
|
104
|
+
|
|
105
|
+
### Example Usage
|
|
106
|
+
|
|
107
|
+
```typescript
|
|
108
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
109
|
+
|
|
110
|
+
const unifiedTo = new UnifiedTo({
|
|
111
|
+
security: {
|
|
112
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
113
|
+
},
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
async function run() {
|
|
117
|
+
const result = await unifiedTo.scim.createScimUsers({
|
|
118
|
+
connectionId: "<id>",
|
|
119
|
+
});
|
|
120
|
+
|
|
121
|
+
// Handle the result
|
|
122
|
+
console.log(result);
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
run();
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Standalone function
|
|
129
|
+
|
|
130
|
+
The standalone function version of this method:
|
|
131
|
+
|
|
132
|
+
```typescript
|
|
133
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
134
|
+
import { scimCreateScimUsers } from "@unified-api/typescript-sdk/funcs/scimCreateScimUsers.js";
|
|
135
|
+
|
|
136
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
137
|
+
// You can create one instance of it to use across an application.
|
|
138
|
+
const unifiedTo = new UnifiedToCore({
|
|
139
|
+
security: {
|
|
140
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
141
|
+
},
|
|
142
|
+
});
|
|
143
|
+
|
|
144
|
+
async function run() {
|
|
145
|
+
const res = await scimCreateScimUsers(unifiedTo, {
|
|
146
|
+
connectionId: "<id>",
|
|
147
|
+
});
|
|
148
|
+
|
|
149
|
+
if (!res.ok) {
|
|
150
|
+
throw res.error;
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
const { value: result } = res;
|
|
154
|
+
|
|
155
|
+
// Handle the result
|
|
156
|
+
console.log(result);
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
run();
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Parameters
|
|
163
|
+
|
|
164
|
+
| Parameter | Type | Required | Description |
|
|
165
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
166
|
+
| `request` | [operations.CreateScimUsersRequest](../../sdk/models/operations/createscimusersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
167
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
168
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
169
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
170
|
+
|
|
171
|
+
### Response
|
|
172
|
+
|
|
173
|
+
**Promise\<[shared.ScimUser](../../sdk/models/shared/scimuser.md)\>**
|
|
174
|
+
|
|
175
|
+
### Errors
|
|
176
|
+
|
|
177
|
+
| Error Type | Status Code | Content Type |
|
|
178
|
+
| --------------- | --------------- | --------------- |
|
|
179
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
180
|
+
|
|
181
|
+
## getScimGroups
|
|
182
|
+
|
|
183
|
+
Get group
|
|
184
|
+
|
|
185
|
+
### Example Usage
|
|
186
|
+
|
|
187
|
+
```typescript
|
|
188
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
189
|
+
|
|
190
|
+
const unifiedTo = new UnifiedTo({
|
|
191
|
+
security: {
|
|
192
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
193
|
+
},
|
|
194
|
+
});
|
|
195
|
+
|
|
196
|
+
async function run() {
|
|
197
|
+
const result = await unifiedTo.scim.getScimGroups({
|
|
198
|
+
connectionId: "<id>",
|
|
199
|
+
id: "<id>",
|
|
200
|
+
});
|
|
201
|
+
|
|
202
|
+
// Handle the result
|
|
203
|
+
console.log(result);
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
run();
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
### Standalone function
|
|
210
|
+
|
|
211
|
+
The standalone function version of this method:
|
|
212
|
+
|
|
213
|
+
```typescript
|
|
214
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
215
|
+
import { scimGetScimGroups } from "@unified-api/typescript-sdk/funcs/scimGetScimGroups.js";
|
|
216
|
+
|
|
217
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
218
|
+
// You can create one instance of it to use across an application.
|
|
219
|
+
const unifiedTo = new UnifiedToCore({
|
|
220
|
+
security: {
|
|
221
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
222
|
+
},
|
|
223
|
+
});
|
|
224
|
+
|
|
225
|
+
async function run() {
|
|
226
|
+
const res = await scimGetScimGroups(unifiedTo, {
|
|
227
|
+
connectionId: "<id>",
|
|
228
|
+
id: "<id>",
|
|
229
|
+
});
|
|
230
|
+
|
|
231
|
+
if (!res.ok) {
|
|
232
|
+
throw res.error;
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
const { value: result } = res;
|
|
236
|
+
|
|
237
|
+
// Handle the result
|
|
238
|
+
console.log(result);
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
run();
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
### Parameters
|
|
245
|
+
|
|
246
|
+
| Parameter | Type | Required | Description |
|
|
247
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
248
|
+
| `request` | [operations.GetScimGroupsRequest](../../sdk/models/operations/getscimgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
249
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
250
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
251
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
252
|
+
|
|
253
|
+
### Response
|
|
254
|
+
|
|
255
|
+
**Promise\<[shared.ScimGroup](../../sdk/models/shared/scimgroup.md)\>**
|
|
256
|
+
|
|
257
|
+
### Errors
|
|
258
|
+
|
|
259
|
+
| Error Type | Status Code | Content Type |
|
|
260
|
+
| --------------- | --------------- | --------------- |
|
|
261
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
262
|
+
|
|
263
|
+
## getScimUsers
|
|
264
|
+
|
|
265
|
+
Get user
|
|
266
|
+
|
|
267
|
+
### Example Usage
|
|
268
|
+
|
|
269
|
+
```typescript
|
|
270
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
271
|
+
|
|
272
|
+
const unifiedTo = new UnifiedTo({
|
|
273
|
+
security: {
|
|
274
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
275
|
+
},
|
|
276
|
+
});
|
|
277
|
+
|
|
278
|
+
async function run() {
|
|
279
|
+
const result = await unifiedTo.scim.getScimUsers({
|
|
280
|
+
connectionId: "<id>",
|
|
281
|
+
id: "<id>",
|
|
282
|
+
});
|
|
283
|
+
|
|
284
|
+
// Handle the result
|
|
285
|
+
console.log(result);
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
run();
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
### Standalone function
|
|
292
|
+
|
|
293
|
+
The standalone function version of this method:
|
|
294
|
+
|
|
295
|
+
```typescript
|
|
296
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
297
|
+
import { scimGetScimUsers } from "@unified-api/typescript-sdk/funcs/scimGetScimUsers.js";
|
|
298
|
+
|
|
299
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
300
|
+
// You can create one instance of it to use across an application.
|
|
301
|
+
const unifiedTo = new UnifiedToCore({
|
|
302
|
+
security: {
|
|
303
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
304
|
+
},
|
|
305
|
+
});
|
|
306
|
+
|
|
307
|
+
async function run() {
|
|
308
|
+
const res = await scimGetScimUsers(unifiedTo, {
|
|
309
|
+
connectionId: "<id>",
|
|
310
|
+
id: "<id>",
|
|
311
|
+
});
|
|
312
|
+
|
|
313
|
+
if (!res.ok) {
|
|
314
|
+
throw res.error;
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
const { value: result } = res;
|
|
318
|
+
|
|
319
|
+
// Handle the result
|
|
320
|
+
console.log(result);
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
run();
|
|
324
|
+
```
|
|
325
|
+
|
|
326
|
+
### Parameters
|
|
327
|
+
|
|
328
|
+
| Parameter | Type | Required | Description |
|
|
329
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
330
|
+
| `request` | [operations.GetScimUsersRequest](../../sdk/models/operations/getscimusersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
331
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
332
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
333
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
334
|
+
|
|
335
|
+
### Response
|
|
336
|
+
|
|
337
|
+
**Promise\<[shared.ScimUser](../../sdk/models/shared/scimuser.md)\>**
|
|
338
|
+
|
|
339
|
+
### Errors
|
|
340
|
+
|
|
341
|
+
| Error Type | Status Code | Content Type |
|
|
342
|
+
| --------------- | --------------- | --------------- |
|
|
343
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
344
|
+
|
|
345
|
+
## listScimGroups
|
|
346
|
+
|
|
347
|
+
List groups
|
|
348
|
+
|
|
349
|
+
### Example Usage
|
|
350
|
+
|
|
351
|
+
```typescript
|
|
352
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
353
|
+
|
|
354
|
+
const unifiedTo = new UnifiedTo({
|
|
355
|
+
security: {
|
|
356
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
357
|
+
},
|
|
358
|
+
});
|
|
359
|
+
|
|
360
|
+
async function run() {
|
|
361
|
+
const result = await unifiedTo.scim.listScimGroups({
|
|
362
|
+
connectionId: "<id>",
|
|
363
|
+
});
|
|
364
|
+
|
|
365
|
+
// Handle the result
|
|
366
|
+
console.log(result);
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
run();
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
### Standalone function
|
|
373
|
+
|
|
374
|
+
The standalone function version of this method:
|
|
375
|
+
|
|
376
|
+
```typescript
|
|
377
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
378
|
+
import { scimListScimGroups } from "@unified-api/typescript-sdk/funcs/scimListScimGroups.js";
|
|
379
|
+
|
|
380
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
381
|
+
// You can create one instance of it to use across an application.
|
|
382
|
+
const unifiedTo = new UnifiedToCore({
|
|
383
|
+
security: {
|
|
384
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
385
|
+
},
|
|
386
|
+
});
|
|
387
|
+
|
|
388
|
+
async function run() {
|
|
389
|
+
const res = await scimListScimGroups(unifiedTo, {
|
|
390
|
+
connectionId: "<id>",
|
|
391
|
+
});
|
|
392
|
+
|
|
393
|
+
if (!res.ok) {
|
|
394
|
+
throw res.error;
|
|
395
|
+
}
|
|
396
|
+
|
|
397
|
+
const { value: result } = res;
|
|
398
|
+
|
|
399
|
+
// Handle the result
|
|
400
|
+
console.log(result);
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
run();
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
### Parameters
|
|
407
|
+
|
|
408
|
+
| Parameter | Type | Required | Description |
|
|
409
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
410
|
+
| `request` | [operations.ListScimGroupsRequest](../../sdk/models/operations/listscimgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
411
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
412
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
413
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
414
|
+
|
|
415
|
+
### Response
|
|
416
|
+
|
|
417
|
+
**Promise\<[shared.ScimGroup[]](../../models/.md)\>**
|
|
418
|
+
|
|
419
|
+
### Errors
|
|
420
|
+
|
|
421
|
+
| Error Type | Status Code | Content Type |
|
|
422
|
+
| --------------- | --------------- | --------------- |
|
|
423
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
424
|
+
|
|
425
|
+
## listScimUsers
|
|
426
|
+
|
|
427
|
+
List users
|
|
428
|
+
|
|
429
|
+
### Example Usage
|
|
430
|
+
|
|
431
|
+
```typescript
|
|
432
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
433
|
+
|
|
434
|
+
const unifiedTo = new UnifiedTo({
|
|
435
|
+
security: {
|
|
436
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
437
|
+
},
|
|
438
|
+
});
|
|
439
|
+
|
|
440
|
+
async function run() {
|
|
441
|
+
const result = await unifiedTo.scim.listScimUsers({
|
|
442
|
+
connectionId: "<id>",
|
|
443
|
+
});
|
|
444
|
+
|
|
445
|
+
// Handle the result
|
|
446
|
+
console.log(result);
|
|
447
|
+
}
|
|
448
|
+
|
|
449
|
+
run();
|
|
450
|
+
```
|
|
451
|
+
|
|
452
|
+
### Standalone function
|
|
453
|
+
|
|
454
|
+
The standalone function version of this method:
|
|
455
|
+
|
|
456
|
+
```typescript
|
|
457
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
458
|
+
import { scimListScimUsers } from "@unified-api/typescript-sdk/funcs/scimListScimUsers.js";
|
|
459
|
+
|
|
460
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
461
|
+
// You can create one instance of it to use across an application.
|
|
462
|
+
const unifiedTo = new UnifiedToCore({
|
|
463
|
+
security: {
|
|
464
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
465
|
+
},
|
|
466
|
+
});
|
|
467
|
+
|
|
468
|
+
async function run() {
|
|
469
|
+
const res = await scimListScimUsers(unifiedTo, {
|
|
470
|
+
connectionId: "<id>",
|
|
471
|
+
});
|
|
472
|
+
|
|
473
|
+
if (!res.ok) {
|
|
474
|
+
throw res.error;
|
|
475
|
+
}
|
|
476
|
+
|
|
477
|
+
const { value: result } = res;
|
|
478
|
+
|
|
479
|
+
// Handle the result
|
|
480
|
+
console.log(result);
|
|
481
|
+
}
|
|
482
|
+
|
|
483
|
+
run();
|
|
484
|
+
```
|
|
485
|
+
|
|
486
|
+
### Parameters
|
|
487
|
+
|
|
488
|
+
| Parameter | Type | Required | Description |
|
|
489
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
490
|
+
| `request` | [operations.ListScimUsersRequest](../../sdk/models/operations/listscimusersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
491
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
492
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
493
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
494
|
+
|
|
495
|
+
### Response
|
|
496
|
+
|
|
497
|
+
**Promise\<[shared.ScimUser[]](../../models/.md)\>**
|
|
498
|
+
|
|
499
|
+
### Errors
|
|
500
|
+
|
|
501
|
+
| Error Type | Status Code | Content Type |
|
|
502
|
+
| --------------- | --------------- | --------------- |
|
|
503
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
504
|
+
|
|
505
|
+
## patchScimGroups
|
|
506
|
+
|
|
507
|
+
Update group
|
|
508
|
+
|
|
509
|
+
### Example Usage
|
|
510
|
+
|
|
511
|
+
```typescript
|
|
512
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
513
|
+
|
|
514
|
+
const unifiedTo = new UnifiedTo({
|
|
515
|
+
security: {
|
|
516
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
517
|
+
},
|
|
518
|
+
});
|
|
519
|
+
|
|
520
|
+
async function run() {
|
|
521
|
+
const result = await unifiedTo.scim.patchScimGroups({
|
|
522
|
+
connectionId: "<id>",
|
|
523
|
+
id: "<id>",
|
|
524
|
+
});
|
|
525
|
+
|
|
526
|
+
// Handle the result
|
|
527
|
+
console.log(result);
|
|
528
|
+
}
|
|
529
|
+
|
|
530
|
+
run();
|
|
531
|
+
```
|
|
532
|
+
|
|
533
|
+
### Standalone function
|
|
534
|
+
|
|
535
|
+
The standalone function version of this method:
|
|
536
|
+
|
|
537
|
+
```typescript
|
|
538
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
539
|
+
import { scimPatchScimGroups } from "@unified-api/typescript-sdk/funcs/scimPatchScimGroups.js";
|
|
540
|
+
|
|
541
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
542
|
+
// You can create one instance of it to use across an application.
|
|
543
|
+
const unifiedTo = new UnifiedToCore({
|
|
544
|
+
security: {
|
|
545
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
546
|
+
},
|
|
547
|
+
});
|
|
548
|
+
|
|
549
|
+
async function run() {
|
|
550
|
+
const res = await scimPatchScimGroups(unifiedTo, {
|
|
551
|
+
connectionId: "<id>",
|
|
552
|
+
id: "<id>",
|
|
553
|
+
});
|
|
554
|
+
|
|
555
|
+
if (!res.ok) {
|
|
556
|
+
throw res.error;
|
|
557
|
+
}
|
|
558
|
+
|
|
559
|
+
const { value: result } = res;
|
|
560
|
+
|
|
561
|
+
// Handle the result
|
|
562
|
+
console.log(result);
|
|
563
|
+
}
|
|
564
|
+
|
|
565
|
+
run();
|
|
566
|
+
```
|
|
567
|
+
|
|
568
|
+
### Parameters
|
|
569
|
+
|
|
570
|
+
| Parameter | Type | Required | Description |
|
|
571
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
572
|
+
| `request` | [operations.PatchScimGroupsRequest](../../sdk/models/operations/patchscimgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
573
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
574
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
575
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
576
|
+
|
|
577
|
+
### Response
|
|
578
|
+
|
|
579
|
+
**Promise\<[shared.ScimGroup](../../sdk/models/shared/scimgroup.md)\>**
|
|
580
|
+
|
|
581
|
+
### Errors
|
|
582
|
+
|
|
583
|
+
| Error Type | Status Code | Content Type |
|
|
584
|
+
| --------------- | --------------- | --------------- |
|
|
585
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
586
|
+
|
|
587
|
+
## patchScimUsers
|
|
588
|
+
|
|
589
|
+
Update user
|
|
590
|
+
|
|
591
|
+
### Example Usage
|
|
592
|
+
|
|
593
|
+
```typescript
|
|
594
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
595
|
+
|
|
596
|
+
const unifiedTo = new UnifiedTo({
|
|
597
|
+
security: {
|
|
598
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
599
|
+
},
|
|
600
|
+
});
|
|
601
|
+
|
|
602
|
+
async function run() {
|
|
603
|
+
const result = await unifiedTo.scim.patchScimUsers({
|
|
604
|
+
connectionId: "<id>",
|
|
605
|
+
id: "<id>",
|
|
606
|
+
});
|
|
607
|
+
|
|
608
|
+
// Handle the result
|
|
609
|
+
console.log(result);
|
|
610
|
+
}
|
|
611
|
+
|
|
612
|
+
run();
|
|
613
|
+
```
|
|
614
|
+
|
|
615
|
+
### Standalone function
|
|
616
|
+
|
|
617
|
+
The standalone function version of this method:
|
|
618
|
+
|
|
619
|
+
```typescript
|
|
620
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
621
|
+
import { scimPatchScimUsers } from "@unified-api/typescript-sdk/funcs/scimPatchScimUsers.js";
|
|
622
|
+
|
|
623
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
624
|
+
// You can create one instance of it to use across an application.
|
|
625
|
+
const unifiedTo = new UnifiedToCore({
|
|
626
|
+
security: {
|
|
627
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
628
|
+
},
|
|
629
|
+
});
|
|
630
|
+
|
|
631
|
+
async function run() {
|
|
632
|
+
const res = await scimPatchScimUsers(unifiedTo, {
|
|
633
|
+
connectionId: "<id>",
|
|
634
|
+
id: "<id>",
|
|
635
|
+
});
|
|
636
|
+
|
|
637
|
+
if (!res.ok) {
|
|
638
|
+
throw res.error;
|
|
639
|
+
}
|
|
640
|
+
|
|
641
|
+
const { value: result } = res;
|
|
642
|
+
|
|
643
|
+
// Handle the result
|
|
644
|
+
console.log(result);
|
|
645
|
+
}
|
|
646
|
+
|
|
647
|
+
run();
|
|
648
|
+
```
|
|
649
|
+
|
|
650
|
+
### Parameters
|
|
651
|
+
|
|
652
|
+
| Parameter | Type | Required | Description |
|
|
653
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
654
|
+
| `request` | [operations.PatchScimUsersRequest](../../sdk/models/operations/patchscimusersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
655
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
656
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
657
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
658
|
+
|
|
659
|
+
### Response
|
|
660
|
+
|
|
661
|
+
**Promise\<[shared.ScimUser](../../sdk/models/shared/scimuser.md)\>**
|
|
662
|
+
|
|
663
|
+
### Errors
|
|
664
|
+
|
|
665
|
+
| Error Type | Status Code | Content Type |
|
|
666
|
+
| --------------- | --------------- | --------------- |
|
|
667
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
668
|
+
|
|
669
|
+
## removeScimGroups
|
|
670
|
+
|
|
671
|
+
Delete group
|
|
672
|
+
|
|
673
|
+
### Example Usage
|
|
674
|
+
|
|
675
|
+
```typescript
|
|
676
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
677
|
+
|
|
678
|
+
const unifiedTo = new UnifiedTo({
|
|
679
|
+
security: {
|
|
680
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
681
|
+
},
|
|
682
|
+
});
|
|
683
|
+
|
|
684
|
+
async function run() {
|
|
685
|
+
const result = await unifiedTo.scim.removeScimGroups({
|
|
686
|
+
connectionId: "<id>",
|
|
687
|
+
id: "<id>",
|
|
688
|
+
});
|
|
689
|
+
|
|
690
|
+
// Handle the result
|
|
691
|
+
console.log(result);
|
|
692
|
+
}
|
|
693
|
+
|
|
694
|
+
run();
|
|
695
|
+
```
|
|
696
|
+
|
|
697
|
+
### Standalone function
|
|
698
|
+
|
|
699
|
+
The standalone function version of this method:
|
|
700
|
+
|
|
701
|
+
```typescript
|
|
702
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
703
|
+
import { scimRemoveScimGroups } from "@unified-api/typescript-sdk/funcs/scimRemoveScimGroups.js";
|
|
704
|
+
|
|
705
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
706
|
+
// You can create one instance of it to use across an application.
|
|
707
|
+
const unifiedTo = new UnifiedToCore({
|
|
708
|
+
security: {
|
|
709
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
710
|
+
},
|
|
711
|
+
});
|
|
712
|
+
|
|
713
|
+
async function run() {
|
|
714
|
+
const res = await scimRemoveScimGroups(unifiedTo, {
|
|
715
|
+
connectionId: "<id>",
|
|
716
|
+
id: "<id>",
|
|
717
|
+
});
|
|
718
|
+
|
|
719
|
+
if (!res.ok) {
|
|
720
|
+
throw res.error;
|
|
721
|
+
}
|
|
722
|
+
|
|
723
|
+
const { value: result } = res;
|
|
724
|
+
|
|
725
|
+
// Handle the result
|
|
726
|
+
console.log(result);
|
|
727
|
+
}
|
|
728
|
+
|
|
729
|
+
run();
|
|
730
|
+
```
|
|
731
|
+
|
|
732
|
+
### Parameters
|
|
733
|
+
|
|
734
|
+
| Parameter | Type | Required | Description |
|
|
735
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
736
|
+
| `request` | [operations.RemoveScimGroupsRequest](../../sdk/models/operations/removescimgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
737
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
738
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
739
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
740
|
+
|
|
741
|
+
### Response
|
|
742
|
+
|
|
743
|
+
**Promise\<[operations.RemoveScimGroupsResponse](../../sdk/models/operations/removescimgroupsresponse.md)\>**
|
|
744
|
+
|
|
745
|
+
### Errors
|
|
746
|
+
|
|
747
|
+
| Error Type | Status Code | Content Type |
|
|
748
|
+
| --------------- | --------------- | --------------- |
|
|
749
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
750
|
+
|
|
751
|
+
## removeScimUsers
|
|
752
|
+
|
|
753
|
+
Delete user
|
|
754
|
+
|
|
755
|
+
### Example Usage
|
|
756
|
+
|
|
757
|
+
```typescript
|
|
758
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
759
|
+
|
|
760
|
+
const unifiedTo = new UnifiedTo({
|
|
761
|
+
security: {
|
|
762
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
763
|
+
},
|
|
764
|
+
});
|
|
765
|
+
|
|
766
|
+
async function run() {
|
|
767
|
+
const result = await unifiedTo.scim.removeScimUsers({
|
|
768
|
+
connectionId: "<id>",
|
|
769
|
+
id: "<id>",
|
|
770
|
+
});
|
|
771
|
+
|
|
772
|
+
// Handle the result
|
|
773
|
+
console.log(result);
|
|
774
|
+
}
|
|
775
|
+
|
|
776
|
+
run();
|
|
777
|
+
```
|
|
778
|
+
|
|
779
|
+
### Standalone function
|
|
780
|
+
|
|
781
|
+
The standalone function version of this method:
|
|
782
|
+
|
|
783
|
+
```typescript
|
|
784
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
785
|
+
import { scimRemoveScimUsers } from "@unified-api/typescript-sdk/funcs/scimRemoveScimUsers.js";
|
|
786
|
+
|
|
787
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
788
|
+
// You can create one instance of it to use across an application.
|
|
789
|
+
const unifiedTo = new UnifiedToCore({
|
|
790
|
+
security: {
|
|
791
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
792
|
+
},
|
|
793
|
+
});
|
|
794
|
+
|
|
795
|
+
async function run() {
|
|
796
|
+
const res = await scimRemoveScimUsers(unifiedTo, {
|
|
797
|
+
connectionId: "<id>",
|
|
798
|
+
id: "<id>",
|
|
799
|
+
});
|
|
800
|
+
|
|
801
|
+
if (!res.ok) {
|
|
802
|
+
throw res.error;
|
|
803
|
+
}
|
|
804
|
+
|
|
805
|
+
const { value: result } = res;
|
|
806
|
+
|
|
807
|
+
// Handle the result
|
|
808
|
+
console.log(result);
|
|
809
|
+
}
|
|
810
|
+
|
|
811
|
+
run();
|
|
812
|
+
```
|
|
813
|
+
|
|
814
|
+
### Parameters
|
|
815
|
+
|
|
816
|
+
| Parameter | Type | Required | Description |
|
|
817
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
818
|
+
| `request` | [operations.RemoveScimUsersRequest](../../sdk/models/operations/removescimusersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
819
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
820
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
821
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
822
|
+
|
|
823
|
+
### Response
|
|
824
|
+
|
|
825
|
+
**Promise\<[operations.RemoveScimUsersResponse](../../sdk/models/operations/removescimusersresponse.md)\>**
|
|
826
|
+
|
|
827
|
+
### Errors
|
|
828
|
+
|
|
829
|
+
| Error Type | Status Code | Content Type |
|
|
830
|
+
| --------------- | --------------- | --------------- |
|
|
831
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
832
|
+
|
|
833
|
+
## updateScimGroups
|
|
834
|
+
|
|
835
|
+
Update group
|
|
836
|
+
|
|
837
|
+
### Example Usage
|
|
838
|
+
|
|
839
|
+
```typescript
|
|
840
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
841
|
+
|
|
842
|
+
const unifiedTo = new UnifiedTo({
|
|
843
|
+
security: {
|
|
844
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
845
|
+
},
|
|
846
|
+
});
|
|
847
|
+
|
|
848
|
+
async function run() {
|
|
849
|
+
const result = await unifiedTo.scim.updateScimGroups({
|
|
850
|
+
connectionId: "<id>",
|
|
851
|
+
id: "<id>",
|
|
852
|
+
});
|
|
853
|
+
|
|
854
|
+
// Handle the result
|
|
855
|
+
console.log(result);
|
|
856
|
+
}
|
|
857
|
+
|
|
858
|
+
run();
|
|
859
|
+
```
|
|
860
|
+
|
|
861
|
+
### Standalone function
|
|
862
|
+
|
|
863
|
+
The standalone function version of this method:
|
|
864
|
+
|
|
865
|
+
```typescript
|
|
866
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
867
|
+
import { scimUpdateScimGroups } from "@unified-api/typescript-sdk/funcs/scimUpdateScimGroups.js";
|
|
868
|
+
|
|
869
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
870
|
+
// You can create one instance of it to use across an application.
|
|
871
|
+
const unifiedTo = new UnifiedToCore({
|
|
872
|
+
security: {
|
|
873
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
874
|
+
},
|
|
875
|
+
});
|
|
876
|
+
|
|
877
|
+
async function run() {
|
|
878
|
+
const res = await scimUpdateScimGroups(unifiedTo, {
|
|
879
|
+
connectionId: "<id>",
|
|
880
|
+
id: "<id>",
|
|
881
|
+
});
|
|
882
|
+
|
|
883
|
+
if (!res.ok) {
|
|
884
|
+
throw res.error;
|
|
885
|
+
}
|
|
886
|
+
|
|
887
|
+
const { value: result } = res;
|
|
888
|
+
|
|
889
|
+
// Handle the result
|
|
890
|
+
console.log(result);
|
|
891
|
+
}
|
|
892
|
+
|
|
893
|
+
run();
|
|
894
|
+
```
|
|
895
|
+
|
|
896
|
+
### Parameters
|
|
897
|
+
|
|
898
|
+
| Parameter | Type | Required | Description |
|
|
899
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
900
|
+
| `request` | [operations.UpdateScimGroupsRequest](../../sdk/models/operations/updatescimgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
901
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
902
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
903
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
904
|
+
|
|
905
|
+
### Response
|
|
906
|
+
|
|
907
|
+
**Promise\<[shared.ScimGroup](../../sdk/models/shared/scimgroup.md)\>**
|
|
908
|
+
|
|
909
|
+
### Errors
|
|
910
|
+
|
|
911
|
+
| Error Type | Status Code | Content Type |
|
|
912
|
+
| --------------- | --------------- | --------------- |
|
|
913
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
914
|
+
|
|
915
|
+
## updateScimUsers
|
|
916
|
+
|
|
917
|
+
Update user
|
|
918
|
+
|
|
919
|
+
### Example Usage
|
|
920
|
+
|
|
921
|
+
```typescript
|
|
922
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
923
|
+
|
|
924
|
+
const unifiedTo = new UnifiedTo({
|
|
925
|
+
security: {
|
|
926
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
927
|
+
},
|
|
928
|
+
});
|
|
929
|
+
|
|
930
|
+
async function run() {
|
|
931
|
+
const result = await unifiedTo.scim.updateScimUsers({
|
|
932
|
+
connectionId: "<id>",
|
|
933
|
+
id: "<id>",
|
|
934
|
+
});
|
|
935
|
+
|
|
936
|
+
// Handle the result
|
|
937
|
+
console.log(result);
|
|
938
|
+
}
|
|
939
|
+
|
|
940
|
+
run();
|
|
941
|
+
```
|
|
942
|
+
|
|
943
|
+
### Standalone function
|
|
944
|
+
|
|
945
|
+
The standalone function version of this method:
|
|
946
|
+
|
|
947
|
+
```typescript
|
|
948
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
949
|
+
import { scimUpdateScimUsers } from "@unified-api/typescript-sdk/funcs/scimUpdateScimUsers.js";
|
|
950
|
+
|
|
951
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
952
|
+
// You can create one instance of it to use across an application.
|
|
953
|
+
const unifiedTo = new UnifiedToCore({
|
|
954
|
+
security: {
|
|
955
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
956
|
+
},
|
|
957
|
+
});
|
|
958
|
+
|
|
959
|
+
async function run() {
|
|
960
|
+
const res = await scimUpdateScimUsers(unifiedTo, {
|
|
961
|
+
connectionId: "<id>",
|
|
962
|
+
id: "<id>",
|
|
963
|
+
});
|
|
964
|
+
|
|
965
|
+
if (!res.ok) {
|
|
966
|
+
throw res.error;
|
|
967
|
+
}
|
|
968
|
+
|
|
969
|
+
const { value: result } = res;
|
|
970
|
+
|
|
971
|
+
// Handle the result
|
|
972
|
+
console.log(result);
|
|
973
|
+
}
|
|
974
|
+
|
|
975
|
+
run();
|
|
976
|
+
```
|
|
977
|
+
|
|
978
|
+
### Parameters
|
|
979
|
+
|
|
980
|
+
| Parameter | Type | Required | Description |
|
|
981
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
982
|
+
| `request` | [operations.UpdateScimUsersRequest](../../sdk/models/operations/updatescimusersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
983
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
984
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
985
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
986
|
+
|
|
987
|
+
### Response
|
|
988
|
+
|
|
989
|
+
**Promise\<[shared.ScimUser](../../sdk/models/shared/scimuser.md)\>**
|
|
990
|
+
|
|
991
|
+
### Errors
|
|
992
|
+
|
|
993
|
+
| Error Type | Status Code | Content Type |
|
|
994
|
+
| --------------- | --------------- | --------------- |
|
|
995
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|