@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/controller/api.js CHANGED
@@ -60,157 +60,311 @@ class ConnectionAPIController {
60
60
  this.oryController = oryController;
61
61
  }
62
62
  /**
63
- * @swagger
64
- * definitions:
65
- * Connection:
66
- * type: object
67
- * example:
68
- * {
69
- * "idpMetadata": {
70
- * "sso": {
71
- * "postUrl": "https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxsso/saml",
72
- * "redirectUrl": "https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxsso/saml"
73
- * },
74
- * "entityID": "http://www.okta.com/xxxxxxxxxxxxx",
75
- * "thumbprint": "Eo+eUi3UM3XIMkFFtdVK3yJ5vO9f7YZdasdasdad",
76
- * "loginType": "idp",
77
- * "provider": "okta.com"
78
- * },
79
- * "defaultRedirectUrl": "https://hoppscotch.io/",
80
- * "redirectUrl": ["https://hoppscotch.io/"],
81
- * "tenant": "hoppscotch.io",
82
- * "product": "API Engine",
83
- * "name": "Hoppscotch-SP",
84
- * "description": "SP for hoppscotch.io",
85
- * "clientID": "Xq8AJt3yYAxmXizsCWmUBDRiVP1iTC8Y/otnvFIMitk",
86
- * "clientSecret": "00e3e11a3426f97d8000000738300009130cd45419c5943",
87
- * "deactivated": false
88
- * }
89
- * validationErrorsPost:
90
- * description: Please provide rawMetadata or encodedRawMetadata | Please provide a defaultRedirectUrl | Please provide redirectUrl | redirectUrl is invalid | Exceeded maximum number of allowed redirect urls | defaultRedirectUrl is invalid | Please provide tenant | Please provide product | Please provide a friendly name | Description should not exceed 100 characters | Strategy: xxxx not supported | Please provide the clientId from OpenID Provider | Please provide the clientSecret from OpenID Provider | Please provide the discoveryUrl for the OpenID Provider
63
+ * @openapi
64
+ * components:
65
+ * schemas:
66
+ * Connection:
67
+ * type: object
68
+ * properties:
69
+ * clientID:
70
+ * type: string
71
+ * description: Connection clientID
72
+ * clientSecret:
73
+ * type: string
74
+ * description: Connection clientSecret
75
+ * name:
76
+ * type: string
77
+ * description: Connection name
78
+ * label:
79
+ * type: string
80
+ * description: Connection label
81
+ * description:
82
+ * type: string
83
+ * description: Connection description
84
+ * redirectUrl:
85
+ * type: array
86
+ * items:
87
+ * type: string
88
+ * description: A list of allowed redirect URLs
89
+ * defaultRedirectUrl:
90
+ * type: string
91
+ * description: The redirect URL to use in the IdP login flow
92
+ * tenant:
93
+ * type: string
94
+ * description: Connection tenant
95
+ * product:
96
+ * type: string
97
+ * description: Connection product
98
+ * idpMetadata:
99
+ * type: object
100
+ * properties: {}
101
+ * description: SAML IdP metadata
102
+ * oidcProvider:
103
+ * type: object
104
+ * properties: {}
105
+ * description: OIDC IdP metadata
106
+ * deactivated:
107
+ * type: boolean
108
+ * description: Connection status
109
+ * sortOrder:
110
+ * type: number
111
+ * description: Connection sort order
112
+ * example:
113
+ * idpMetadata:
114
+ * sso:
115
+ * postUrl: https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxsso/saml
116
+ * redirectUrl: https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxsso/saml
117
+ * entityID: http://www.okta.com/xxxxxxxxxxxxx
118
+ * thumbprint: Eo+eUi3UM3XIMkFFtdVK3yJ5vO9f7YZdasdasdad
119
+ * loginType: idp
120
+ * provider: okta.com
121
+ * defaultRedirectUrl: https://hoppscotch.io/
122
+ * redirectUrl:
123
+ * - https://hoppscotch.io/
124
+ * tenant: hoppscotch.io
125
+ * product: API Engine
126
+ * name: Hoppscotch-SP
127
+ * description: SP for hoppscotch.io
128
+ * clientID: Xq8AJt3yYAxmXizsCWmUBDRiVP1iTC8Y/otnvFIMitk
129
+ * clientSecret: 00e3e11a3426f97d8000000738300009130cd45419c5943
130
+ * deactivated: false
131
+ * validationErrorsPost:
132
+ * description: Please provide rawMetadata or encodedRawMetadata | Please provide a defaultRedirectUrl | Please provide redirectUrl | redirectUrl is invalid | Exceeded maximum number of allowed redirect urls | defaultRedirectUrl is invalid | Please provide tenant | Please provide product | Please provide a friendly name | Description should not exceed 100 characters | Strategy: xxxx not supported | Please provide the clientId from OpenID Provider | Please provide the clientSecret from OpenID Provider | Please provide the discoveryUrl for the OpenID Provider
133
+ * validationErrorsPatch:
134
+ * description: Please provide clientID | Please provide clientSecret | clientSecret mismatch | Tenant/Product config mismatch with IdP metadata | Description should not exceed 100 characters| redirectUrl is invalid | Exceeded maximum number of allowed redirect urls | defaultRedirectUrl is invalid | Tenant/Product config mismatch with OIDC Provider metadata
135
+ * responses:
136
+ * 200Get:
137
+ * description: Success
138
+ * content:
139
+ * application/json:
140
+ * schema:
141
+ * type: array
142
+ * items:
143
+ * $ref: "#/components/schemas/Connection"
144
+ * 400Get:
145
+ * description: Please provide a `product`.
146
+ * content: {}
147
+ * 401Get:
148
+ * description: Unauthorized
149
+ * content: {}
150
+ * 200GetByProduct:
151
+ * description: Success
152
+ * content:
153
+ * application/json:
154
+ * schema:
155
+ * type: array
156
+ * items:
157
+ * $ref: "#/components/schemas/Connection"
158
+ * parameters:
159
+ * tenantParamGet:
160
+ * name: tenant
161
+ * in: query
162
+ * description: Tenant
163
+ * required: true
164
+ * schema:
165
+ * type: string
166
+ * productParamGet:
167
+ * name: product
168
+ * in: query
169
+ * description: Product
170
+ * required: true
171
+ * schema:
172
+ * type: string
173
+ * clientIDParamGet:
174
+ * name: clientID
175
+ * in: query
176
+ * description: Client ID (Optional if tenant/product provided)
177
+ * schema:
178
+ * type: string
179
+ * strategyParamGet:
180
+ * name: strategy
181
+ * in: query
182
+ * description: Strategy which can help to filter connections with tenant/product query
183
+ * schema:
184
+ * type: string
185
+ * sortParamGet:
186
+ * name: sort
187
+ * in: query
188
+ * description: If present, the connections will be sorted by `sortOrder`. It won't consider if pagination is used.
189
+ * schema:
190
+ * type: string
191
+ * clientIDDel:
192
+ * name: clientID
193
+ * in: query
194
+ * description: Client ID (Optional if tenant/product provided)
195
+ * schema:
196
+ * type: string
197
+ * clientSecretDel:
198
+ * name: clientSecret
199
+ * in: query
200
+ * description: Client Secret (Optional if tenant/product provided)
201
+ * schema:
202
+ * type: string
203
+ * tenantDel:
204
+ * name: tenant
205
+ * in: query
206
+ * description: Tenant (Optional if clientID/Secret provided)
207
+ * schema:
208
+ * type: string
209
+ * productDel:
210
+ * name: product
211
+ * in: query
212
+ * description: Product (Optional if clientID/Secret provided)
213
+ * schema:
214
+ * type: string
215
+ * strategyDel:
216
+ * name: strategy
217
+ * in: query
218
+ * description: Strategy which can help to filter connections with tenant/product query
219
+ * schema:
220
+ * type: string
221
+ * securitySchemes:
222
+ * apiKey:
223
+ * type: apiKey
224
+ * name: Authorization
225
+ * in: header
91
226
  *
92
- * parameters:
93
- * nameParamPost:
94
- * name: name
95
- * description: Name/identifier for the connection
96
- * type: string
97
- * in: formData
98
- * labelParamPost:
99
- * name: label
100
- * description: An internal label to identify the connection
101
- * type: string
102
- * in: formData
103
- * descriptionParamPost:
104
- * name: description
105
- * description: A short description for the connection not more than 100 characters
106
- * type: string
107
- * in: formData
108
- * encodedRawMetadataParamPost:
109
- * name: encodedRawMetadata
110
- * description: Base64 encoding of the XML metadata
111
- * in: formData
112
- * type: string
113
- * rawMetadataParamPost:
114
- * name: rawMetadata
115
- * description: Raw XML metadata
116
- * in: formData
117
- * type: string
118
- * metadataUrlParamPost:
119
- * name: metadataUrl
120
- * description: URL containing raw XML metadata
121
- * in: formData
122
- * type: string
123
- * defaultRedirectUrlParamPost:
124
- * name: defaultRedirectUrl
125
- * description: The redirect URL to use in the IdP login flow
126
- * in: formData
127
- * required: true
128
- * type: string
129
- * redirectUrlParamPost:
130
- * name: redirectUrl
131
- * description: JSON encoded array containing a list of allowed redirect URLs
132
- * in: formData
133
- * required: true
134
- * type: string
135
- * tenantParamPost:
136
- * name: tenant
137
- * description: Tenant
138
- * in: formData
139
- * required: true
140
- * type: string
141
- * productParamPost:
142
- * name: product
143
- * description: Product
144
- * in: formData
145
- * required: true
146
- * type: string
147
- * oidcDiscoveryUrlPost:
148
- * name: oidcDiscoveryUrl
149
- * description: well-known URL where the OpenID Provider configuration is exposed
150
- * in: formData
151
- * type: string
152
- * oidcMetadataPost:
153
- * name: oidcMetadata
154
- * description: metadata (JSON) for the OpenID Provider in the absence of discoveryUrl
155
- * in: formData
156
- * type: string
157
- * oidcClientIdPost:
158
- * name: oidcClientId
159
- * description: clientId of the application set up on the OpenID Provider
160
- * in: formData
161
- * type: string
162
- * oidcClientSecretPost:
163
- * name: oidcClientSecret
164
- * description: clientSecret of the application set up on the OpenID Provider
165
- * in: formData
166
- * type: string
167
- * sortOrder:
168
- * name: sortOrder
169
- * description: Indicate the position of the connection in the IdP selection screen
170
- * in: formData
171
- * type: number
172
- * required: false
173
- * forceAuthn:
174
- * name: forceAuthn
175
- * description: Require a new authentication instead of reusing an existing session.
176
- * in: formData
177
- * type: boolean
178
- * required: false
227
+ */
228
+ /**
229
+ *
230
+ * @openapi
179
231
  * /api/v1/sso:
180
232
  * post:
233
+ * tags:
234
+ * - Single Sign-On
181
235
  * summary: Create SSO connection
182
236
  * operationId: create-sso-connection
183
- * tags: [Single Sign-On]
184
- * produces:
185
- * - application/json
186
- * consumes:
187
- * - application/x-www-form-urlencoded
188
- * - application/json
189
- * parameters:
190
- * - $ref: '#/parameters/nameParamPost'
191
- * - $ref: '#/parameters/labelParamPost'
192
- * - $ref: '#/parameters/descriptionParamPost'
193
- * - $ref: '#/parameters/encodedRawMetadataParamPost'
194
- * - $ref: '#/parameters/rawMetadataParamPost'
195
- * - $ref: '#/parameters/metadataUrlParamPost'
196
- * - $ref: '#/parameters/defaultRedirectUrlParamPost'
197
- * - $ref: '#/parameters/redirectUrlParamPost'
198
- * - $ref: '#/parameters/tenantParamPost'
199
- * - $ref: '#/parameters/productParamPost'
200
- * - $ref: '#/parameters/oidcDiscoveryUrlPost'
201
- * - $ref: '#/parameters/oidcMetadataPost'
202
- * - $ref: '#/parameters/oidcClientIdPost'
203
- * - $ref: '#/parameters/oidcClientSecretPost'
204
- * - $ref: '#/parameters/sortOrder'
205
- * - $ref: '#/parameters/forceAuthn'
237
+ * requestBody:
238
+ * content:
239
+ * application/x-www-form-urlencoded:
240
+ * schema:
241
+ * required:
242
+ * - defaultRedirectUrl
243
+ * - product
244
+ * - redirectUrl
245
+ * - tenant
246
+ * type: object
247
+ * properties:
248
+ * name:
249
+ * type: string
250
+ * description: Name of connection
251
+ * label:
252
+ * type: string
253
+ * description: An internal label to identify the connection
254
+ * description:
255
+ * type: string
256
+ * description: A short description for the connection not more than 100 characters
257
+ * encodedRawMetadata:
258
+ * type: string
259
+ * description: Base64 encoding of the XML metadata
260
+ * rawMetadata:
261
+ * type: string
262
+ * description: Raw XML metadata
263
+ * metadataUrl:
264
+ * type: string
265
+ * description: URL containing raw XML metadata
266
+ * defaultRedirectUrl:
267
+ * type: string
268
+ * description: The redirect URL to use in the IdP login flow
269
+ * redirectUrl:
270
+ * type: array
271
+ * items:
272
+ * type: string
273
+ * description: JSON encoded array containing a list of allowed redirect URLs
274
+ * tenant:
275
+ * type: string
276
+ * description: Tenant
277
+ * product:
278
+ * type: string
279
+ * description: Product
280
+ * oidcDiscoveryUrl:
281
+ * type: string
282
+ * description: well-known URL where the OpenID Provider configuration is exposed
283
+ * oidcMetadata:
284
+ * type: string
285
+ * description: metadata (JSON) for the OpenID Provider in the absence of discoveryUrl
286
+ * oidcClientId:
287
+ * type: string
288
+ * description: clientId of the application set up on the OpenID Provider
289
+ * oidcClientSecret:
290
+ * type: string
291
+ * description: clientSecret of the application set up on the OpenID Provider
292
+ * sortOrder:
293
+ * type: number
294
+ * description: Indicate the position of the connection in the IdP selection screen
295
+ * forceAuthn:
296
+ * type: boolean
297
+ * description: Require a new authentication instead of reusing an existing session.
298
+ * application/json:
299
+ * schema:
300
+ * required:
301
+ * - defaultRedirectUrl
302
+ * - product
303
+ * - redirectUrl
304
+ * - tenant
305
+ * type: object
306
+ * properties:
307
+ * name:
308
+ * type: string
309
+ * description: Name of connection
310
+ * label:
311
+ * type: string
312
+ * description: An internal label to identify the connection
313
+ * description:
314
+ * type: string
315
+ * description: A short description for the connection not more than 100 characters
316
+ * encodedRawMetadata:
317
+ * type: string
318
+ * description: Base64 encoding of the XML metadata
319
+ * rawMetadata:
320
+ * type: string
321
+ * description: Raw XML metadata
322
+ * metadataUrl:
323
+ * type: string
324
+ * description: URL containing raw XML metadata
325
+ * defaultRedirectUrl:
326
+ * type: string
327
+ * description: The redirect URL to use in the IdP login flow
328
+ * redirectUrl:
329
+ * type: array
330
+ * items:
331
+ * type: string
332
+ * description: JSON encoded array containing a list of allowed redirect URLs
333
+ * tenant:
334
+ * type: string
335
+ * description: Tenant
336
+ * product:
337
+ * type: string
338
+ * description: Product
339
+ * oidcDiscoveryUrl:
340
+ * type: string
341
+ * description: well-known URL where the OpenID Provider configuration is exposed
342
+ * oidcMetadata:
343
+ * type: string
344
+ * description: metadata (JSON) for the OpenID Provider in the absence of discoveryUrl
345
+ * oidcClientId:
346
+ * type: string
347
+ * description: clientId of the application set up on the OpenID Provider
348
+ * oidcClientSecret:
349
+ * type: string
350
+ * description: clientSecret of the application set up on the OpenID Provider
351
+ * sortOrder:
352
+ * type: number
353
+ * description: Indicate the position of the connection in the IdP selection screen
354
+ * forceAuthn:
355
+ * type: boolean
356
+ * description: Require a new authentication instead of reusing an existing session.
357
+ * required: true
206
358
  * responses:
207
359
  * 200:
208
360
  * description: Success
209
- * schema:
210
- * $ref: '#/definitions/Connection'
211
- * 400:
212
- * $ref: '#/definitions/validationErrorsPost'
213
- * 401:
361
+ * content:
362
+ * application/json:
363
+ * schema:
364
+ * $ref: "#/components/schemas/Connection"
365
+ * "400":
366
+ * $ref: "#/components/schemas/validationErrorsPost"
367
+ * "401":
214
368
  * description: Unauthorized
215
369
  */
216
370
  createSAMLConnection(body) {
@@ -239,150 +393,164 @@ class ConnectionAPIController {
239
393
  });
240
394
  }
241
395
  /**
242
- * @swagger
243
- * definitions:
244
- * validationErrorsPatch:
245
- * description: Please provide clientID | Please provide clientSecret | clientSecret mismatch | Tenant/Product config mismatch with IdP metadata | Description should not exceed 100 characters| redirectUrl is invalid | Exceeded maximum number of allowed redirect urls | defaultRedirectUrl is invalid | Tenant/Product config mismatch with OIDC Provider metadata
246
- * parameters:
247
- * clientIDParamPatch:
248
- * name: clientID
249
- * description: Client ID for the connection
250
- * type: string
251
- * in: formData
252
- * required: true
253
- * clientSecretParamPatch:
254
- * name: clientSecret
255
- * description: Client Secret for the connection
256
- * type: string
257
- * in: formData
258
- * required: true
259
- * tenantParamPatch:
260
- * name: tenant
261
- * description: Tenant
262
- * in: formData
263
- * required: true
264
- * type: string
265
- * productParamPatch:
266
- * name: product
267
- * description: Product
268
- * in: formData
269
- * required: true
270
- * type: string
271
- * nameParamPatch:
272
- * name: name
273
- * description: Name/identifier for the connection
274
- * type: string
275
- * in: formData
276
- * labelParamPatch:
277
- * name: label
278
- * description: An internal label to identify the connection
279
- * type: string
280
- * in: formData
281
- * descriptionParamPatch:
282
- * name: description
283
- * description: A short description for the connection not more than 100 characters
284
- * type: string
285
- * in: formData
286
- * encodedRawMetadataParamPatch:
287
- * name: encodedRawMetadata
288
- * description: Base64 encoding of the XML metadata
289
- * in: formData
290
- * type: string
291
- * rawMetadataParamPatch:
292
- * name: rawMetadata
293
- * description: Raw XML metadata
294
- * in: formData
295
- * type: string
296
- * metadataUrlParamPatch:
297
- * name: metadataUrl
298
- * description: URL containing raw XML metadata
299
- * in: formData
300
- * type: string
301
- * oidcDiscoveryUrlPatch:
302
- * name: oidcDiscoveryUrl
303
- * description: well-known URL where the OpenID Provider configuration is exposed
304
- * in: formData
305
- * type: string
306
- * oidcMetadataPatch:
307
- * name: oidcMetadata
308
- * description: metadata (JSON) for the OpenID Provider in the absence of discoveryUrl
309
- * in: formData
310
- * type: string
311
- * oidcClientIdPatch:
312
- * name: oidcClientId
313
- * description: clientId of the application set up on the OpenID Provider
314
- * in: formData
315
- * type: string
316
- * oidcClientSecretPatch:
317
- * name: oidcClientSecret
318
- * description: clientSecret of the application set up on the OpenID Provider
319
- * in: formData
320
- * type: string
321
- * defaultRedirectUrlParamPatch:
322
- * name: defaultRedirectUrl
323
- * description: The redirect URL to use in the IdP login flow
324
- * in: formData
325
- * type: string
326
- * redirectUrlParamPatch:
327
- * name: redirectUrl
328
- * description: JSON encoded array containing a list of allowed redirect URLs
329
- * in: formData
330
- * type: string
331
- * deactivatedParamPatch:
332
- * name: deactivated
333
- * description: Connection status
334
- * in: formData
335
- * required: false
336
- * type: boolean
337
- * sortOrderParamPatch:
338
- * name: sortOrder
339
- * description: Indicate the position of the connection in the IdP selection screen
340
- * in: formData
341
- * type: number
342
- * required: false
343
- * forceAuthnParamPatch:
344
- * name: forceAuthn
345
- * description: Require a new authentication instead of reusing an existing session.
346
- * in: formData
347
- * type: boolean
348
- * required: false
396
+ * @openapi
349
397
  * /api/v1/sso:
350
398
  * patch:
399
+ * tags:
400
+ * - Single Sign-On
351
401
  * summary: Update SSO Connection
352
402
  * operationId: update-sso-connection
353
- * tags: [Single Sign-On]
354
- * consumes:
355
- * - application/json
356
- * - application/x-www-form-urlencoded
357
- * parameters:
358
- * - $ref: '#/parameters/clientIDParamPatch'
359
- * - $ref: '#/parameters/clientSecretParamPatch'
360
- * - $ref: '#/parameters/nameParamPatch'
361
- * - $ref: '#/parameters/labelParamPatch'
362
- * - $ref: '#/parameters/descriptionParamPatch'
363
- * - $ref: '#/parameters/encodedRawMetadataParamPatch'
364
- * - $ref: '#/parameters/rawMetadataParamPatch'
365
- * - $ref: '#/parameters/metadataUrlParamPatch'
366
- * - $ref: '#/parameters/oidcDiscoveryUrlPatch'
367
- * - $ref: '#/parameters/oidcMetadataPatch'
368
- * - $ref: '#/parameters/oidcClientIdPatch'
369
- * - $ref: '#/parameters/oidcClientSecretPatch'
370
- * - $ref: '#/parameters/defaultRedirectUrlParamPatch'
371
- * - $ref: '#/parameters/redirectUrlParamPatch'
372
- * - $ref: '#/parameters/tenantParamPatch'
373
- * - $ref: '#/parameters/productParamPatch'
374
- * - $ref: '#/parameters/deactivatedParamPatch'
375
- * - $ref: '#/parameters/sortOrderParamPatch'
376
- * - $ref: '#/parameters/forceAuthnParamPatch'
403
+ * requestBody:
404
+ * content:
405
+ * application/json:
406
+ * schema:
407
+ * required:
408
+ * - clientID
409
+ * - clientSecret
410
+ * - product
411
+ * - tenant
412
+ * type: object
413
+ * properties:
414
+ * clientID:
415
+ * type: string
416
+ * description: Client ID for the connection
417
+ * clientSecret:
418
+ * type: string
419
+ * description: Client Secret for the connection
420
+ * name:
421
+ * type: string
422
+ * description: Name/identifier for the connection
423
+ * label:
424
+ * type: string
425
+ * description: An internal label to identify the connection
426
+ * description:
427
+ * type: string
428
+ * description: A short description for the connection not more than 100 characters
429
+ * encodedRawMetadata:
430
+ * type: string
431
+ * description: Base64 encoding of the XML metadata
432
+ * rawMetadata:
433
+ * type: string
434
+ * description: Raw XML metadata
435
+ * metadataUrl:
436
+ * type: string
437
+ * description: URL containing raw XML metadata
438
+ * oidcDiscoveryUrl:
439
+ * type: string
440
+ * description: well-known URL where the OpenID Provider configuration is exposed
441
+ * oidcMetadata:
442
+ * type: string
443
+ * description: metadata (JSON) for the OpenID Provider in the absence of discoveryUrl
444
+ * oidcClientId:
445
+ * type: string
446
+ * description: clientId of the application set up on the OpenID Provider
447
+ * oidcClientSecret:
448
+ * type: string
449
+ * description: clientSecret of the application set up on the OpenID Provider
450
+ * defaultRedirectUrl:
451
+ * type: string
452
+ * description: The redirect URL to use in the IdP login flow
453
+ * redirectUrl:
454
+ * type: array
455
+ * items:
456
+ * type: string
457
+ * description: JSON encoded array containing a list of allowed redirect URLs
458
+ * tenant:
459
+ * type: string
460
+ * description: Tenant
461
+ * product:
462
+ * type: string
463
+ * description: Product
464
+ * deactivated:
465
+ * type: boolean
466
+ * description: Connection status
467
+ * sortOrder:
468
+ * type: number
469
+ * description: Indicate the position of the connection in the IdP selection screen
470
+ * forceAuthn:
471
+ * type: boolean
472
+ * description: Require a new authentication instead of reusing an existing session.
473
+ * application/x-www-form-urlencoded:
474
+ * schema:
475
+ * required:
476
+ * - clientID
477
+ * - clientSecret
478
+ * - product
479
+ * - tenant
480
+ * type: object
481
+ * properties:
482
+ * clientID:
483
+ * type: string
484
+ * description: Client ID for the connection
485
+ * clientSecret:
486
+ * type: string
487
+ * description: Client Secret for the connection
488
+ * name:
489
+ * type: string
490
+ * description: Name/identifier for the connection
491
+ * label:
492
+ * type: string
493
+ * description: An internal label to identify the connection
494
+ * description:
495
+ * type: string
496
+ * description: A short description for the connection not more than 100 characters
497
+ * encodedRawMetadata:
498
+ * type: string
499
+ * description: Base64 encoding of the XML metadata
500
+ * rawMetadata:
501
+ * type: string
502
+ * description: Raw XML metadata
503
+ * metadataUrl:
504
+ * type: string
505
+ * description: URL containing raw XML metadata
506
+ * oidcDiscoveryUrl:
507
+ * type: string
508
+ * description: well-known URL where the OpenID Provider configuration is exposed
509
+ * oidcMetadata:
510
+ * type: string
511
+ * description: metadata (JSON) for the OpenID Provider in the absence of discoveryUrl
512
+ * oidcClientId:
513
+ * type: string
514
+ * description: clientId of the application set up on the OpenID Provider
515
+ * oidcClientSecret:
516
+ * type: string
517
+ * description: clientSecret of the application set up on the OpenID Provider
518
+ * defaultRedirectUrl:
519
+ * type: string
520
+ * description: The redirect URL to use in the IdP login flow
521
+ * redirectUrl:
522
+ * type: array
523
+ * items:
524
+ * type: string
525
+ * description: JSON encoded array containing a list of allowed redirect URLs
526
+ * tenant:
527
+ * type: string
528
+ * description: Tenant
529
+ * product:
530
+ * type: string
531
+ * description: Product
532
+ * deactivated:
533
+ * type: boolean
534
+ * description: Connection status
535
+ * sortOrder:
536
+ * type: number
537
+ * description: Indicate the position of the connection in the IdP selection screen
538
+ * forceAuthn:
539
+ * type: boolean
540
+ * description: Require a new authentication instead of reusing an existing session.
541
+ * required: true
377
542
  * responses:
378
- * 204:
543
+ * "204":
379
544
  * description: Success
380
- * 400:
381
- * $ref: '#/definitions/validationErrorsPatch'
382
- * 401:
545
+ * content: {}
546
+ * "400":
547
+ * $ref: "#/components/schemas/validationErrorsPatch"
548
+ * "401":
383
549
  * description: Unauthorized
384
- * 500:
550
+ * content: {}
551
+ * "500":
385
552
  * description: Please set OpenID response handler path (oidcPath) on Jackson
553
+ * content: {}
386
554
  */
387
555
  updateSAMLConnection(body) {
388
556
  return __awaiter(this, void 0, void 0, function* () {
@@ -430,105 +598,48 @@ class ConnectionAPIController {
430
598
  }
431
599
  }
432
600
  /**
433
- * @swagger
434
- * parameters:
435
- * tenantParamGet:
436
- * in: query
437
- * name: tenant
438
- * type: string
439
- * description: Tenant (Optional if clientID provided)
440
- * productParamGet:
441
- * in: query
442
- * name: product
443
- * type: string
444
- * description: Product (Optional if clientID provided)
445
- * clientIDParamGet:
446
- * in: query
447
- * name: clientID
448
- * type: string
449
- * description: Client ID (Optional if tenant/product provided)
450
- * strategyParamGet:
451
- * in: query
452
- * name: strategy
453
- * type: string
454
- * description: Strategy which can help to filter connections with tenant/product query
455
- * sortParamGet:
456
- * in: query
457
- * name: sort
458
- * type: string
459
- * description: If present, the connections will be sorted by `sortOrder`. It won't consider if pagination is used.
460
- * definitions:
461
- * Connection:
462
- * type: object
463
- * properties:
464
- * clientID:
465
- * type: string
466
- * description: Connection clientID
467
- * clientSecret:
468
- * type: string
469
- * description: Connection clientSecret
470
- * name:
471
- * type: string
472
- * description: Connection name
473
- * label:
474
- * type: string
475
- * description: Connection label
476
- * description:
477
- * type: string
478
- * description: Connection description
479
- * redirectUrl:
480
- * type: string
481
- * description: A list of allowed redirect URLs
482
- * defaultRedirectUrl:
483
- * type: string
484
- * description: The redirect URL to use in the IdP login flow
485
- * tenant:
486
- * type: string
487
- * description: Connection tenant
488
- * product:
489
- * type: string
490
- * description: Connection product
491
- * idpMetadata:
492
- * type: object
493
- * description: SAML IdP metadata
494
- * oidcProvider:
495
- * type: object
496
- * description: OIDC IdP metadata
497
- * deactivated:
498
- * type: boolean
499
- * description: Connection status
500
- * sortOrder:
501
- * type: number
502
- * description: Connection sort order
503
- * responses:
504
- * '200Get':
505
- * description: Success
506
- * schema:
507
- * type: array
508
- * items:
509
- * $ref: '#/definitions/Connection'
510
- * '400Get':
511
- * description: Please provide `clientID` or `tenant` and `product`.
512
- * '401Get':
513
- * description: Unauthorized
601
+ * @openapi
514
602
  * /api/v1/sso:
515
603
  * get:
604
+ * tags:
605
+ * - Single Sign-On
516
606
  * summary: Get SSO Connections
517
- * parameters:
518
- * - $ref: '#/parameters/tenantParamGet'
519
- * - $ref: '#/parameters/productParamGet'
520
- * - $ref: '#/parameters/clientIDParamGet'
521
- * - $ref: '#/parameters/strategyParamGet'
522
- * - $ref: '#/parameters/sortParamGet'
523
607
  * operationId: get-connections
524
- * tags: [Single Sign-On]
608
+ * parameters:
609
+ * - name: tenant
610
+ * in: query
611
+ * description: Tenant
612
+ * required: true
613
+ * schema:
614
+ * type: string
615
+ * - name: product
616
+ * in: query
617
+ * description: Product
618
+ * required: true
619
+ * schema:
620
+ * type: string
621
+ * - name: clientID
622
+ * in: query
623
+ * description: Client ID (Optional if tenant/product provided)
624
+ * schema:
625
+ * type: string
626
+ * - name: strategy
627
+ * in: query
628
+ * description: Strategy which can help to filter connections with tenant/product query
629
+ * schema:
630
+ * type: string
631
+ * - name: sort
632
+ * in: query
633
+ * description: If present, the connections will be sorted by `sortOrder`. It won't consider if pagination is used.
634
+ * schema:
635
+ * type: string
525
636
  * responses:
526
637
  * '200':
527
- * $ref: '#/responses/200Get'
638
+ * $ref: '#/components/responses/200Get'
528
639
  * '400':
529
- * $ref: '#/responses/400Get'
640
+ * $ref: '#/components/responses/400Get'
530
641
  * '401':
531
- * $ref: '#/responses/401Get'
642
+ * $ref: '#/components/responses/401Get'
532
643
  */
533
644
  getConnections(body) {
534
645
  return __awaiter(this, void 0, void 0, function* () {
@@ -637,44 +748,39 @@ class ConnectionAPIController {
637
748
  });
638
749
  }
639
750
  /**
640
- * @swagger
641
- * parameters:
642
- * clientIDDel:
643
- * name: clientID
644
- * in: query
645
- * type: string
646
- * description: Client ID (Optional if tenant/product provided)
647
- * clientSecretDel:
648
- * name: clientSecret
649
- * in: query
650
- * type: string
651
- * description: Client Secret (Optional if tenant/product provided)
652
- * tenantDel:
653
- * name: tenant
654
- * in: query
655
- * type: string
656
- * description: Tenant (Optional if clientID/Secret provided)
657
- * productDel:
658
- * name: product
659
- * in: query
660
- * type: string
661
- * description: Product (Optional if clientID/Secret provided)
662
- * strategyDel:
663
- * name: strategy
664
- * in: query
665
- * type: string
666
- * description: Strategy which can help to filter connections with tenant/product query
751
+ * @openapi
667
752
  * /api/v1/sso:
668
753
  * delete:
669
- * parameters:
670
- * - $ref: '#/parameters/clientIDDel'
671
- * - $ref: '#/parameters/clientSecretDel'
672
- * - $ref: '#/parameters/tenantDel'
673
- * - $ref: '#/parameters/productDel'
674
- * - $ref: '#/parameters/strategyDel'
754
+ * tags:
755
+ * - Single Sign-On
675
756
  * summary: Delete SSO Connections
676
757
  * operationId: delete-sso-connection
677
- * tags: [Single Sign-On]
758
+ * parameters:
759
+ * - name: clientID
760
+ * in: query
761
+ * description: Client ID (Optional if tenant/product provided)
762
+ * schema:
763
+ * type: string
764
+ * - name: clientSecret
765
+ * in: query
766
+ * description: Client Secret (Optional if tenant/product provided)
767
+ * schema:
768
+ * type: string
769
+ * - name: tenant
770
+ * in: query
771
+ * description: Tenant (Optional if clientID/Secret provided)
772
+ * schema:
773
+ * type: string
774
+ * - name: product
775
+ * in: query
776
+ * description: Product (Optional if clientID/Secret provided)
777
+ * schema:
778
+ * type: string
779
+ * - name: strategy
780
+ * in: query
781
+ * description: Strategy which can help to filter connections with tenant/product query
782
+ * schema:
783
+ * type: string
678
784
  * responses:
679
785
  * '200':
680
786
  * description: Success
@@ -744,84 +850,25 @@ class ConnectionAPIController {
744
850
  });
745
851
  }
746
852
  /**
747
- * @swagger
748
- * parameters:
749
- * productParamGet:
750
- * in: query
751
- * name: product
752
- * type: string
753
- * description: Product
754
- * required: true
755
- * definitions:
756
- * Connection:
757
- * type: object
758
- * properties:
759
- * clientID:
760
- * type: string
761
- * description: Connection clientID
762
- * clientSecret:
763
- * type: string
764
- * description: Connection clientSecret
765
- * name:
766
- * type: string
767
- * description: Connection name
768
- * description:
769
- * type: string
770
- * description: Connection description
771
- * redirectUrl:
772
- * type: string
773
- * description: A list of allowed redirect URLs
774
- * defaultRedirectUrl:
775
- * type: string
776
- * description: The redirect URL to use in the IdP login flow
777
- * tenant:
778
- * type: string
779
- * description: Connection tenant
780
- * product:
781
- * type: string
782
- * description: Connection product
783
- * idpMetadata:
784
- * type: object
785
- * description: SAML IdP metadata
786
- * oidcProvider:
787
- * type: object
788
- * description: OIDC IdP metadata
789
- * responses:
790
- * '200GetByProduct':
791
- * description: Success
792
- * content:
793
- * application/json:
794
- * schema:
795
- * type: object
796
- * properties:
797
- * data:
798
- * type: array
799
- * items:
800
- * $ref: '#/definitions/Connection'
801
- * pageToken:
802
- * type: string
803
- * description: token for pagination
804
- * '400Get':
805
- * description: Please provide a `product`.
806
- * '401Get':
807
- * description: Unauthorized
853
+ * @openapi
808
854
  * /api/v1/sso/product:
809
855
  * get:
856
+ * tags:
857
+ * - Single Sign-On
810
858
  * summary: Get SSO Connections by product
811
- * parameters:
812
- * - $ref: '#/parameters/productParamGet'
813
- * - $ref: '#/parameters/pageOffset'
814
- * - $ref: '#/parameters/pageLimit'
815
- * - $ref: '#/parameters/pageToken'
816
859
  * operationId: get-connections-by-product
817
- * tags: [Single Sign-On]
860
+ * parameters:
861
+ * - $ref: '#/components/parameters/productParamGet'
862
+ * - $ref: '#/components/parameters/pageOffset'
863
+ * - $ref: '#/components/parameters/pageLimit'
864
+ * - $ref: '#/components/parameters/pageToken'
818
865
  * responses:
819
866
  * '200':
820
- * $ref: '#/responses/200GetByProduct'
867
+ * $ref: '#/components/responses/200GetByProduct'
821
868
  * '400':
822
- * $ref: '#/responses/400Get'
869
+ * $ref: '#/components/responses/400Get'
823
870
  * '401':
824
- * $ref: '#/responses/401Get'
871
+ * $ref: '#/components/responses/401Get'
825
872
  */
826
873
  getConnectionsByProduct(body) {
827
874
  return __awaiter(this, void 0, void 0, function* () {