@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.d.ts CHANGED
@@ -11,454 +11,560 @@ export declare class ConnectionAPIController implements IConnectionAPIController
11
11
  oryController: any;
12
12
  });
13
13
  /**
14
- * @swagger
15
- * definitions:
16
- * Connection:
17
- * type: object
18
- * example:
19
- * {
20
- * "idpMetadata": {
21
- * "sso": {
22
- * "postUrl": "https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxsso/saml",
23
- * "redirectUrl": "https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxsso/saml"
24
- * },
25
- * "entityID": "http://www.okta.com/xxxxxxxxxxxxx",
26
- * "thumbprint": "Eo+eUi3UM3XIMkFFtdVK3yJ5vO9f7YZdasdasdad",
27
- * "loginType": "idp",
28
- * "provider": "okta.com"
29
- * },
30
- * "defaultRedirectUrl": "https://hoppscotch.io/",
31
- * "redirectUrl": ["https://hoppscotch.io/"],
32
- * "tenant": "hoppscotch.io",
33
- * "product": "API Engine",
34
- * "name": "Hoppscotch-SP",
35
- * "description": "SP for hoppscotch.io",
36
- * "clientID": "Xq8AJt3yYAxmXizsCWmUBDRiVP1iTC8Y/otnvFIMitk",
37
- * "clientSecret": "00e3e11a3426f97d8000000738300009130cd45419c5943",
38
- * "deactivated": false
39
- * }
40
- * validationErrorsPost:
41
- * 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
14
+ * @openapi
15
+ * components:
16
+ * schemas:
17
+ * Connection:
18
+ * type: object
19
+ * properties:
20
+ * clientID:
21
+ * type: string
22
+ * description: Connection clientID
23
+ * clientSecret:
24
+ * type: string
25
+ * description: Connection clientSecret
26
+ * name:
27
+ * type: string
28
+ * description: Connection name
29
+ * label:
30
+ * type: string
31
+ * description: Connection label
32
+ * description:
33
+ * type: string
34
+ * description: Connection description
35
+ * redirectUrl:
36
+ * type: array
37
+ * items:
38
+ * type: string
39
+ * description: A list of allowed redirect URLs
40
+ * defaultRedirectUrl:
41
+ * type: string
42
+ * description: The redirect URL to use in the IdP login flow
43
+ * tenant:
44
+ * type: string
45
+ * description: Connection tenant
46
+ * product:
47
+ * type: string
48
+ * description: Connection product
49
+ * idpMetadata:
50
+ * type: object
51
+ * properties: {}
52
+ * description: SAML IdP metadata
53
+ * oidcProvider:
54
+ * type: object
55
+ * properties: {}
56
+ * description: OIDC IdP metadata
57
+ * deactivated:
58
+ * type: boolean
59
+ * description: Connection status
60
+ * sortOrder:
61
+ * type: number
62
+ * description: Connection sort order
63
+ * example:
64
+ * idpMetadata:
65
+ * sso:
66
+ * postUrl: https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxsso/saml
67
+ * redirectUrl: https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxsso/saml
68
+ * entityID: http://www.okta.com/xxxxxxxxxxxxx
69
+ * thumbprint: Eo+eUi3UM3XIMkFFtdVK3yJ5vO9f7YZdasdasdad
70
+ * loginType: idp
71
+ * provider: okta.com
72
+ * defaultRedirectUrl: https://hoppscotch.io/
73
+ * redirectUrl:
74
+ * - https://hoppscotch.io/
75
+ * tenant: hoppscotch.io
76
+ * product: API Engine
77
+ * name: Hoppscotch-SP
78
+ * description: SP for hoppscotch.io
79
+ * clientID: Xq8AJt3yYAxmXizsCWmUBDRiVP1iTC8Y/otnvFIMitk
80
+ * clientSecret: 00e3e11a3426f97d8000000738300009130cd45419c5943
81
+ * deactivated: false
82
+ * validationErrorsPost:
83
+ * 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
84
+ * validationErrorsPatch:
85
+ * 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
86
+ * responses:
87
+ * 200Get:
88
+ * description: Success
89
+ * content:
90
+ * application/json:
91
+ * schema:
92
+ * type: array
93
+ * items:
94
+ * $ref: "#/components/schemas/Connection"
95
+ * 400Get:
96
+ * description: Please provide a `product`.
97
+ * content: {}
98
+ * 401Get:
99
+ * description: Unauthorized
100
+ * content: {}
101
+ * 200GetByProduct:
102
+ * description: Success
103
+ * content:
104
+ * application/json:
105
+ * schema:
106
+ * type: array
107
+ * items:
108
+ * $ref: "#/components/schemas/Connection"
109
+ * parameters:
110
+ * tenantParamGet:
111
+ * name: tenant
112
+ * in: query
113
+ * description: Tenant
114
+ * required: true
115
+ * schema:
116
+ * type: string
117
+ * productParamGet:
118
+ * name: product
119
+ * in: query
120
+ * description: Product
121
+ * required: true
122
+ * schema:
123
+ * type: string
124
+ * clientIDParamGet:
125
+ * name: clientID
126
+ * in: query
127
+ * description: Client ID (Optional if tenant/product provided)
128
+ * schema:
129
+ * type: string
130
+ * strategyParamGet:
131
+ * name: strategy
132
+ * in: query
133
+ * description: Strategy which can help to filter connections with tenant/product query
134
+ * schema:
135
+ * type: string
136
+ * sortParamGet:
137
+ * name: sort
138
+ * in: query
139
+ * description: If present, the connections will be sorted by `sortOrder`. It won't consider if pagination is used.
140
+ * schema:
141
+ * type: string
142
+ * clientIDDel:
143
+ * name: clientID
144
+ * in: query
145
+ * description: Client ID (Optional if tenant/product provided)
146
+ * schema:
147
+ * type: string
148
+ * clientSecretDel:
149
+ * name: clientSecret
150
+ * in: query
151
+ * description: Client Secret (Optional if tenant/product provided)
152
+ * schema:
153
+ * type: string
154
+ * tenantDel:
155
+ * name: tenant
156
+ * in: query
157
+ * description: Tenant (Optional if clientID/Secret provided)
158
+ * schema:
159
+ * type: string
160
+ * productDel:
161
+ * name: product
162
+ * in: query
163
+ * description: Product (Optional if clientID/Secret provided)
164
+ * schema:
165
+ * type: string
166
+ * strategyDel:
167
+ * name: strategy
168
+ * in: query
169
+ * description: Strategy which can help to filter connections with tenant/product query
170
+ * schema:
171
+ * type: string
172
+ * securitySchemes:
173
+ * apiKey:
174
+ * type: apiKey
175
+ * name: Authorization
176
+ * in: header
42
177
  *
43
- * parameters:
44
- * nameParamPost:
45
- * name: name
46
- * description: Name/identifier for the connection
47
- * type: string
48
- * in: formData
49
- * labelParamPost:
50
- * name: label
51
- * description: An internal label to identify the connection
52
- * type: string
53
- * in: formData
54
- * descriptionParamPost:
55
- * name: description
56
- * description: A short description for the connection not more than 100 characters
57
- * type: string
58
- * in: formData
59
- * encodedRawMetadataParamPost:
60
- * name: encodedRawMetadata
61
- * description: Base64 encoding of the XML metadata
62
- * in: formData
63
- * type: string
64
- * rawMetadataParamPost:
65
- * name: rawMetadata
66
- * description: Raw XML metadata
67
- * in: formData
68
- * type: string
69
- * metadataUrlParamPost:
70
- * name: metadataUrl
71
- * description: URL containing raw XML metadata
72
- * in: formData
73
- * type: string
74
- * defaultRedirectUrlParamPost:
75
- * name: defaultRedirectUrl
76
- * description: The redirect URL to use in the IdP login flow
77
- * in: formData
78
- * required: true
79
- * type: string
80
- * redirectUrlParamPost:
81
- * name: redirectUrl
82
- * description: JSON encoded array containing a list of allowed redirect URLs
83
- * in: formData
84
- * required: true
85
- * type: string
86
- * tenantParamPost:
87
- * name: tenant
88
- * description: Tenant
89
- * in: formData
90
- * required: true
91
- * type: string
92
- * productParamPost:
93
- * name: product
94
- * description: Product
95
- * in: formData
96
- * required: true
97
- * type: string
98
- * oidcDiscoveryUrlPost:
99
- * name: oidcDiscoveryUrl
100
- * description: well-known URL where the OpenID Provider configuration is exposed
101
- * in: formData
102
- * type: string
103
- * oidcMetadataPost:
104
- * name: oidcMetadata
105
- * description: metadata (JSON) for the OpenID Provider in the absence of discoveryUrl
106
- * in: formData
107
- * type: string
108
- * oidcClientIdPost:
109
- * name: oidcClientId
110
- * description: clientId of the application set up on the OpenID Provider
111
- * in: formData
112
- * type: string
113
- * oidcClientSecretPost:
114
- * name: oidcClientSecret
115
- * description: clientSecret of the application set up on the OpenID Provider
116
- * in: formData
117
- * type: string
118
- * sortOrder:
119
- * name: sortOrder
120
- * description: Indicate the position of the connection in the IdP selection screen
121
- * in: formData
122
- * type: number
123
- * required: false
124
- * forceAuthn:
125
- * name: forceAuthn
126
- * description: Require a new authentication instead of reusing an existing session.
127
- * in: formData
128
- * type: boolean
129
- * required: false
178
+ */
179
+ /**
180
+ *
181
+ * @openapi
130
182
  * /api/v1/sso:
131
183
  * post:
184
+ * tags:
185
+ * - Single Sign-On
132
186
  * summary: Create SSO connection
133
187
  * operationId: create-sso-connection
134
- * tags: [Single Sign-On]
135
- * produces:
136
- * - application/json
137
- * consumes:
138
- * - application/x-www-form-urlencoded
139
- * - application/json
140
- * parameters:
141
- * - $ref: '#/parameters/nameParamPost'
142
- * - $ref: '#/parameters/labelParamPost'
143
- * - $ref: '#/parameters/descriptionParamPost'
144
- * - $ref: '#/parameters/encodedRawMetadataParamPost'
145
- * - $ref: '#/parameters/rawMetadataParamPost'
146
- * - $ref: '#/parameters/metadataUrlParamPost'
147
- * - $ref: '#/parameters/defaultRedirectUrlParamPost'
148
- * - $ref: '#/parameters/redirectUrlParamPost'
149
- * - $ref: '#/parameters/tenantParamPost'
150
- * - $ref: '#/parameters/productParamPost'
151
- * - $ref: '#/parameters/oidcDiscoveryUrlPost'
152
- * - $ref: '#/parameters/oidcMetadataPost'
153
- * - $ref: '#/parameters/oidcClientIdPost'
154
- * - $ref: '#/parameters/oidcClientSecretPost'
155
- * - $ref: '#/parameters/sortOrder'
156
- * - $ref: '#/parameters/forceAuthn'
188
+ * requestBody:
189
+ * content:
190
+ * application/x-www-form-urlencoded:
191
+ * schema:
192
+ * required:
193
+ * - defaultRedirectUrl
194
+ * - product
195
+ * - redirectUrl
196
+ * - tenant
197
+ * type: object
198
+ * properties:
199
+ * name:
200
+ * type: string
201
+ * description: Name of connection
202
+ * label:
203
+ * type: string
204
+ * description: An internal label to identify the connection
205
+ * description:
206
+ * type: string
207
+ * description: A short description for the connection not more than 100 characters
208
+ * encodedRawMetadata:
209
+ * type: string
210
+ * description: Base64 encoding of the XML metadata
211
+ * rawMetadata:
212
+ * type: string
213
+ * description: Raw XML metadata
214
+ * metadataUrl:
215
+ * type: string
216
+ * description: URL containing raw XML metadata
217
+ * defaultRedirectUrl:
218
+ * type: string
219
+ * description: The redirect URL to use in the IdP login flow
220
+ * redirectUrl:
221
+ * type: array
222
+ * items:
223
+ * type: string
224
+ * description: JSON encoded array containing a list of allowed redirect URLs
225
+ * tenant:
226
+ * type: string
227
+ * description: Tenant
228
+ * product:
229
+ * type: string
230
+ * description: Product
231
+ * oidcDiscoveryUrl:
232
+ * type: string
233
+ * description: well-known URL where the OpenID Provider configuration is exposed
234
+ * oidcMetadata:
235
+ * type: string
236
+ * description: metadata (JSON) for the OpenID Provider in the absence of discoveryUrl
237
+ * oidcClientId:
238
+ * type: string
239
+ * description: clientId of the application set up on the OpenID Provider
240
+ * oidcClientSecret:
241
+ * type: string
242
+ * description: clientSecret of the application set up on the OpenID Provider
243
+ * sortOrder:
244
+ * type: number
245
+ * description: Indicate the position of the connection in the IdP selection screen
246
+ * forceAuthn:
247
+ * type: boolean
248
+ * description: Require a new authentication instead of reusing an existing session.
249
+ * application/json:
250
+ * schema:
251
+ * required:
252
+ * - defaultRedirectUrl
253
+ * - product
254
+ * - redirectUrl
255
+ * - tenant
256
+ * type: object
257
+ * properties:
258
+ * name:
259
+ * type: string
260
+ * description: Name of connection
261
+ * label:
262
+ * type: string
263
+ * description: An internal label to identify the connection
264
+ * description:
265
+ * type: string
266
+ * description: A short description for the connection not more than 100 characters
267
+ * encodedRawMetadata:
268
+ * type: string
269
+ * description: Base64 encoding of the XML metadata
270
+ * rawMetadata:
271
+ * type: string
272
+ * description: Raw XML metadata
273
+ * metadataUrl:
274
+ * type: string
275
+ * description: URL containing raw XML metadata
276
+ * defaultRedirectUrl:
277
+ * type: string
278
+ * description: The redirect URL to use in the IdP login flow
279
+ * redirectUrl:
280
+ * type: array
281
+ * items:
282
+ * type: string
283
+ * description: JSON encoded array containing a list of allowed redirect URLs
284
+ * tenant:
285
+ * type: string
286
+ * description: Tenant
287
+ * product:
288
+ * type: string
289
+ * description: Product
290
+ * oidcDiscoveryUrl:
291
+ * type: string
292
+ * description: well-known URL where the OpenID Provider configuration is exposed
293
+ * oidcMetadata:
294
+ * type: string
295
+ * description: metadata (JSON) for the OpenID Provider in the absence of discoveryUrl
296
+ * oidcClientId:
297
+ * type: string
298
+ * description: clientId of the application set up on the OpenID Provider
299
+ * oidcClientSecret:
300
+ * type: string
301
+ * description: clientSecret of the application set up on the OpenID Provider
302
+ * sortOrder:
303
+ * type: number
304
+ * description: Indicate the position of the connection in the IdP selection screen
305
+ * forceAuthn:
306
+ * type: boolean
307
+ * description: Require a new authentication instead of reusing an existing session.
308
+ * required: true
157
309
  * responses:
158
310
  * 200:
159
311
  * description: Success
160
- * schema:
161
- * $ref: '#/definitions/Connection'
162
- * 400:
163
- * $ref: '#/definitions/validationErrorsPost'
164
- * 401:
312
+ * content:
313
+ * application/json:
314
+ * schema:
315
+ * $ref: "#/components/schemas/Connection"
316
+ * "400":
317
+ * $ref: "#/components/schemas/validationErrorsPost"
318
+ * "401":
165
319
  * description: Unauthorized
166
320
  */
167
321
  createSAMLConnection(body: SAMLSSOConnectionWithEncodedMetadata | SAMLSSOConnectionWithRawMetadata): Promise<SAMLSSORecord>;
168
322
  config(...args: Parameters<ConnectionAPIController['createSAMLConnection']>): Promise<SAMLSSORecord>;
169
323
  createOIDCConnection(body: OIDCSSOConnectionWithDiscoveryUrl | OIDCSSOConnectionWithMetadata): Promise<OIDCSSORecord>;
170
324
  /**
171
- * @swagger
172
- * definitions:
173
- * validationErrorsPatch:
174
- * 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
175
- * parameters:
176
- * clientIDParamPatch:
177
- * name: clientID
178
- * description: Client ID for the connection
179
- * type: string
180
- * in: formData
181
- * required: true
182
- * clientSecretParamPatch:
183
- * name: clientSecret
184
- * description: Client Secret for the connection
185
- * type: string
186
- * in: formData
187
- * required: true
188
- * tenantParamPatch:
189
- * name: tenant
190
- * description: Tenant
191
- * in: formData
192
- * required: true
193
- * type: string
194
- * productParamPatch:
195
- * name: product
196
- * description: Product
197
- * in: formData
198
- * required: true
199
- * type: string
200
- * nameParamPatch:
201
- * name: name
202
- * description: Name/identifier for the connection
203
- * type: string
204
- * in: formData
205
- * labelParamPatch:
206
- * name: label
207
- * description: An internal label to identify the connection
208
- * type: string
209
- * in: formData
210
- * descriptionParamPatch:
211
- * name: description
212
- * description: A short description for the connection not more than 100 characters
213
- * type: string
214
- * in: formData
215
- * encodedRawMetadataParamPatch:
216
- * name: encodedRawMetadata
217
- * description: Base64 encoding of the XML metadata
218
- * in: formData
219
- * type: string
220
- * rawMetadataParamPatch:
221
- * name: rawMetadata
222
- * description: Raw XML metadata
223
- * in: formData
224
- * type: string
225
- * metadataUrlParamPatch:
226
- * name: metadataUrl
227
- * description: URL containing raw XML metadata
228
- * in: formData
229
- * type: string
230
- * oidcDiscoveryUrlPatch:
231
- * name: oidcDiscoveryUrl
232
- * description: well-known URL where the OpenID Provider configuration is exposed
233
- * in: formData
234
- * type: string
235
- * oidcMetadataPatch:
236
- * name: oidcMetadata
237
- * description: metadata (JSON) for the OpenID Provider in the absence of discoveryUrl
238
- * in: formData
239
- * type: string
240
- * oidcClientIdPatch:
241
- * name: oidcClientId
242
- * description: clientId of the application set up on the OpenID Provider
243
- * in: formData
244
- * type: string
245
- * oidcClientSecretPatch:
246
- * name: oidcClientSecret
247
- * description: clientSecret of the application set up on the OpenID Provider
248
- * in: formData
249
- * type: string
250
- * defaultRedirectUrlParamPatch:
251
- * name: defaultRedirectUrl
252
- * description: The redirect URL to use in the IdP login flow
253
- * in: formData
254
- * type: string
255
- * redirectUrlParamPatch:
256
- * name: redirectUrl
257
- * description: JSON encoded array containing a list of allowed redirect URLs
258
- * in: formData
259
- * type: string
260
- * deactivatedParamPatch:
261
- * name: deactivated
262
- * description: Connection status
263
- * in: formData
264
- * required: false
265
- * type: boolean
266
- * sortOrderParamPatch:
267
- * name: sortOrder
268
- * description: Indicate the position of the connection in the IdP selection screen
269
- * in: formData
270
- * type: number
271
- * required: false
272
- * forceAuthnParamPatch:
273
- * name: forceAuthn
274
- * description: Require a new authentication instead of reusing an existing session.
275
- * in: formData
276
- * type: boolean
277
- * required: false
325
+ * @openapi
278
326
  * /api/v1/sso:
279
327
  * patch:
328
+ * tags:
329
+ * - Single Sign-On
280
330
  * summary: Update SSO Connection
281
331
  * operationId: update-sso-connection
282
- * tags: [Single Sign-On]
283
- * consumes:
284
- * - application/json
285
- * - application/x-www-form-urlencoded
286
- * parameters:
287
- * - $ref: '#/parameters/clientIDParamPatch'
288
- * - $ref: '#/parameters/clientSecretParamPatch'
289
- * - $ref: '#/parameters/nameParamPatch'
290
- * - $ref: '#/parameters/labelParamPatch'
291
- * - $ref: '#/parameters/descriptionParamPatch'
292
- * - $ref: '#/parameters/encodedRawMetadataParamPatch'
293
- * - $ref: '#/parameters/rawMetadataParamPatch'
294
- * - $ref: '#/parameters/metadataUrlParamPatch'
295
- * - $ref: '#/parameters/oidcDiscoveryUrlPatch'
296
- * - $ref: '#/parameters/oidcMetadataPatch'
297
- * - $ref: '#/parameters/oidcClientIdPatch'
298
- * - $ref: '#/parameters/oidcClientSecretPatch'
299
- * - $ref: '#/parameters/defaultRedirectUrlParamPatch'
300
- * - $ref: '#/parameters/redirectUrlParamPatch'
301
- * - $ref: '#/parameters/tenantParamPatch'
302
- * - $ref: '#/parameters/productParamPatch'
303
- * - $ref: '#/parameters/deactivatedParamPatch'
304
- * - $ref: '#/parameters/sortOrderParamPatch'
305
- * - $ref: '#/parameters/forceAuthnParamPatch'
332
+ * requestBody:
333
+ * content:
334
+ * application/json:
335
+ * schema:
336
+ * required:
337
+ * - clientID
338
+ * - clientSecret
339
+ * - product
340
+ * - tenant
341
+ * type: object
342
+ * properties:
343
+ * clientID:
344
+ * type: string
345
+ * description: Client ID for the connection
346
+ * clientSecret:
347
+ * type: string
348
+ * description: Client Secret for the connection
349
+ * name:
350
+ * type: string
351
+ * description: Name/identifier for the connection
352
+ * label:
353
+ * type: string
354
+ * description: An internal label to identify the connection
355
+ * description:
356
+ * type: string
357
+ * description: A short description for the connection not more than 100 characters
358
+ * encodedRawMetadata:
359
+ * type: string
360
+ * description: Base64 encoding of the XML metadata
361
+ * rawMetadata:
362
+ * type: string
363
+ * description: Raw XML metadata
364
+ * metadataUrl:
365
+ * type: string
366
+ * description: URL containing raw XML metadata
367
+ * oidcDiscoveryUrl:
368
+ * type: string
369
+ * description: well-known URL where the OpenID Provider configuration is exposed
370
+ * oidcMetadata:
371
+ * type: string
372
+ * description: metadata (JSON) for the OpenID Provider in the absence of discoveryUrl
373
+ * oidcClientId:
374
+ * type: string
375
+ * description: clientId of the application set up on the OpenID Provider
376
+ * oidcClientSecret:
377
+ * type: string
378
+ * description: clientSecret of the application set up on the OpenID Provider
379
+ * defaultRedirectUrl:
380
+ * type: string
381
+ * description: The redirect URL to use in the IdP login flow
382
+ * redirectUrl:
383
+ * type: array
384
+ * items:
385
+ * type: string
386
+ * description: JSON encoded array containing a list of allowed redirect URLs
387
+ * tenant:
388
+ * type: string
389
+ * description: Tenant
390
+ * product:
391
+ * type: string
392
+ * description: Product
393
+ * deactivated:
394
+ * type: boolean
395
+ * description: Connection status
396
+ * sortOrder:
397
+ * type: number
398
+ * description: Indicate the position of the connection in the IdP selection screen
399
+ * forceAuthn:
400
+ * type: boolean
401
+ * description: Require a new authentication instead of reusing an existing session.
402
+ * application/x-www-form-urlencoded:
403
+ * schema:
404
+ * required:
405
+ * - clientID
406
+ * - clientSecret
407
+ * - product
408
+ * - tenant
409
+ * type: object
410
+ * properties:
411
+ * clientID:
412
+ * type: string
413
+ * description: Client ID for the connection
414
+ * clientSecret:
415
+ * type: string
416
+ * description: Client Secret for the connection
417
+ * name:
418
+ * type: string
419
+ * description: Name/identifier for the connection
420
+ * label:
421
+ * type: string
422
+ * description: An internal label to identify the connection
423
+ * description:
424
+ * type: string
425
+ * description: A short description for the connection not more than 100 characters
426
+ * encodedRawMetadata:
427
+ * type: string
428
+ * description: Base64 encoding of the XML metadata
429
+ * rawMetadata:
430
+ * type: string
431
+ * description: Raw XML metadata
432
+ * metadataUrl:
433
+ * type: string
434
+ * description: URL containing raw XML metadata
435
+ * oidcDiscoveryUrl:
436
+ * type: string
437
+ * description: well-known URL where the OpenID Provider configuration is exposed
438
+ * oidcMetadata:
439
+ * type: string
440
+ * description: metadata (JSON) for the OpenID Provider in the absence of discoveryUrl
441
+ * oidcClientId:
442
+ * type: string
443
+ * description: clientId of the application set up on the OpenID Provider
444
+ * oidcClientSecret:
445
+ * type: string
446
+ * description: clientSecret of the application set up on the OpenID Provider
447
+ * defaultRedirectUrl:
448
+ * type: string
449
+ * description: The redirect URL to use in the IdP login flow
450
+ * redirectUrl:
451
+ * type: array
452
+ * items:
453
+ * type: string
454
+ * description: JSON encoded array containing a list of allowed redirect URLs
455
+ * tenant:
456
+ * type: string
457
+ * description: Tenant
458
+ * product:
459
+ * type: string
460
+ * description: Product
461
+ * deactivated:
462
+ * type: boolean
463
+ * description: Connection status
464
+ * sortOrder:
465
+ * type: number
466
+ * description: Indicate the position of the connection in the IdP selection screen
467
+ * forceAuthn:
468
+ * type: boolean
469
+ * description: Require a new authentication instead of reusing an existing session.
470
+ * required: true
306
471
  * responses:
307
- * 204:
472
+ * "204":
308
473
  * description: Success
309
- * 400:
310
- * $ref: '#/definitions/validationErrorsPatch'
311
- * 401:
474
+ * content: {}
475
+ * "400":
476
+ * $ref: "#/components/schemas/validationErrorsPatch"
477
+ * "401":
312
478
  * description: Unauthorized
313
- * 500:
479
+ * content: {}
480
+ * "500":
314
481
  * description: Please set OpenID response handler path (oidcPath) on Jackson
482
+ * content: {}
315
483
  */
316
484
  updateSAMLConnection(body: UpdateSAMLConnectionParams): Promise<void>;
317
485
  updateConfig(...args: Parameters<ConnectionAPIController['updateSAMLConnection']>): Promise<void>;
318
486
  updateOIDCConnection(body: UpdateOIDCConnectionParams): Promise<void>;
319
487
  getIDPEntityID(body: GetIDPEntityIDBody): string;
320
488
  /**
321
- * @swagger
322
- * parameters:
323
- * tenantParamGet:
324
- * in: query
325
- * name: tenant
326
- * type: string
327
- * description: Tenant (Optional if clientID provided)
328
- * productParamGet:
329
- * in: query
330
- * name: product
331
- * type: string
332
- * description: Product (Optional if clientID provided)
333
- * clientIDParamGet:
334
- * in: query
335
- * name: clientID
336
- * type: string
337
- * description: Client ID (Optional if tenant/product provided)
338
- * strategyParamGet:
339
- * in: query
340
- * name: strategy
341
- * type: string
342
- * description: Strategy which can help to filter connections with tenant/product query
343
- * sortParamGet:
344
- * in: query
345
- * name: sort
346
- * type: string
347
- * description: If present, the connections will be sorted by `sortOrder`. It won't consider if pagination is used.
348
- * definitions:
349
- * Connection:
350
- * type: object
351
- * properties:
352
- * clientID:
353
- * type: string
354
- * description: Connection clientID
355
- * clientSecret:
356
- * type: string
357
- * description: Connection clientSecret
358
- * name:
359
- * type: string
360
- * description: Connection name
361
- * label:
362
- * type: string
363
- * description: Connection label
364
- * description:
365
- * type: string
366
- * description: Connection description
367
- * redirectUrl:
368
- * type: string
369
- * description: A list of allowed redirect URLs
370
- * defaultRedirectUrl:
371
- * type: string
372
- * description: The redirect URL to use in the IdP login flow
373
- * tenant:
374
- * type: string
375
- * description: Connection tenant
376
- * product:
377
- * type: string
378
- * description: Connection product
379
- * idpMetadata:
380
- * type: object
381
- * description: SAML IdP metadata
382
- * oidcProvider:
383
- * type: object
384
- * description: OIDC IdP metadata
385
- * deactivated:
386
- * type: boolean
387
- * description: Connection status
388
- * sortOrder:
389
- * type: number
390
- * description: Connection sort order
391
- * responses:
392
- * '200Get':
393
- * description: Success
394
- * schema:
395
- * type: array
396
- * items:
397
- * $ref: '#/definitions/Connection'
398
- * '400Get':
399
- * description: Please provide `clientID` or `tenant` and `product`.
400
- * '401Get':
401
- * description: Unauthorized
489
+ * @openapi
402
490
  * /api/v1/sso:
403
491
  * get:
492
+ * tags:
493
+ * - Single Sign-On
404
494
  * summary: Get SSO Connections
405
- * parameters:
406
- * - $ref: '#/parameters/tenantParamGet'
407
- * - $ref: '#/parameters/productParamGet'
408
- * - $ref: '#/parameters/clientIDParamGet'
409
- * - $ref: '#/parameters/strategyParamGet'
410
- * - $ref: '#/parameters/sortParamGet'
411
495
  * operationId: get-connections
412
- * tags: [Single Sign-On]
496
+ * parameters:
497
+ * - name: tenant
498
+ * in: query
499
+ * description: Tenant
500
+ * required: true
501
+ * schema:
502
+ * type: string
503
+ * - name: product
504
+ * in: query
505
+ * description: Product
506
+ * required: true
507
+ * schema:
508
+ * type: string
509
+ * - name: clientID
510
+ * in: query
511
+ * description: Client ID (Optional if tenant/product provided)
512
+ * schema:
513
+ * type: string
514
+ * - name: strategy
515
+ * in: query
516
+ * description: Strategy which can help to filter connections with tenant/product query
517
+ * schema:
518
+ * type: string
519
+ * - name: sort
520
+ * in: query
521
+ * description: If present, the connections will be sorted by `sortOrder`. It won't consider if pagination is used.
522
+ * schema:
523
+ * type: string
413
524
  * responses:
414
525
  * '200':
415
- * $ref: '#/responses/200Get'
526
+ * $ref: '#/components/responses/200Get'
416
527
  * '400':
417
- * $ref: '#/responses/400Get'
528
+ * $ref: '#/components/responses/400Get'
418
529
  * '401':
419
- * $ref: '#/responses/401Get'
530
+ * $ref: '#/components/responses/401Get'
420
531
  */
421
532
  getConnections(body: GetConnectionsQuery): Promise<Array<SAMLSSORecord | OIDCSSORecord>>;
422
533
  getConfig(body: GetConfigQuery): Promise<SAMLSSORecord | Record<string, never>>;
423
534
  /**
424
- * @swagger
425
- * parameters:
426
- * clientIDDel:
427
- * name: clientID
428
- * in: query
429
- * type: string
430
- * description: Client ID (Optional if tenant/product provided)
431
- * clientSecretDel:
432
- * name: clientSecret
433
- * in: query
434
- * type: string
435
- * description: Client Secret (Optional if tenant/product provided)
436
- * tenantDel:
437
- * name: tenant
438
- * in: query
439
- * type: string
440
- * description: Tenant (Optional if clientID/Secret provided)
441
- * productDel:
442
- * name: product
443
- * in: query
444
- * type: string
445
- * description: Product (Optional if clientID/Secret provided)
446
- * strategyDel:
447
- * name: strategy
448
- * in: query
449
- * type: string
450
- * description: Strategy which can help to filter connections with tenant/product query
535
+ * @openapi
451
536
  * /api/v1/sso:
452
537
  * delete:
453
- * parameters:
454
- * - $ref: '#/parameters/clientIDDel'
455
- * - $ref: '#/parameters/clientSecretDel'
456
- * - $ref: '#/parameters/tenantDel'
457
- * - $ref: '#/parameters/productDel'
458
- * - $ref: '#/parameters/strategyDel'
538
+ * tags:
539
+ * - Single Sign-On
459
540
  * summary: Delete SSO Connections
460
541
  * operationId: delete-sso-connection
461
- * tags: [Single Sign-On]
542
+ * parameters:
543
+ * - name: clientID
544
+ * in: query
545
+ * description: Client ID (Optional if tenant/product provided)
546
+ * schema:
547
+ * type: string
548
+ * - name: clientSecret
549
+ * in: query
550
+ * description: Client Secret (Optional if tenant/product provided)
551
+ * schema:
552
+ * type: string
553
+ * - name: tenant
554
+ * in: query
555
+ * description: Tenant (Optional if clientID/Secret provided)
556
+ * schema:
557
+ * type: string
558
+ * - name: product
559
+ * in: query
560
+ * description: Product (Optional if clientID/Secret provided)
561
+ * schema:
562
+ * type: string
563
+ * - name: strategy
564
+ * in: query
565
+ * description: Strategy which can help to filter connections with tenant/product query
566
+ * schema:
567
+ * type: string
462
568
  * responses:
463
569
  * '200':
464
570
  * description: Success
@@ -470,84 +576,25 @@ export declare class ConnectionAPIController implements IConnectionAPIController
470
576
  deleteConnections(body: DelConnectionsQuery): Promise<void>;
471
577
  deleteConfig(body: DelConnectionsQuery): Promise<void>;
472
578
  /**
473
- * @swagger
474
- * parameters:
475
- * productParamGet:
476
- * in: query
477
- * name: product
478
- * type: string
479
- * description: Product
480
- * required: true
481
- * definitions:
482
- * Connection:
483
- * type: object
484
- * properties:
485
- * clientID:
486
- * type: string
487
- * description: Connection clientID
488
- * clientSecret:
489
- * type: string
490
- * description: Connection clientSecret
491
- * name:
492
- * type: string
493
- * description: Connection name
494
- * description:
495
- * type: string
496
- * description: Connection description
497
- * redirectUrl:
498
- * type: string
499
- * description: A list of allowed redirect URLs
500
- * defaultRedirectUrl:
501
- * type: string
502
- * description: The redirect URL to use in the IdP login flow
503
- * tenant:
504
- * type: string
505
- * description: Connection tenant
506
- * product:
507
- * type: string
508
- * description: Connection product
509
- * idpMetadata:
510
- * type: object
511
- * description: SAML IdP metadata
512
- * oidcProvider:
513
- * type: object
514
- * description: OIDC IdP metadata
515
- * responses:
516
- * '200GetByProduct':
517
- * description: Success
518
- * content:
519
- * application/json:
520
- * schema:
521
- * type: object
522
- * properties:
523
- * data:
524
- * type: array
525
- * items:
526
- * $ref: '#/definitions/Connection'
527
- * pageToken:
528
- * type: string
529
- * description: token for pagination
530
- * '400Get':
531
- * description: Please provide a `product`.
532
- * '401Get':
533
- * description: Unauthorized
579
+ * @openapi
534
580
  * /api/v1/sso/product:
535
581
  * get:
582
+ * tags:
583
+ * - Single Sign-On
536
584
  * summary: Get SSO Connections by product
537
- * parameters:
538
- * - $ref: '#/parameters/productParamGet'
539
- * - $ref: '#/parameters/pageOffset'
540
- * - $ref: '#/parameters/pageLimit'
541
- * - $ref: '#/parameters/pageToken'
542
585
  * operationId: get-connections-by-product
543
- * tags: [Single Sign-On]
586
+ * parameters:
587
+ * - $ref: '#/components/parameters/productParamGet'
588
+ * - $ref: '#/components/parameters/pageOffset'
589
+ * - $ref: '#/components/parameters/pageLimit'
590
+ * - $ref: '#/components/parameters/pageToken'
544
591
  * responses:
545
592
  * '200':
546
- * $ref: '#/responses/200GetByProduct'
593
+ * $ref: '#/components/responses/200GetByProduct'
547
594
  * '400':
548
- * $ref: '#/responses/400Get'
595
+ * $ref: '#/components/responses/400Get'
549
596
  * '401':
550
- * $ref: '#/responses/401Get'
597
+ * $ref: '#/components/responses/401Get'
551
598
  */
552
599
  getConnectionsByProduct(body: GetByProductParams): Promise<{
553
600
  data: (SAMLSSORecord | OIDCSSORecord)[];