@boxyhq/saml-jackson 1.37.0 → 1.38.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/dist/controller/api.d.ts +521 -474
  2. package/dist/controller/api.js +521 -474
  3. package/dist/controller/api.js.map +1 -1
  4. package/dist/controller/oauth.d.ts +88 -87
  5. package/dist/controller/oauth.js +146 -101
  6. package/dist/controller/oauth.js.map +1 -1
  7. package/dist/controller/setup-link.d.ts +343 -234
  8. package/dist/controller/setup-link.js +343 -234
  9. package/dist/controller/setup-link.js.map +1 -1
  10. package/dist/directory-sync/non-scim/google/api.js +1 -1
  11. package/dist/directory-sync/non-scim/google/api.js.map +1 -1
  12. package/dist/directory-sync/scim/DirectoryConfig.d.ts +259 -225
  13. package/dist/directory-sync/scim/DirectoryConfig.js +261 -227
  14. package/dist/directory-sync/scim/DirectoryConfig.js.map +1 -1
  15. package/dist/directory-sync/scim/Groups.d.ts +82 -87
  16. package/dist/directory-sync/scim/Groups.js +82 -87
  17. package/dist/directory-sync/scim/Groups.js.map +1 -1
  18. package/dist/directory-sync/scim/Users.d.ts +63 -49
  19. package/dist/directory-sync/scim/Users.js +63 -49
  20. package/dist/directory-sync/scim/Users.js.map +1 -1
  21. package/dist/directory-sync/scim/WebhookEventsLogger.d.ts +52 -61
  22. package/dist/directory-sync/scim/WebhookEventsLogger.js +52 -61
  23. package/dist/directory-sync/scim/WebhookEventsLogger.js.map +1 -1
  24. package/dist/directory-sync/types.d.ts +0 -1
  25. package/dist/ee/identity-federation/app.d.ts +292 -212
  26. package/dist/ee/identity-federation/app.js +292 -212
  27. package/dist/ee/identity-federation/app.js.map +1 -1
  28. package/dist/ee/identity-federation/idp-login.js +1 -1
  29. package/dist/ee/identity-federation/idp-login.js.map +1 -1
  30. package/dist/sso-traces/index.d.ts +67 -66
  31. package/dist/sso-traces/index.js +67 -66
  32. package/dist/sso-traces/index.js.map +1 -1
  33. package/dist/sso-traces/types.d.ts +1 -0
  34. package/package.json +10 -10
package/dist/controller/setup-link.d.ts CHANGED
@@ -11,28 +11,6 @@ export type RemoveSetupLinkParams = {
11
11
  tenant: string;
12
12
  product: string;
13
13
  };
14
- /**
15
- * @swagger
16
- * definitions:
17
- * SetupLink:
18
- * type: object
19
- * properties:
20
- * setupID:
21
- * type: string
22
- * description: Setup link ID
23
- * tenant:
24
- * type: string
25
- * description: Tenant
26
- * product:
27
- * type: string
28
- * description: Product
29
- * validTill:
30
- * type: string
31
- * description: Valid till timestamp
32
- * url:
33
- * type: string
34
- * description: Setup link URL
35
- */
36
14
  export declare class SetupLinkController {
37
15
  setupLinkStore: Storable;
38
16
  opts: JacksonOption;
@@ -41,266 +19,397 @@ export declare class SetupLinkController {
41
19
  opts: any;
42
20
  });
43
21
  /**
44
- * @swagger
45
- * definitions:
46
- * SetupLink:
47
- * type: object
48
- * example:
49
- * {
50
- * "data": {
51
- * "setupID": "0689f76f7b5aa22f00381a124cb4b153fc1a8c08",
52
- * "tenant": "acme",
53
- * "product": "my-app",
54
- * "service": "sso",
55
- * "validTill": 1689849146690,
56
- * "url": "http://localhost:5225/setup/0b96a483ebfe0af0b561dda35a96647074d944631ff9e070"
57
- * }
58
- * }
59
- * parameters:
60
- * tenantParamPost:
61
- * name: tenant
62
- * description: Tenant
63
- * in: formData
64
- * required: true
65
- * type: string
66
- * productParamPost:
67
- * name: product
68
- * description: Product
69
- * in: formData
70
- * required: true
71
- * type: string
72
- * defaultRedirectUrlParamPost:
73
- * name: defaultRedirectUrl
74
- * description: The redirect URL to use in the IdP login flow
75
- * in: formData
76
- * type: string
77
- * required: true
78
- * redirectUrlParamPost:
79
- * name: redirectUrl
80
- * description: JSON encoded array containing a list of allowed redirect URLs
81
- * in: formData
82
- * type: string
83
- * required: true
84
- * webhookUrlParamPost:
85
- * name: webhook_url
86
- * description: The URL to send the directory sync events to
87
- * in: formData
88
- * type: string
89
- * required: true
90
- * webhookSecretParamPost:
91
- * name: webhook_secret
92
- * description: The secret to sign the directory sync events
93
- * in: formData
94
- * type: string
95
- * required: true
96
- * nameParamPost:
97
- * name: name
98
- * description: Name of connection
99
- * in: formData
100
- * type: string
101
- * required: false
102
- * expiryDaysParamPost:
103
- * name: expiryDays
104
- * description: Days in number for the setup link to expire
105
- * default: 3
106
- * in: formData
107
- * type: number
108
- * required: false
109
- * regenerateParamPost:
110
- * name: regenerate
111
- * description: If passed as true, it will remove the existing setup link and create a new one.
112
- * in: formData
113
- * default: false
114
- * type: boolean
115
- * required: false
22
+ * @openapi
23
+ * components:
24
+ * schemas:
25
+ * SetupLink:
26
+ * type: object
27
+ * properties:
28
+ * setupID:
29
+ * type: string
30
+ * description: Setup link ID
31
+ * tenant:
32
+ * type: string
33
+ * description: Tenant
34
+ * product:
35
+ * type: string
36
+ * description: Product
37
+ * validTill:
38
+ * type: string
39
+ * description: Valid till timestamp
40
+ * url:
41
+ * type: string
42
+ * description: Setup link URL
43
+ * example:
44
+ * data:
45
+ * setupID: 0689f76f7b5aa22f00381a124cb4b153fc1a8c08
46
+ * tenant: acme
47
+ * product: my-app
48
+ * service: sso
49
+ * validTill: 1689849146690
50
+ * url: http://localhost:5225/setup/0b96a483ebfe0af0b561dda35a96647074d944631ff9e070
51
+ * parameters:
52
+ * setupLinkId:
53
+ * name: id
54
+ * in: query
55
+ * description: Setup link ID
56
+ * schema:
57
+ * type: string
58
+ * idParamGet:
59
+ * name: id
60
+ * in: query
61
+ * description: Setup Link ID
62
+ * schema:
63
+ * type: string
64
+ *
65
+ */
66
+ /**
67
+ * @openapi
116
68
  * /api/v1/sso/setuplinks:
117
69
  * post:
118
- * summary: Create a Setup Link
119
- * operationId: create-sso-setup-link
120
- * tags: [Setup Links | Single Sign On]
121
- * produces:
122
- * - application/json
123
- * consumes:
124
- * - application/x-www-form-urlencoded
125
- * - application/json
126
- * parameters:
127
- * - $ref: '#/parameters/nameParamPost'
128
- * - $ref: '#/parameters/tenantParamPost'
129
- * - $ref: '#/parameters/productParamPost'
130
- * - $ref: '#/parameters/defaultRedirectUrlParamPost'
131
- * - $ref: '#/parameters/redirectUrlParamPost'
132
- * - $ref: '#/parameters/expiryDaysParamPost'
133
- * - $ref: '#/parameters/regenerateParamPost'
134
- * responses:
135
- * 200:
136
- * description: Success
137
- * schema:
138
- * $ref: '#/definitions/SetupLink'
70
+ * tags:
71
+ * - Setup Links | Single Sign On
72
+ * summary: Create a Setup Link
73
+ * operationId: create-sso-setup-link
74
+ * requestBody:
75
+ * content:
76
+ * application/x-www-form-urlencoded:
77
+ * schema:
78
+ * required:
79
+ * - defaultRedirectUrl
80
+ * - product
81
+ * - redirectUrl
82
+ * - tenant
83
+ * type: object
84
+ * properties:
85
+ * name:
86
+ * type: string
87
+ * description: Name of connection
88
+ * tenant:
89
+ * type: string
90
+ * description: Tenant
91
+ * product:
92
+ * type: string
93
+ * description: Product
94
+ * defaultRedirectUrl:
95
+ * type: string
96
+ * description: The redirect URL to use in the IdP login flow
97
+ * redirectUrl:
98
+ * type: string
99
+ * description: JSON encoded array containing a list of allowed redirect URLs
100
+ * expiryDays:
101
+ * type: number
102
+ * description: Days in number for the setup link to expire
103
+ * default: 3
104
+ * regenerate:
105
+ * type: boolean
106
+ * description: If passed as true, it will remove the existing setup link and create a new one.
107
+ * default: false
108
+ * application/json:
109
+ * schema:
110
+ * required:
111
+ * - defaultRedirectUrl
112
+ * - product
113
+ * - redirectUrl
114
+ * - tenant
115
+ * type: object
116
+ * properties:
117
+ * name:
118
+ * type: string
119
+ * description: Name of connection
120
+ * tenant:
121
+ * type: string
122
+ * description: Tenant
123
+ * product:
124
+ * type: string
125
+ * description: Product
126
+ * defaultRedirectUrl:
127
+ * type: string
128
+ * description: The redirect URL to use in the IdP login flow
129
+ * redirectUrl:
130
+ * type: string
131
+ * description: JSON encoded array containing a list of allowed redirect URLs
132
+ * expiryDays:
133
+ * type: number
134
+ * description: Days in number for the setup link to expire
135
+ * default: 3
136
+ * regenerate:
137
+ * type: boolean
138
+ * description: If passed as true, it will remove the existing setup link and create a new one.
139
+ * default: false
140
+ * required: true
141
+ * responses:
142
+ * 200:
143
+ * description: Success
144
+ * content:
145
+ * application/json:
146
+ * schema:
147
+ * $ref: "#/components/schemas/SetupLink"
139
148
  * /api/v1/dsync/setuplinks:
140
149
  * post:
141
- * summary: Create a Setup Link
142
- * operationId: create-dsync-setup-link
143
- * tags: [Setup Links | Directory Sync]
144
- * produces:
145
- * - application/json
146
- * consumes:
147
- * - application/x-www-form-urlencoded
148
- * - application/json
149
- * parameters:
150
- * - $ref: '#/parameters/nameParamPost'
151
- * - $ref: '#/parameters/tenantParamPost'
152
- * - $ref: '#/parameters/productParamPost'
153
- * - $ref: '#/parameters/webhookUrlParamPost'
154
- * - $ref: '#/parameters/webhookSecretParamPost'
155
- * - $ref: '#/parameters/expiryDaysParamPost'
156
- * - $ref: '#/parameters/regenerateParamPost'
157
- * responses:
158
- * 200:
159
- * description: Success
160
- * schema:
161
- * $ref: '#/definitions/SetupLink'
150
+ * tags:
151
+ * - Setup Links | Directory Sync
152
+ * summary: Create a Setup Link
153
+ * operationId: create-dsync-setup-link
154
+ * requestBody:
155
+ * content:
156
+ * application/x-www-form-urlencoded:
157
+ * schema:
158
+ * required:
159
+ * - product
160
+ * - tenant
161
+ * - webhook_secret
162
+ * - webhook_url
163
+ * type: object
164
+ * properties:
165
+ * name:
166
+ * type: string
167
+ * description: Name of connection
168
+ * tenant:
169
+ * type: string
170
+ * description: Tenant
171
+ * product:
172
+ * type: string
173
+ * description: Product
174
+ * webhook_url:
175
+ * type: string
176
+ * description: The URL to send the directory sync events to
177
+ * webhook_secret:
178
+ * type: string
179
+ * description: The secret to sign the directory sync events
180
+ * expiryDays:
181
+ * type: number
182
+ * description: Days in number for the setup link to expire
183
+ * default: 3
184
+ * regenerate:
185
+ * type: boolean
186
+ * description: If passed as true, it will remove the existing setup link and create a new one.
187
+ * default: false
188
+ * application/json:
189
+ * schema:
190
+ * required:
191
+ * - product
192
+ * - tenant
193
+ * - webhook_secret
194
+ * - webhook_url
195
+ * type: object
196
+ * properties:
197
+ * name:
198
+ * type: string
199
+ * description: Name of connection
200
+ * tenant:
201
+ * type: string
202
+ * description: Tenant
203
+ * product:
204
+ * type: string
205
+ * description: Product
206
+ * webhook_url:
207
+ * type: string
208
+ * description: The URL to send the directory sync events to
209
+ * webhook_secret:
210
+ * type: string
211
+ * description: The secret to sign the directory sync events
212
+ * expiryDays:
213
+ * type: number
214
+ * description: Days in number for the setup link to expire
215
+ * default: 3
216
+ * regenerate:
217
+ * type: boolean
218
+ * description: If passed as true, it will remove the existing setup link and create a new one.
219
+ * default: false
220
+ * required: true
221
+ * responses:
222
+ * 200:
223
+ * description: Success
224
+ * content:
225
+ * application/json:
226
+ * schema:
227
+ * $ref: "#/components/schemas/SetupLink"
162
228
  */
163
229
  create(body: SetupLinkCreatePayload): Promise<SetupLink>;
164
230
  getByToken(token: string): Promise<SetupLink>;
165
231
  /**
166
- * @swagger
167
- * parameters:
168
- * setupLinkId:
169
- * name: id
170
- * description: Setup link ID
171
- * in: query
172
- * required: false
173
- * type: string
232
+ * @openapi
174
233
  * /api/v1/sso/setuplinks:
175
234
  * delete:
235
+ * tags:
236
+ * - Setup Links | Single Sign On
176
237
  * summary: Delete the Setup Link
177
- * parameters:
178
- * - $ref: '#/parameters/tenantParamGet'
179
- * - $ref: '#/parameters/productParamGet'
180
- * - $ref: '#/parameters/setupLinkId'
181
238
  * operationId: delete-sso-setup-link
182
- * tags: [Setup Links | Single Sign On]
239
+ * parameters:
240
+ * - name: tenant
241
+ * in: query
242
+ * description: Tenant
243
+ * required: true
244
+ * schema:
245
+ * type: string
246
+ * - name: product
247
+ * in: query
248
+ * description: Product
249
+ * required: true
250
+ * schema:
251
+ * type: string
252
+ * - name: id
253
+ * in: query
254
+ * description: Setup link ID
255
+ * schema:
256
+ * type: string
183
257
  * responses:
184
- * 200:
185
- * description: Success
186
- * schema:
187
- * type: object
188
- * example:
189
- * {
190
- * data: {}
191
- * }
258
+ * 200:
259
+ * description: Success
260
+ * content:
261
+ * application/json:
262
+ * schema:
263
+ * type: object
264
+ * example:
265
+ * data: {}
192
266
  * /api/v1/dsync/setuplinks:
193
267
  * delete:
268
+ * tags:
269
+ * - Setup Links | Directory Sync
194
270
  * summary: Delete the Setup Link
195
- * parameters:
196
- * - $ref: '#/parameters/tenantParamGet'
197
- * - $ref: '#/parameters/productParamGet'
198
- * - $ref: '#/parameters/setupLinkId'
199
271
  * operationId: delete-dsync-setup-link
200
- * tags: [Setup Links | Directory Sync]
272
+ * parameters:
273
+ * - name: tenant
274
+ * in: query
275
+ * description: Tenant
276
+ * required: true
277
+ * schema:
278
+ * type: string
279
+ * - name: product
280
+ * in: query
281
+ * description: Product
282
+ * required: true
283
+ * schema:
284
+ * type: string
285
+ * - name: id
286
+ * in: query
287
+ * description: Setup link ID
288
+ * schema:
289
+ * type: string
201
290
  * responses:
202
- * 200:
203
- * description: Success
204
- * schema:
205
- * type: object
206
- * example:
207
- * {
208
- * data: {}
209
- * }
291
+ * 200:
292
+ * description: Success
293
+ * content:
294
+ * application/json:
295
+ * schema:
296
+ * type: object
297
+ * example:
298
+ * data: {}
210
299
  */
211
300
  remove(params: RemoveSetupLinkParams): Promise<void>;
212
301
  isExpired(setupLink: SetupLink): boolean;
213
302
  /**
214
- * @swagger
215
- * parameters:
216
- * tenantParamGet:
217
- * name: tenant
218
- * description: Tenant
219
- * in: query
220
- * required: true
221
- * type: string
222
- * productParamGet:
223
- * name: product
224
- * description: Product
225
- * in: query
226
- * required: true
227
- * type: string
303
+ * @openapi
228
304
  * /api/v1/sso/setuplinks/product:
229
305
  * get:
306
+ * tags:
307
+ * - Setup Links | Single Sign On
230
308
  * summary: Get the Setup Links by product
231
- * parameters:
232
- * - $ref: '#/parameters/productParamGet'
233
- * - $ref: '#/parameters/pageOffset'
234
- * - $ref: '#/parameters/pageLimit'
235
- * - $ref: '#/parameters/pageToken'
236
309
  * operationId: get-sso-setup-link-by-product
237
- * tags: [Setup Links | Single Sign On]
310
+ * parameters:
311
+ * - $ref: '#/components/parameters/productParamGet'
312
+ * - $ref: '#/components/parameters/pageOffset'
313
+ * - $ref: '#/components/parameters/pageLimit'
314
+ * - $ref: '#/components/parameters/pageToken'
238
315
  * responses:
239
- * 200:
240
- * description: Success
241
- * schema:
242
- * type: array
243
- * items:
244
- * $ref: '#/definitions/SetupLink'
316
+ * 200:
317
+ * description: Success
318
+ * content:
319
+ * application/json:
320
+ * schema:
321
+ * type: array
322
+ * items:
323
+ * $ref: "#/components/schemas/SetupLink"
245
324
  * /api/v1/dsync/setuplinks/product:
246
325
  * get:
326
+ * tags:
327
+ * - Setup Links | Directory Sync
247
328
  * summary: Get the Setup Links by product
248
- * parameters:
249
- * - $ref: '#/parameters/productParamGet'
250
- * - $ref: '#/parameters/pageOffset'
251
- * - $ref: '#/parameters/pageLimit'
252
- * - $ref: '#/parameters/pageToken'
253
329
  * operationId: get-dsync-setup-link-by-product
254
- * tags: [Setup Links | Directory Sync]
330
+ * parameters:
331
+ * - $ref: '#/components/parameters/productParamGet'
332
+ * - $ref: '#/components/parameters/pageOffset'
333
+ * - $ref: '#/components/parameters/pageLimit'
334
+ * - $ref: '#/components/parameters/pageToken'
255
335
  * responses:
256
- * 200:
257
- * description: Success
258
- * schema:
259
- * type: array
260
- * items:
261
- * $ref: '#/definitions/SetupLink'
336
+ * 200:
337
+ * description: Success
338
+ * content:
339
+ * application/json:
340
+ * schema:
341
+ * type: array
342
+ * items:
343
+ * $ref: "#/components/schemas/SetupLink"
262
344
  */
263
345
  filterBy(params: FilterByParams): Promise<{
264
346
  data: SetupLink[];
265
347
  pageToken?: string;
266
348
  }>;
267
349
  /**
268
- * @swagger
269
- * parameters:
270
- * idParamGet:
271
- * name: id
272
- * description: Setup Link ID
273
- * in: query
274
- * required: false
275
- * type: string
350
+ * @openapi
276
351
  * /api/v1/sso/setuplinks:
277
352
  * get:
353
+ * tags:
354
+ * - Setup Links | Single Sign On
278
355
  * summary: Get the Setup Link
279
- * parameters:
280
- * - $ref: '#/parameters/tenantParamGet'
281
- * - $ref: '#/parameters/productParamGet'
282
- * - $ref: '#/parameters/idParamGet'
283
356
  * operationId: get-sso-setup-link
284
- * tags: [Setup Links | Single Sign On]
357
+ * parameters:
358
+ * - name: tenant
359
+ * in: query
360
+ * description: Tenant
361
+ * required: true
362
+ * schema:
363
+ * type: string
364
+ * - name: product
365
+ * in: query
366
+ * description: Product
367
+ * required: true
368
+ * schema:
369
+ * type: string
370
+ * - name: id
371
+ * in: query
372
+ * description: Setup Link ID
373
+ * schema:
374
+ * type: string
285
375
  * responses:
286
- * 200:
287
- * description: Success
288
- * schema:
289
- * $ref: '#/definitions/SetupLink'
376
+ * 200:
377
+ * description: Success
378
+ * content:
379
+ * application/json:
380
+ * schema:
381
+ * $ref: "#/components/schemas/SetupLink"
290
382
  * /api/v1/dsync/setuplinks:
291
383
  * get:
384
+ * tags:
385
+ * - Setup Links | Directory Sync
292
386
  * summary: Get the Setup Link
293
- * parameters:
294
- * - $ref: '#/parameters/tenantParamGet'
295
- * - $ref: '#/parameters/productParamGet'
296
- * - $ref: '#/parameters/idParamGet'
297
387
  * operationId: get-dsync-setup-link
298
- * tags: [Setup Links | Directory Sync]
388
+ * parameters:
389
+ * - name: tenant
390
+ * in: query
391
+ * description: Tenant
392
+ * required: true
393
+ * schema:
394
+ * type: string
395
+ * - name: product
396
+ * in: query
397
+ * description: Product
398
+ * required: true
399
+ * schema:
400
+ * type: string
401
+ * - name: id
402
+ * in: query
403
+ * description: Setup Link ID
404
+ * schema:
405
+ * type: string
299
406
  * responses:
300
- * 200:
301
- * description: Success
302
- * schema:
303
- * $ref: '#/definitions/SetupLink'
407
+ * 200:
408
+ * description: Success
409
+ * content:
410
+ * application/json:
411
+ * schema:
412
+ * $ref: "#/components/schemas/SetupLink"
304
413
  */
305
414
  get(id: string): Promise<SetupLink>;
306
415
  }