@boxyhq/saml-jackson 1.37.0 → 1.37.1

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 (31) 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/scim/DirectoryConfig.d.ts +265 -224
  11. package/dist/directory-sync/scim/DirectoryConfig.js +265 -224
  12. package/dist/directory-sync/scim/DirectoryConfig.js.map +1 -1
  13. package/dist/directory-sync/scim/Groups.d.ts +82 -87
  14. package/dist/directory-sync/scim/Groups.js +82 -87
  15. package/dist/directory-sync/scim/Groups.js.map +1 -1
  16. package/dist/directory-sync/scim/Users.d.ts +63 -49
  17. package/dist/directory-sync/scim/Users.js +63 -49
  18. package/dist/directory-sync/scim/Users.js.map +1 -1
  19. package/dist/directory-sync/scim/WebhookEventsLogger.d.ts +52 -61
  20. package/dist/directory-sync/scim/WebhookEventsLogger.js +52 -61
  21. package/dist/directory-sync/scim/WebhookEventsLogger.js.map +1 -1
  22. package/dist/ee/identity-federation/app.d.ts +292 -212
  23. package/dist/ee/identity-federation/app.js +292 -212
  24. package/dist/ee/identity-federation/app.js.map +1 -1
  25. package/dist/ee/identity-federation/idp-login.js +1 -1
  26. package/dist/ee/identity-federation/idp-login.js.map +1 -1
  27. package/dist/sso-traces/index.d.ts +67 -66
  28. package/dist/sso-traces/index.js +67 -66
  29. package/dist/sso-traces/index.js.map +1 -1
  30. package/dist/sso-traces/types.d.ts +1 -0
  31. package/package.json +7 -7
package/dist/directory-sync/scim/DirectoryConfig.d.ts CHANGED
@@ -11,55 +11,6 @@ interface FilterByParams extends PaginationParams {
11
11
  product?: string;
12
12
  provider?: DirectoryType;
13
13
  }
14
- /**
15
- * @swagger
16
- * definitions:
17
- * Directory:
18
- * type: object
19
- * properties:
20
- * id:
21
- * type: string
22
- * description: Directory ID
23
- * name:
24
- * type: string
25
- * description: name
26
- * tenant:
27
- * type: string
28
- * description: Tenant
29
- * product:
30
- * type: string
31
- * description: Product
32
- * type:
33
- * type: string
34
- * description: Directory provider
35
- * deactivated:
36
- * type: boolean
37
- * description: Status
38
- * log_webhook_events:
39
- * type: boolean
40
- * description: If true, webhook requests will be logged
41
- * scim:
42
- * type: object
43
- * properties:
44
- * path:
45
- * type: string
46
- * description: SCIM path
47
- * endpoint:
48
- * type: string
49
- * description: SCIM url
50
- * secret:
51
- * type: string
52
- * description: SCIM secret
53
- * webhook:
54
- * type: object
55
- * properties:
56
- * endpoint:
57
- * type: string
58
- * description: Webhook url
59
- * secret:
60
- * type: string
61
- * description: Webhook secret
62
- */
63
14
  export declare class DirectoryConfig {
64
15
  private _store;
65
16
  private opts;
@@ -71,92 +22,160 @@ export declare class DirectoryConfig {
71
22
  constructor({ db, opts, users, groups, logger, eventController }: DirectoryConfigParams);
72
23
  private store;
73
24
  /**
74
- * @swagger
75
- * parameters:
76
- * tenant:
77
- * name: tenant
78
- * description: Tenant
79
- * in: query
80
- * required: true
81
- * type: string
82
- * product:
83
- * name: product
84
- * description: Product
85
- * in: query
86
- * required: true
87
- * type: string
88
- * directoryId:
89
- * name: directoryId
90
- * description: Directory ID
91
- * in: query
92
- * required: false
93
- * type: string
94
- * pageOffset:
95
- * name: pageOffset
96
- * description: Starting point from which the set of records are retrieved
97
- * in: query
98
- * required: false
99
- * type: string
100
- * pageLimit:
101
- * name: pageLimit
102
- * description: Number of records to be fetched for the page
103
- * in: query
104
- * required: false
105
- * type: string
106
- * pageToken:
107
- * name: pageToken
108
- * description: Token used for DynamoDB pagination
109
- * in: query
110
- * required: false
111
- * type: string
112
- */
113
- /**
114
- * @swagger
115
- * /api/v1/dsync:
116
- * post:
117
- * summary: Create a directory connection
118
- * parameters:
119
- * - name: tenant
120
- * description: Tenant
121
- * in: formData
122
- * required: true
25
+ * @openapi
26
+ * components:
27
+ * schemas:
28
+ * Directory:
29
+ * type: object
30
+ * properties:
31
+ * id:
32
+ * type: string
33
+ * description: Directory ID
34
+ * name:
35
+ * type: string
36
+ * description: name
37
+ * tenant:
38
+ * type: string
39
+ * description: Tenant
40
+ * product:
41
+ * type: string
42
+ * description: Product
43
+ * type:
44
+ * type: string
45
+ * description: Directory provider
46
+ * deactivated:
47
+ * type: boolean
48
+ * description: Status
49
+ * log_webhook_events:
50
+ * type: boolean
51
+ * description: If true, webhook requests will be logged
52
+ * scim:
53
+ * type: object
54
+ * properties:
55
+ * path:
56
+ * type: string
57
+ * description: SCIM path
58
+ * endpoint:
59
+ * type: string
60
+ * description: SCIM url
61
+ * secret:
62
+ * type: string
63
+ * description: SCIM secret
64
+ * webhook:
65
+ * type: object
66
+ * properties:
67
+ * endpoint:
68
+ * type: string
69
+ * description: Webhook url
70
+ * secret:
71
+ * type: string
72
+ * description: Webhook secret
73
+ * parameters:
74
+ * tenant:
75
+ * name: tenant
76
+ * in: query
77
+ * description: Tenant (Optional if directoryId is provided)
78
+ * schema:
123
79
  * type: string
124
- * - name: product
125
- * description: Product
126
- * in: formData
127
- * required: true
80
+ * product:
81
+ * name: product
82
+ * in: query
83
+ * description: Product (Optional if directoryId is provided)
84
+ * schema:
128
85
  * type: string
129
- * - name: name
130
- * description: Name
131
- * in: formData
132
- * required: false
86
+ * directoryId:
87
+ * name: directoryId
88
+ * in: query
89
+ * description: Directory ID (Optional if tenant/product is provided)
90
+ * schema:
133
91
  * type: string
134
- * - name: webhook_url
135
- * description: Webhook URL
136
- * in: formData
137
- * required: false
92
+ * pageOffset:
93
+ * name: pageOffset
94
+ * in: query
95
+ * description: Starting point from which the set of records are retrieved
96
+ * schema:
138
97
  * type: string
139
- * - name: webhook_secret
140
- * description: Webhook secret
141
- * in: formData
142
- * required: false
98
+ * pageLimit:
99
+ * name: pageLimit
100
+ * in: query
101
+ * description: Number of records to be fetched for the page
102
+ * schema:
143
103
  * type: string
144
- * - name: type
145
- * description: Directory provider. (Supported values are azure-scim-v2, onelogin-scim-v2, okta-scim-v2, jumpcloud-scim-v2, generic-scim-v2, google)
146
- * in: formData
147
- * required: false
104
+ * pageToken:
105
+ * name: pageToken
106
+ * in: query
107
+ * description: Token used for DynamoDB pagination
108
+ * schema:
148
109
  * type: string
149
- * tags: [Directory Sync]
150
- * produces:
151
- * - application/json
152
- * consumes:
153
- * - application/x-www-form-urlencoded
154
- * - application/json
110
+ *
111
+ */
112
+ /**
113
+ * @openapi
114
+ * /api/v1/dsync:
115
+ * post:
116
+ * tags:
117
+ * - Directory Sync
118
+ * summary: Create a directory connection
119
+ * requestBody:
120
+ * content:
121
+ * application/x-www-form-urlencoded:
122
+ * schema:
123
+ * required:
124
+ * - product
125
+ * - tenant
126
+ * type: object
127
+ * properties:
128
+ * tenant:
129
+ * type: string
130
+ * description: Tenant
131
+ * product:
132
+ * type: string
133
+ * description: Product
134
+ * name:
135
+ * type: string
136
+ * description: Name
137
+ * webhook_url:
138
+ * type: string
139
+ * description: Webhook URL
140
+ * webhook_secret:
141
+ * type: string
142
+ * description: Webhook secret
143
+ * type:
144
+ * type: string
145
+ * description: Directory provider. (Supported values are azure-scim-v2, onelogin-scim-v2, okta-scim-v2, jumpcloud-scim-v2, generic-scim-v2, google)
146
+ * application/json:
147
+ * schema:
148
+ * required:
149
+ * - product
150
+ * - tenant
151
+ * type: object
152
+ * properties:
153
+ * tenant:
154
+ * type: string
155
+ * description: Tenant
156
+ * product:
157
+ * type: string
158
+ * description: Product
159
+ * name:
160
+ * type: string
161
+ * description: Name
162
+ * webhook_url:
163
+ * type: string
164
+ * description: Webhook URL
165
+ * webhook_secret:
166
+ * type: string
167
+ * description: Webhook secret
168
+ * type:
169
+ * type: string
170
+ * description: Directory provider. (Supported values are azure-scim-v2, onelogin-scim-v2, okta-scim-v2, jumpcloud-scim-v2, generic-scim-v2, google)
171
+ * required: true
155
172
  * responses:
156
- * 200:
157
- * description: Success
158
- * schema:
159
- * $ref: '#/definitions/Directory'
173
+ * 200:
174
+ * description: Success
175
+ * content:
176
+ * application/json:
177
+ * schema:
178
+ * $ref: "#/components/schemas/Directory"
160
179
  */
161
180
  create(params: {
162
181
  name?: string;
@@ -170,155 +189,177 @@ export declare class DirectoryConfig {
170
189
  google_refresh_token?: string;
171
190
  }): Promise<Response<Directory>>;
172
191
  /**
173
- * @swagger
192
+ * @openapi
174
193
  * /api/v1/dsync/{directoryId}:
175
194
  * get:
195
+ * tags:
196
+ * - Directory Sync
176
197
  * summary: Get a directory connection by id
177
198
  * parameters:
178
199
  * - name: directoryId
179
- * description: Directory ID
180
200
  * in: path
201
+ * description: Directory ID
181
202
  * required: true
182
- * type: string
183
- * tags:
184
- * - Directory Sync
185
- * produces:
186
- * - application/json
203
+ * schema:
204
+ * type: string
187
205
  * responses:
188
- * '200':
206
+ * 200:
189
207
  * description: Success
190
- * schema:
191
- * $ref: '#/definitions/Directory'
208
+ * content:
209
+ * application/json:
210
+ * schema:
211
+ * $ref: "#/components/schemas/Directory"
192
212
  */
193
213
  get(id: string): Promise<Response<Directory>>;
194
214
  /**
195
- * @swagger
215
+ * @openapi
196
216
  * /api/v1/dsync/{directoryId}:
197
217
  * patch:
218
+ * tags:
219
+ * - Directory Sync
198
220
  * summary: Update a directory connection
199
221
  * parameters:
200
222
  * - name: directoryId
201
- * description: Directory ID
202
223
  * in: path
224
+ * description: Directory ID
203
225
  * required: true
204
- * type: string
205
- * - name: name
206
- * description: Name
207
- * in: formData
208
- * required: false
209
- * type: string
210
- * - name: webhook_url
211
- * description: Webhook URL
212
- * in: formData
213
- * required: false
214
- * type: string
215
- * - name: webhook_secret
216
- * description: Webhook secret
217
- * in: formData
218
- * required: false
219
- * type: string
220
- * - name: log_webhook_events
221
- * description: If true, webhook requests will be logged
222
- * in: formData
223
- * required: false
224
- * type: string
225
- * - name: deactivated
226
- * description: If true, the directory connection will be deactivated
227
- * in: formData
228
- * required: false
229
- * type: string
230
- * - name: google_domain
231
- * description: Google domain
232
- * in: formData
233
- * required: false
234
- * type: string
235
- * - name: google_access_token
236
- * description: Google access token
237
- * in: formData
238
- * required: false
239
- * type: string
240
- * - name: google_refresh_token
241
- * description: Google refresh token
242
- * in: formData
243
- * required: false
244
- * type: string
245
- * tags: [Directory Sync]
246
- * produces:
247
- * - application/json
248
- * consumes:
249
- * - application/x-www-form-urlencoded
250
- * - application/json
226
+ * schema:
227
+ * type: string
228
+ * requestBody:
229
+ * content:
230
+ * application/x-www-form-urlencoded:
231
+ * schema:
232
+ * type: object
233
+ * properties:
234
+ * name:
235
+ * type: string
236
+ * description: Name
237
+ * webhook_url:
238
+ * type: string
239
+ * description: Webhook URL
240
+ * webhook_secret:
241
+ * type: string
242
+ * description: Webhook secret
243
+ * log_webhook_events:
244
+ * type: string
245
+ * description: If true, webhook requests will be logged
246
+ * deactivated:
247
+ * type: string
248
+ * description: If true, the directory connection will be deactivated
249
+ * google_domain:
250
+ * type: string
251
+ * description: Google domain
252
+ * google_access_token:
253
+ * type: string
254
+ * description: Google access token
255
+ * google_refresh_token:
256
+ * type: string
257
+ * description: Google refresh token
258
+ * application/json:
259
+ * schema:
260
+ * type: object
261
+ * properties:
262
+ * name:
263
+ * type: string
264
+ * description: Name
265
+ * webhook_url:
266
+ * type: string
267
+ * description: Webhook URL
268
+ * webhook_secret:
269
+ * type: string
270
+ * description: Webhook secret
271
+ * log_webhook_events:
272
+ * type: string
273
+ * description: If true, webhook requests will be logged
274
+ * deactivated:
275
+ * type: string
276
+ * description: If true, the directory connection will be deactivated
277
+ * google_domain:
278
+ * type: string
279
+ * description: Google domain
280
+ * google_access_token:
281
+ * type: string
282
+ * description: Google access token
283
+ * google_refresh_token:
284
+ * type: string
285
+ * description: Google refresh token
251
286
  * responses:
252
- * 200:
253
- * description: Success
254
- * schema:
255
- * $ref: '#/definitions/Directory'
287
+ * 200:
288
+ * description: Success
289
+ * content:
290
+ * application/json:
291
+ * schema:
292
+ * $ref: "#/components/schemas/Directory"
256
293
  */
257
294
  update(id: string, param: Omit<Partial<Directory>, 'id' | 'tenant' | 'prodct' | 'scim' | 'type'> & {
258
295
  webhook_url?: string;
259
296
  webhook_secret?: string;
260
297
  }): Promise<Response<Directory>>;
261
298
  /**
262
- * @swagger
299
+ * @openapi
263
300
  * /api/v1/dsync:
264
301
  * get:
302
+ * tags:
303
+ * - Directory Sync
265
304
  * summary: Get a directory connection by tenant and product
266
305
  * parameters:
267
- * - $ref: '#/parameters/tenant'
268
- * - $ref: '#/parameters/product'
269
- * tags: [Directory Sync]
270
- * produces:
271
- * - application/json
272
- * consumes:
273
- * - application/x-www-form-urlencoded
274
- * - application/json
306
+ * - name: tenant
307
+ * in: query
308
+ * description: Tenant (Optional if directoryId is provided)
309
+ * schema:
310
+ * type: string
311
+ * - name: product
312
+ * in: query
313
+ * description: Product (Optional if directoryId is provided)
314
+ * schema:
315
+ * type: string
275
316
  * responses:
276
- * 200:
277
- * description: Success
278
- * schema:
279
- * type: array
280
- * items:
281
- * $ref: '#/definitions/Directory'
317
+ * 200:
318
+ * description: Success
319
+ * content:
320
+ * application/json:
321
+ * schema:
322
+ * type: array
323
+ * items:
324
+ * $ref: "#/components/schemas/Directory"
282
325
  */
283
326
  getByTenantAndProduct(tenant: string, product: string): Promise<Response<Directory[]>>;
284
327
  getAll(params?: PaginationParams): Promise<Response<Directory[]> & {
285
328
  pageToken?: string;
286
329
  }>;
287
330
  /**
288
- * @swagger
331
+ * @openapi
289
332
  * /api/v1/dsync/{directoryId}:
290
333
  * delete:
334
+ * tags:
335
+ * - Directory Sync
291
336
  * summary: Delete a directory connection by id
292
337
  * parameters:
293
338
  * - name: directoryId
294
- * description: Directory ID
295
339
  * in: path
340
+ * description: Directory ID
296
341
  * required: true
297
- * type: string
298
- * tags:
299
- * - Directory Sync
300
- * produces:
301
- * - application/json
342
+ * schema:
343
+ * type: string
302
344
  * responses:
303
- * '200':
345
+ * 200:
304
346
  * description: Success
347
+ * content: {}
305
348
  */
306
349
  delete(id: string): Promise<Response<null>>;
307
350
  private transform;
308
351
  /**
309
- * @swagger
352
+ * @openapi
310
353
  * /api/v1/dsync/product:
311
354
  * get:
312
- * summary: Get directory connections by product
313
- * parameters:
314
- * - $ref: '#/parameters/product'
315
- * - $ref: '#/parameters/pageOffset'
316
- * - $ref: '#/parameters/pageLimit'
317
- * - $ref: '#/parameters/pageToken'
318
355
  * tags:
319
356
  * - Directory Sync
320
- * produces:
321
- * - application/json
357
+ * summary: Get directory connections by product
358
+ * parameters:
359
+ * - $ref: '#/components/parameters/product'
360
+ * - $ref: '#/components/parameters/pageOffset'
361
+ * - $ref: '#/components/parameters/pageLimit'
362
+ * - $ref: '#/components/parameters/pageToken'
322
363
  * responses:
323
364
  * '200':
324
365
  * description: Success
@@ -330,7 +371,7 @@ export declare class DirectoryConfig {
330
371
  * data:
331
372
  * type: array
332
373
  * items:
333
- * $ref: '#/definitions/Directory'
374
+ * $ref: '#/components/schemas/Directory'
334
375
  * pageToken:
335
376
  * type: string
336
377
  * description: token for pagination