@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/ee/identity-federation/app.d.ts CHANGED
@@ -7,175 +7,225 @@ type NewAppParams = Pick<IdentityFederationApp, 'name' | 'tenant' | 'product' |
7
7
  export declare class App {
8
8
  protected store: Storable;
9
9
  private opts;
10
- /**
11
- * @swagger
12
- * definitions:
13
- * IdentityFederationApp:
14
- * type: object
15
- * properties:
16
- * id:
17
- * type: string
18
- * description: id
19
- * name:
20
- * type: string
21
- * description: name
22
- * tenant:
23
- * type: string
24
- * description: Tenant
25
- * product:
26
- * type: string
27
- * description: Product
28
- * acsUrl:
29
- * type: string
30
- * description: ACS URL
31
- * entityId:
32
- * type: string
33
- * description: Entity ID
34
- * logoUrl:
35
- * type: string
36
- * description: Logo URL (optional)
37
- * faviconUrl:
38
- * type: string
39
- * description: Favicon URL (optional)
40
- * primaryColor:
41
- * type: string
42
- * description: Primary color (optional)
43
- */
44
10
  constructor({ store, opts }: {
45
11
  store: Storable;
46
12
  opts: JacksonOption;
47
13
  });
48
14
  /**
49
- * @swagger
15
+ * @openapi
16
+ * components:
17
+ * schemas:
18
+ * IdentityFederationApp:
19
+ * type: object
20
+ * properties:
21
+ * id:
22
+ * type: string
23
+ * description: id
24
+ * name:
25
+ * type: string
26
+ * description: name
27
+ * tenant:
28
+ * type: string
29
+ * description: Tenant
30
+ * product:
31
+ * type: string
32
+ * description: Product
33
+ * acsUrl:
34
+ * type: string
35
+ * description: ACS URL
36
+ * entityId:
37
+ * type: string
38
+ * description: Entity ID
39
+ * logoUrl:
40
+ * type: string
41
+ * description: Logo URL (optional)
42
+ * faviconUrl:
43
+ * type: string
44
+ * description: Favicon URL (optional)
45
+ * primaryColor:
46
+ * type: string
47
+ * description: Primary color (optional)
48
+ *
49
+ */
50
+ /**
51
+ * @openapi
50
52
  * /api/v1/identity-federation:
51
53
  * post:
54
+ * tags:
55
+ * - Identity Federation
52
56
  * summary: Create an Identity Federation app
53
- * parameters:
54
- * - name: name
55
- * description: Name
56
- * in: formData
57
- * required: true
58
- * type: string
59
- * - name: tenant
60
- * description: Tenant
61
- * in: formData
62
- * required: true
63
- * type: string
64
- * - name: product
65
- * description: Product
66
- * in: formData
67
- * required: true
68
- * type: string
69
- * - name: acsUrl
70
- * description: ACS URL
71
- * in: formData
72
- * required: true
73
- * type: string
74
- * - name: entityId
75
- * description: Entity ID
76
- * in: formData
77
- * required: true
78
- * type: string
79
- * - name: logoUrl
80
- * description: Logo URL
81
- * in: formData
82
- * required: false
83
- * type: string
84
- * - name: faviconUrl
85
- * description: Favicon URL
86
- * in: formData
87
- * required: false
88
- * type: string
89
- * - name: primaryColor
90
- * description: Primary color
91
- * in: formData
92
- * required: false
93
- * type: string
94
- * - name: tenants
95
- * description: Mapping of tenants whose connections will be grouped under this Identity Federation app
96
- * in: formData
97
- * required: false
98
- * type: array
99
- * - name: mappings
100
- * description: Mapping of attributes from the IdP to SP
101
- * in: formData
102
- * required: false
103
- * type: array
104
- * - name: type
105
- * description: If creating an OIDC app, this should be set to 'oidc' otherwise it defaults to 'saml'
106
- * in: formData
107
- * required: false
108
- * type: array
109
- * - name: redirectUrl
110
- * description: If creating an OIDC app, provide the redirect URL
111
- * in: formData
112
- * required: false
113
- * type: array
114
- * tags: [Identity Federation]
115
- * produces:
116
- * - application/json
117
- * consumes:
118
- * - application/x-www-form-urlencoded
119
- * - application/json
57
+ * requestBody:
58
+ * content:
59
+ * application/x-www-form-urlencoded:
60
+ * schema:
61
+ * required:
62
+ * - acsUrl
63
+ * - entityId
64
+ * - name
65
+ * - product
66
+ * - tenant
67
+ * type: object
68
+ * properties:
69
+ * name:
70
+ * type: string
71
+ * description: Name
72
+ * tenant:
73
+ * type: string
74
+ * description: Tenant
75
+ * product:
76
+ * type: string
77
+ * description: Product
78
+ * acsUrl:
79
+ * type: string
80
+ * description: ACS URL
81
+ * entityId:
82
+ * type: string
83
+ * description: Entity ID
84
+ * logoUrl:
85
+ * type: string
86
+ * description: Logo URL
87
+ * faviconUrl:
88
+ * type: string
89
+ * description: Favicon URL
90
+ * primaryColor:
91
+ * type: string
92
+ * description: Primary color
93
+ * tenants:
94
+ * type: array
95
+ * items:
96
+ * type: string
97
+ * description: Mapping of tenants whose connections will be grouped under this Identity Federation app
98
+ * mappings:
99
+ * type: array
100
+ * items:
101
+ * type: string
102
+ * description: Mapping of attributes from the IdP to SP
103
+ * type:
104
+ * type: array
105
+ * items:
106
+ * type: string
107
+ * description: If creating an OIDC app, this should be set to 'oidc' otherwise it defaults to 'saml'
108
+ * redirectUrl:
109
+ * type: array
110
+ * items:
111
+ * type: string
112
+ * description: If creating an OIDC app, provide the redirect URL
113
+ * application/json:
114
+ * schema:
115
+ * required:
116
+ * - acsUrl
117
+ * - entityId
118
+ * - name
119
+ * - product
120
+ * - tenant
121
+ * type: object
122
+ * properties:
123
+ * name:
124
+ * type: string
125
+ * description: Name
126
+ * tenant:
127
+ * type: string
128
+ * description: Tenant
129
+ * product:
130
+ * type: string
131
+ * description: Product
132
+ * acsUrl:
133
+ * type: string
134
+ * description: ACS URL
135
+ * entityId:
136
+ * type: string
137
+ * description: Entity ID
138
+ * logoUrl:
139
+ * type: string
140
+ * description: Logo URL
141
+ * faviconUrl:
142
+ * type: string
143
+ * description: Favicon URL
144
+ * primaryColor:
145
+ * type: string
146
+ * description: Primary color
147
+ * tenants:
148
+ * type: array
149
+ * items:
150
+ * type: string
151
+ * description: Mapping of tenants whose connections will be grouped under this Identity Federation app
152
+ * mappings:
153
+ * type: array
154
+ * items:
155
+ * type: string
156
+ * description: Mapping of attributes from the IdP to SP
157
+ * type:
158
+ * type: array
159
+ * items:
160
+ * type: string
161
+ * description: If creating an OIDC app, this should be set to 'oidc' otherwise it defaults to 'saml'
162
+ * redirectUrl:
163
+ * type: array
164
+ * items:
165
+ * type: string
166
+ * description: If creating an OIDC app, provide the redirect URL
167
+ * required: true
120
168
  * responses:
121
- * 200:
122
- * description: Success
123
- * schema:
124
- * type: array
125
- * items:
126
- * $ref: '#/definitions/IdentityFederationApp'
169
+ * 200:
170
+ * description: Success
171
+ * content:
172
+ * application/json:
173
+ * schema:
174
+ * type: array
175
+ * items:
176
+ * $ref: "#/components/schemas/IdentityFederationApp"
127
177
  */
128
178
  create({ name, type, redirectUrl, tenant, product, acsUrl, entityId, logoUrl, faviconUrl, primaryColor, tenants, mappings, }: NewAppParams): Promise<IdentityFederationApp>;
129
179
  /**
130
- * @swagger
180
+ * @openapi
131
181
  * /api/v1/identity-federation:
132
182
  * get:
183
+ * tags:
184
+ * - Identity Federation
133
185
  * summary: Get an Identity Federation app
134
186
  * parameters:
135
187
  * - name: id
136
- * description: App ID
137
188
  * in: query
189
+ * description: App ID
138
190
  * required: true
139
- * type: string
191
+ * schema:
192
+ * type: string
140
193
  * - name: tenant
141
- * description: Tenant
142
194
  * in: query
143
- * required: false
144
- * type: string
195
+ * description: Tenant
196
+ * schema:
197
+ * type: string
145
198
  * - name: product
146
- * description: Product
147
199
  * in: query
148
- * required: false
149
- * type: string
150
- * tags:
151
- * - Identity Federation
152
- * produces:
153
- * - application/json
200
+ * description: Product
201
+ * schema:
202
+ * type: string
154
203
  * responses:
155
- * '200':
204
+ * 200:
156
205
  * description: Success
157
- * schema:
158
- * $ref: '#/definitions/IdentityFederationApp'
206
+ * content:
207
+ * application/json:
208
+ * schema:
209
+ * $ref: "#/components/schemas/IdentityFederationApp"
159
210
  */
160
211
  get(params: AppRequestParams): Promise<IdentityFederationApp>;
161
212
  /**
162
- * @swagger
213
+ * @openapi
163
214
  * /api/v1/identity-federation/product:
164
215
  * get:
216
+ * tags:
217
+ * - Identity Federation
165
218
  * summary: Get Identity Federation apps by product
166
219
  * parameters:
167
220
  * - name: product
168
- * description: Product
169
221
  * in: query
222
+ * description: Product
170
223
  * required: true
171
- * type: string
172
- * - $ref: '#/parameters/pageOffset'
173
- * - $ref: '#/parameters/pageLimit'
174
- * - $ref: '#/parameters/pageToken'
175
- * tags:
176
- * - Identity Federation
177
- * produces:
178
- * - application/json
224
+ * schema:
225
+ * type: string
226
+ * - $ref: '#/components/parameters/pageOffset'
227
+ * - $ref: '#/components/parameters/pageLimit'
228
+ * - $ref: '#/components/parameters/pageToken'
179
229
  * responses:
180
230
  * 200:
181
231
  * description: Success
@@ -187,7 +237,7 @@ export declare class App {
187
237
  * data:
188
238
  * type: array
189
239
  * items:
190
- * $ref: '#/definitions/IdentityFederationApp'
240
+ * $ref: '#/components/schemas/IdentityFederationApp'
191
241
  * pageToken:
192
242
  * type: string
193
243
  * description: token for pagination
@@ -195,73 +245,102 @@ export declare class App {
195
245
  getByProduct({ product, pageOffset, pageLimit, pageToken }: GetByProductParams): Promise<Records<any>>;
196
246
  getByEntityId(entityId: string): Promise<IdentityFederationApp>;
197
247
  /**
198
- * @swagger
248
+ * @openapi
199
249
  * /api/v1/identity-federation:
200
250
  * patch:
201
- * summary: Update an Identity Federation app
202
- * parameters:
203
- * - name: id
204
- * description: App ID
205
- * in: formData
206
- * required: true
207
- * type: string
208
- * - name: tenant
209
- * description: Tenant
210
- * in: formData
211
- * required: false
212
- * type: string
213
- * - name: product
214
- * description: Product
215
- * in: formData
216
- * required: false
217
- * type: string
218
- * - name: name
219
- * description: Name
220
- * in: formData
221
- * required: false
222
- * type: string
223
- * - name: acsUrl
224
- * description: ACS URL
225
- * in: formData
226
- * required: false
227
- * type: string
228
- * - name: logoUrl
229
- * description: Logo URL
230
- * in: formData
231
- * required: false
232
- * type: string
233
- * - name: faviconUrl
234
- * description: Favicon URL
235
- * in: formData
236
- * required: false
237
- * type: string
238
- * - name: primaryColor
239
- * description: Primary color
240
- * in: formData
241
- * required: false
242
- * type: string
243
- * - name: tenants
244
- * description: Mapping of tenants whose connections will be grouped under this Identity Federation app
245
- * in: formData
246
- * required: false
247
- * type: array
248
- * - name: mappings
249
- * description: Mapping of attributes from the IdP to SP
250
- * in: formData
251
- * required: false
252
- * type: array
253
251
  * tags:
254
252
  * - Identity Federation
255
- * produces:
256
- * - application/json
257
- * consumes:
258
- * - application/x-www-form-urlencoded
259
- * - application/json
253
+ * summary: Update an Identity Federation app
254
+ * requestBody:
255
+ * content:
256
+ * application/x-www-form-urlencoded:
257
+ * schema:
258
+ * required:
259
+ * - id
260
+ * type: object
261
+ * properties:
262
+ * id:
263
+ * type: string
264
+ * description: App ID
265
+ * tenant:
266
+ * type: string
267
+ * description: Tenant
268
+ * product:
269
+ * type: string
270
+ * description: Product
271
+ * name:
272
+ * type: string
273
+ * description: Name
274
+ * acsUrl:
275
+ * type: string
276
+ * description: ACS URL
277
+ * logoUrl:
278
+ * type: string
279
+ * description: Logo URL
280
+ * faviconUrl:
281
+ * type: string
282
+ * description: Favicon URL
283
+ * primaryColor:
284
+ * type: string
285
+ * description: Primary color
286
+ * tenants:
287
+ * type: array
288
+ * items:
289
+ * type: string
290
+ * description: Mapping of tenants whose connections will be grouped under this Identity Federation app
291
+ * mappings:
292
+ * type: array
293
+ * items:
294
+ * type: string
295
+ * description: Mapping of attributes from the IdP to SP
296
+ * application/json:
297
+ * schema:
298
+ * required:
299
+ * - id
300
+ * type: object
301
+ * properties:
302
+ * id:
303
+ * type: string
304
+ * description: App ID
305
+ * tenant:
306
+ * type: string
307
+ * description: Tenant
308
+ * product:
309
+ * type: string
310
+ * description: Product
311
+ * name:
312
+ * type: string
313
+ * description: Name
314
+ * acsUrl:
315
+ * type: string
316
+ * description: ACS URL
317
+ * logoUrl:
318
+ * type: string
319
+ * description: Logo URL
320
+ * faviconUrl:
321
+ * type: string
322
+ * description: Favicon URL
323
+ * primaryColor:
324
+ * type: string
325
+ * description: Primary color
326
+ * tenants:
327
+ * type: array
328
+ * items:
329
+ * type: string
330
+ * description: Mapping of tenants whose connections will be grouped under this Identity Federation app
331
+ * mappings:
332
+ * type: array
333
+ * items:
334
+ * type: string
335
+ * description: Mapping of attributes from the IdP to SP
336
+ * required: true
260
337
  * responses:
261
- * '200':
338
+ * 200:
262
339
  * description: Success
263
- * schema:
264
- * $ref: '#/definitions/IdentityFederationApp'
340
+ * content:
341
+ * application/json:
342
+ * schema:
343
+ * $ref: "#/components/schemas/IdentityFederationApp"
265
344
  */
266
345
  update(params: Partial<IdentityFederationApp>): Promise<{
267
346
  id: string;
@@ -286,35 +365,36 @@ export declare class App {
286
365
  pageToken?: string;
287
366
  }): Promise<Records<IdentityFederationApp>>;
288
367
  /**
289
- * @swagger
368
+ * @openapi
290
369
  * /api/v1/identity-federation:
291
370
  * delete:
371
+ * tags:
372
+ * - Identity Federation
292
373
  * summary: Delete an Identity Federation app
293
374
  * parameters:
294
375
  * - name: id
295
- * description: App ID
296
376
  * in: query
377
+ * description: App ID
297
378
  * required: true
298
- * type: string
379
+ * schema:
380
+ * type: string
299
381
  * - name: tenant
300
- * description: Tenant
301
382
  * in: query
302
- * required: false
303
- * type: string
383
+ * description: Tenant
384
+ * schema:
385
+ * type: string
304
386
  * - name: product
305
- * description: Product
306
387
  * in: query
307
- * required: false
308
- * type: string
309
- * tags:
310
- * - Identity Federation
311
- * produces:
312
- * - application/json
388
+ * description: Product
389
+ * schema:
390
+ * type: string
313
391
  * responses:
314
- * '200':
392
+ * 200:
315
393
  * description: Success
316
- * schema:
317
- * $ref: '#/definitions/IdentityFederationApp'
394
+ * content:
395
+ * application/json:
396
+ * schema:
397
+ * $ref: "#/components/schemas/IdentityFederationApp"
318
398
  */
319
399
  delete(params: AppRequestParams): Promise<void>;
320
400
  getMetadata(): Promise<{