@boxyhq/saml-jackson 1.2.1 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/dist/controller/admin.d.ts +4 -4
  2. package/dist/controller/admin.js +6 -6
  3. package/dist/controller/api.d.ts +448 -204
  4. package/dist/controller/api.js +547 -376
  5. package/dist/controller/connection/oidc.d.ts +18 -0
  6. package/dist/controller/connection/oidc.js +145 -0
  7. package/dist/controller/connection/saml.d.ts +14 -0
  8. package/dist/controller/connection/saml.js +168 -0
  9. package/dist/controller/logout.d.ts +3 -3
  10. package/dist/controller/logout.js +14 -14
  11. package/dist/controller/oauth.d.ts +26 -8
  12. package/dist/controller/oauth.js +368 -118
  13. package/dist/controller/utils.d.ts +10 -2
  14. package/dist/controller/utils.js +88 -1
  15. package/dist/directory-sync/DirectoryUsers.js +4 -0
  16. package/dist/index.d.ts +3 -2
  17. package/dist/index.js +26 -14
  18. package/dist/loadConnection.d.ts +3 -0
  19. package/dist/{read-config.js → loadConnection.js} +13 -12
  20. package/dist/opentelemetry/metrics.js +12 -12
  21. package/dist/saml/x509.d.ts +4 -4
  22. package/dist/saml/x509.js +38 -42
  23. package/dist/typings.d.ts +110 -34
  24. package/package.json +14 -14
  25. package/dist/read-config.d.ts +0 -3
package/dist/controller/api.d.ts CHANGED
@@ -1,266 +1,510 @@
1
- import { IAPIController, IdPConfig } from '../typings';
2
- export declare class APIController implements IAPIController {
3
- private configStore;
4
- constructor({ configStore }: {
5
- configStore: any;
1
+ import { GetConfigQuery, GetConnectionsQuery, DelConnectionsQuery, IConnectionAPIController, SAMLSSOConnectionWithEncodedMetadata, SAMLSSOConnectionWithRawMetadata, OIDCSSOConnection } from '../typings';
2
+ export declare class ConnectionAPIController implements IConnectionAPIController {
3
+ private connectionStore;
4
+ constructor({ connectionStore }: {
5
+ connectionStore: any;
6
6
  });
7
- private _validateRedirectUrl;
8
- private _validateIdPConfig;
9
7
  /**
10
8
  * @swagger
9
+ * definitions:
10
+ * Connection:
11
+ * type: object
12
+ * example:
13
+ * {
14
+ * "idpMetadata": {
15
+ * "sso": {
16
+ * "postUrl": "https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxsso/saml",
17
+ * "redirectUrl": "https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxsso/saml"
18
+ * },
19
+ * "entityID": "http://www.okta.com/xxxxxxxxxxxxx",
20
+ * "thumbprint": "Eo+eUi3UM3XIMkFFtdVK3yJ5vO9f7YZdasdasdad",
21
+ * "loginType": "idp",
22
+ * "provider": "okta.com"
23
+ * },
24
+ * "defaultRedirectUrl": "https://hoppscotch.io/",
25
+ * "redirectUrl": ["https://hoppscotch.io/"],
26
+ * "tenant": "hoppscotch.io",
27
+ * "product": "API Engine",
28
+ * "name": "Hoppscotch-SP",
29
+ * "description": "SP for hoppscotch.io",
30
+ * "clientID": "Xq8AJt3yYAxmXizsCWmUBDRiVP1iTC8Y/otnvFIMitk",
31
+ * "clientSecret": "00e3e11a3426f97d8000000738300009130cd45419c5943",
32
+ * "certs": {
33
+ * "publicKey": "-----BEGIN CERTIFICATE-----.......-----END CERTIFICATE-----",
34
+ * "privateKey": "-----BEGIN PRIVATE KEY-----......-----END PRIVATE KEY-----"
35
+ * }
36
+ * }
37
+ * validationErrorsPost:
38
+ * 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
11
39
  *
40
+ * parameters:
41
+ * nameParamPost:
42
+ * name: name
43
+ * description: Name/identifier for the connection
44
+ * type: string
45
+ * in: formData
46
+ * descriptionParamPost:
47
+ * name: description
48
+ * description: A short description for the connection not more than 100 characters
49
+ * type: string
50
+ * in: formData
51
+ * encodedRawMetadataParamPost:
52
+ * name: encodedRawMetadata
53
+ * description: Base64 encoding of the XML metadata
54
+ * in: formData
55
+ * type: string
56
+ * rawMetadataParamPost:
57
+ * name: rawMetadata
58
+ * description: Raw XML metadata
59
+ * in: formData
60
+ * type: string
61
+ * defaultRedirectUrlParamPost:
62
+ * name: defaultRedirectUrl
63
+ * description: The redirect URL to use in the IdP login flow
64
+ * in: formData
65
+ * required: true
66
+ * type: string
67
+ * redirectUrlParamPost:
68
+ * name: redirectUrl
69
+ * description: JSON encoded array containing a list of allowed redirect URLs
70
+ * in: formData
71
+ * required: true
72
+ * type: string
73
+ * tenantParamPost:
74
+ * name: tenant
75
+ * description: Tenant
76
+ * in: formData
77
+ * required: true
78
+ * type: string
79
+ * productParamPost:
80
+ * name: product
81
+ * description: Product
82
+ * in: formData
83
+ * required: true
84
+ * type: string
85
+ * oidcDiscoveryUrlPost:
86
+ * name: oidcDiscoveryUrl
87
+ * description: well-known URL where the OpenID Provider configuration is exposed
88
+ * in: formData
89
+ * type: string
90
+ * oidcClientIdPost:
91
+ * name: oidcClientId
92
+ * description: clientId of the application set up on the OpenID Provider
93
+ * in: formData
94
+ * type: string
95
+ * oidcClientSecretPost:
96
+ * name: oidcClientSecret
97
+ * description: clientSecret of the application set up on the OpenID Provider
98
+ * in: formData
99
+ * type: string
12
100
  * /api/v1/saml/config:
13
101
  * post:
14
- * summary: Create SAML configuration
15
- * operationId: create-saml-config
16
- * tags: [SAML Config]
102
+ * summary: Create SAML config
103
+ * operationId: create-saml-config
104
+ * deprecated: true
105
+ * tags: [SAML Config - Deprecated]
106
+ * produces:
107
+ * - application/json
108
+ * consumes:
109
+ * - application/x-www-form-urlencoded
110
+ * - application/json
111
+ * parameters:
112
+ * - $ref: '#/parameters/nameParamPost'
113
+ * - $ref: '#/parameters/descriptionParamPost'
114
+ * - $ref: '#/parameters/encodedRawMetadataParamPost'
115
+ * - $ref: '#/parameters/rawMetadataParamPost'
116
+ * - $ref: '#/parameters/defaultRedirectUrlParamPost'
117
+ * - $ref: '#/parameters/redirectUrlParamPost'
118
+ * - $ref: '#/parameters/tenantParamPost'
119
+ * - $ref: '#/parameters/productParamPost'
120
+ * responses:
121
+ * 200:
122
+ * description: Success
123
+ * schema:
124
+ * $ref: '#/definitions/Connection'
125
+ * 400:
126
+ * $ref: '#/definitions/validationErrorsPost'
127
+ * 401:
128
+ * description: Unauthorized
129
+ * /api/v1/connections:
130
+ * post:
131
+ * summary: Create SSO connection
132
+ * operationId: create-sso-connection
133
+ * tags: [Connections]
17
134
  * produces:
18
- * - application/json
135
+ * - application/json
19
136
  * consumes:
20
- * - application/x-www-form-urlencoded
137
+ * - application/x-www-form-urlencoded
138
+ * - application/json
21
139
  * parameters:
22
- * - name: name
23
- * description: Name/identifier for the config
24
- * type: string
25
- * in: formData
26
- * - name: description
27
- * description: A short description for the config not more than 100 characters
28
- * type: string
29
- * in: formData
30
- * - name: encodedRawMetadata
31
- * description: Base64 encoding of the XML metadata
32
- * in: formData
33
- * type: string
34
- * - name: rawMetadata
35
- * description: Raw XML metadata
36
- * in: formData
37
- * type: string
38
- * - name: defaultRedirectUrl
39
- * description: The redirect URL to use in the IdP login flow
40
- * in: formData
41
- * required: true
42
- * type: string
43
- * - name: redirectUrl
44
- * description: JSON encoded array containing a list of allowed redirect URLs
45
- * in: formData
46
- * required: true
47
- * type: string
48
- * - name: tenant
49
- * description: Tenant
50
- * in: formData
51
- * required: true
52
- * type: string
53
- * - name: product
54
- * description: Product
55
- * in: formData
56
- * required: true
57
- * type: string
140
+ * - $ref: '#/parameters/nameParamPost'
141
+ * - $ref: '#/parameters/descriptionParamPost'
142
+ * - $ref: '#/parameters/encodedRawMetadataParamPost'
143
+ * - $ref: '#/parameters/rawMetadataParamPost'
144
+ * - $ref: '#/parameters/defaultRedirectUrlParamPost'
145
+ * - $ref: '#/parameters/redirectUrlParamPost'
146
+ * - $ref: '#/parameters/tenantParamPost'
147
+ * - $ref: '#/parameters/productParamPost'
148
+ * - $ref: '#/parameters/oidcDiscoveryUrlPost'
149
+ * - $ref: '#/parameters/oidcClientIdPost'
150
+ * - $ref: '#/parameters/oidcClientSecretPost'
58
151
  * responses:
59
152
  * 200:
60
153
  * description: Success
61
154
  * schema:
62
- * type: object
63
- * example:
64
- * {
65
- * "idpMetadata": {
66
- * "sso": {
67
- * "postUrl": "https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxxx/sso/saml",
68
- * "redirectUrl": "https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxxx/sso/saml"
69
- * },
70
- * "entityID": "http://www.okta.com/xxxxxxxxxxxxx",
71
- * "thumbprint": "Eo+eUi3UM3XIMkFFtdVK3yJ5vO9f7YZdasdasdad",
72
- * "loginType": "idp",
73
- * "provider": "okta.com"
74
- * },
75
- * "defaultRedirectUrl": "https://hoppscotch.io/",
76
- * "redirectUrl": ["https://hoppscotch.io/"],
77
- * "tenant": "hoppscotch.io",
78
- * "product": "API Engine",
79
- * "name": "Hoppscotch-SP",
80
- * "description": "SP for hoppscotch.io",
81
- * "clientID": "Xq8AJt3yYAxmXizsCWmUBDRiVP1iTC8Y/otnvFIMitk",
82
- * "clientSecret": "00e3e11a3426f97d8000000738300009130cd45419c5943",
83
- * "certs": {
84
- * "publicKey": "-----BEGIN CERTIFICATE-----.......-----END CERTIFICATE-----",
85
- * "privateKey": "-----BEGIN PRIVATE KEY-----......-----END PRIVATE KEY-----"
86
- * }
87
- * }
155
+ * $ref: '#/definitions/Connection'
88
156
  * 400:
89
- * description: Please provide rawMetadata or encodedRawMetadata | Please provide a defaultRedirectUrl | Please provide redirectUrl | Please provide tenant | Please provide product | Please provide a friendly name | Description should not exceed 100 characters
157
+ * $ref: '#/definitions/validationErrorsPost'
90
158
  * 401:
91
159
  * description: Unauthorized
92
160
  */
93
- config(body: IdPConfig): Promise<any>;
161
+ createSAMLConnection(body: SAMLSSOConnectionWithEncodedMetadata | SAMLSSOConnectionWithRawMetadata): Promise<any>;
162
+ config(...args: Parameters<ConnectionAPIController['createSAMLConnection']>): Promise<any>;
163
+ createOIDCConnection(body: OIDCSSOConnection): Promise<any>;
94
164
  /**
95
165
  * @swagger
96
- *
166
+ * definitions:
167
+ * validationErrorsPatch:
168
+ * 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
169
+ * parameters:
170
+ * clientIDParamPatch:
171
+ * name: clientID
172
+ * description: Client ID for the connection
173
+ * type: string
174
+ * in: formData
175
+ * required: true
176
+ * clientSecretParamPatch:
177
+ * name: clientSecret
178
+ * description: Client Secret for the connection
179
+ * type: string
180
+ * in: formData
181
+ * required: true
182
+ * nameParamPatch:
183
+ * name: name
184
+ * description: Name/identifier for the connection
185
+ * type: string
186
+ * in: formData
187
+ * descriptionParamPatch:
188
+ * name: description
189
+ * description: A short description for the connection not more than 100 characters
190
+ * type: string
191
+ * in: formData
192
+ * encodedRawMetadataParamPatch:
193
+ * name: encodedRawMetadata
194
+ * description: Base64 encoding of the XML metadata
195
+ * in: formData
196
+ * type: string
197
+ * rawMetadataParamPatch:
198
+ * name: rawMetadata
199
+ * description: Raw XML metadata
200
+ * in: formData
201
+ * type: string
202
+ * oidcDiscoveryUrlPatch:
203
+ * name: oidcDiscoveryUrl
204
+ * description: well-known URL where the OpenID Provider configuration is exposed
205
+ * in: formData
206
+ * type: string
207
+ * oidcClientIdPatch:
208
+ * name: oidcClientId
209
+ * description: clientId of the application set up on the OpenID Provider
210
+ * in: formData
211
+ * type: string
212
+ * oidcClientSecretPatch:
213
+ * name: oidcClientSecret
214
+ * description: clientSecret of the application set up on the OpenID Provider
215
+ * in: formData
216
+ * type: string
217
+ * defaultRedirectUrlParamPatch:
218
+ * name: defaultRedirectUrl
219
+ * description: The redirect URL to use in the IdP login flow
220
+ * in: formData
221
+ * type: string
222
+ * redirectUrlParamPatch:
223
+ * name: redirectUrl
224
+ * description: JSON encoded array containing a list of allowed redirect URLs
225
+ * in: formData
226
+ * type: string
227
+ * tenantParamPatch:
228
+ * name: tenant
229
+ * description: Tenant
230
+ * in: formData
231
+ * required: true
232
+ * type: string
233
+ * productParamPatch:
234
+ * name: product
235
+ * description: Product
236
+ * in: formData
237
+ * required: true
238
+ * type: string
97
239
  * /api/v1/saml/config:
98
240
  * patch:
99
- * summary: Update SAML configuration
241
+ * summary: Update SAML Config
100
242
  * operationId: update-saml-config
101
- * tags: [SAML Config]
243
+ * tags: [SAML Config - Deprecated]
244
+ * deprecated: true
245
+ * consumes:
246
+ * - application/json
247
+ * - application/x-www-form-urlencoded
248
+ * parameters:
249
+ * - $ref: '#/parameters/clientIDParamPatch'
250
+ * - $ref: '#/parameters/clientSecretParamPatch'
251
+ * - $ref: '#/parameters/nameParamPatch'
252
+ * - $ref: '#/parameters/descriptionParamPatch'
253
+ * - $ref: '#/parameters/encodedRawMetadataParamPatch'
254
+ * - $ref: '#/parameters/rawMetadataParamPatch'
255
+ * - $ref: '#/parameters/defaultRedirectUrlParamPatch'
256
+ * - $ref: '#/parameters/redirectUrlParamPatch'
257
+ * - $ref: '#/parameters/tenantParamPatch'
258
+ * - $ref: '#/parameters/productParamPatch'
259
+ * responses:
260
+ * 204:
261
+ * description: Success
262
+ * 400:
263
+ * $ref: '#/definitions/validationErrorsPatch'
264
+ * 401:
265
+ * description: Unauthorized
266
+ * /api/v1/connections:
267
+ * patch:
268
+ * summary: Update SSO Connection
269
+ * operationId: update-sso-connection
270
+ * tags: [Connections]
102
271
  * consumes:
103
272
  * - application/json
104
273
  * - application/x-www-form-urlencoded
105
274
  * parameters:
106
- * - name: clientID
107
- * description: Client ID for the config
108
- * type: string
109
- * in: formData
110
- * required: true
111
- * - name: clientSecret
112
- * description: Client Secret for the config
113
- * type: string
114
- * in: formData
115
- * required: true
116
- * - name: name
117
- * description: Name/identifier for the config
118
- * type: string
119
- * in: formData
120
- * - name: description
121
- * description: A short description for the config not more than 100 characters
122
- * type: string
123
- * in: formData
124
- * - name: encodedRawMetadata
125
- * description: Base64 encoding of the XML metadata
126
- * in: formData
127
- * type: string
128
- * - name: rawMetadata
129
- * description: Raw XML metadata
130
- * in: formData
131
- * type: string
132
- * - name: defaultRedirectUrl
133
- * description: The redirect URL to use in the IdP login flow
134
- * in: formData
135
- * required: true
136
- * type: string
137
- * - name: redirectUrl
138
- * description: JSON encoded array containing a list of allowed redirect URLs
139
- * in: formData
140
- * required: true
141
- * type: string
142
- * - name: tenant
143
- * description: Tenant
144
- * in: formData
145
- * required: true
146
- * type: string
147
- * - name: product
148
- * description: Product
149
- * in: formData
150
- * required: true
151
- * type: string
275
+ * - $ref: '#/parameters/clientIDParamPatch'
276
+ * - $ref: '#/parameters/clientSecretParamPatch'
277
+ * - $ref: '#/parameters/nameParamPatch'
278
+ * - $ref: '#/parameters/descriptionParamPatch'
279
+ * - $ref: '#/parameters/encodedRawMetadataParamPatch'
280
+ * - $ref: '#/parameters/rawMetadataParamPatch'
281
+ * - $ref: '#/parameters/oidcDiscoveryUrlPatch'
282
+ * - $ref: '#/parameters/oidcClientIdPatch'
283
+ * - $ref: '#/parameters/oidcClientSecretPatch'
284
+ * - $ref: '#/parameters/defaultRedirectUrlParamPatch'
285
+ * - $ref: '#/parameters/redirectUrlParamPatch'
286
+ * - $ref: '#/parameters/tenantParamPatch'
287
+ * - $ref: '#/parameters/productParamPatch'
152
288
  * responses:
153
289
  * 204:
154
290
  * description: Success
155
291
  * 400:
156
- * description: Please provide clientID | Please provide clientSecret | clientSecret mismatch | Tenant/Product config mismatch with IdP metadata | Description should not exceed 100 characters
292
+ * $ref: '#/definitions/validationErrorsPatch'
157
293
  * 401:
158
294
  * description: Unauthorized
159
295
  */
160
- updateConfig(body: any): Promise<void>;
296
+ updateSAMLConnection(body: (SAMLSSOConnectionWithEncodedMetadata | SAMLSSOConnectionWithRawMetadata) & {
297
+ clientID: string;
298
+ clientSecret: string;
299
+ }): Promise<void>;
300
+ updateConfig(...args: Parameters<ConnectionAPIController['updateSAMLConnection']>): Promise<any>;
301
+ updateOIDCConnection(body: OIDCSSOConnection & {
302
+ clientID: string;
303
+ clientSecret: string;
304
+ }): Promise<void>;
305
+ /**
306
+ * @swagger
307
+ * parameters:
308
+ * tenantParamGet:
309
+ * in: query
310
+ * name: tenant
311
+ * type: string
312
+ * description: Tenant
313
+ * productParamGet:
314
+ * in: query
315
+ * name: product
316
+ * type: string
317
+ * description: Product
318
+ * clientIDParamGet:
319
+ * in: query
320
+ * name: clientID
321
+ * type: string
322
+ * description: Client ID
323
+ * definitions:
324
+ * Connection:
325
+ * type: object
326
+ * properties:
327
+ * clientID:
328
+ * type: string
329
+ * description: Connection clientID
330
+ * clientSecret:
331
+ * type: string
332
+ * description: Connection clientSecret
333
+ * name:
334
+ * type: string
335
+ * description: Connection name
336
+ * description:
337
+ * type: string
338
+ * description: Connection description
339
+ * redirectUrl:
340
+ * type: string
341
+ * description: A list of allowed redirect URLs
342
+ * defaultRedirectUrl:
343
+ * type: string
344
+ * description: The redirect URL to use in the IdP login flow
345
+ * tenant:
346
+ * type: string
347
+ * description: Connection tenant
348
+ * product:
349
+ * type: string
350
+ * description: Connection product
351
+ * idpMetadata:
352
+ * type: object
353
+ * description: SAML IdP metadata
354
+ * certs:
355
+ * type: object
356
+ * description: Certs generated for SAML connection
357
+ * oidcProvider:
358
+ * type: object
359
+ * description: OIDC IdP metadata
360
+ * responses:
361
+ * '200Get':
362
+ * description: Success
363
+ * schema:
364
+ * type: array
365
+ * items:
366
+ * $ref: '#/definitions/Connection'
367
+ * '400Get':
368
+ * description: Please provide `clientID` or `tenant` and `product`.
369
+ * '401Get':
370
+ * description: Unauthorized
371
+ * /api/v1/connections:
372
+ * get:
373
+ * summary: Get SSO Connections
374
+ * parameters:
375
+ * - $ref: '#/parameters/tenantParamGet'
376
+ * - $ref: '#/parameters/productParamGet'
377
+ * - $ref: '#/parameters/clientIDParamGet'
378
+ * operationId: get-connections
379
+ * tags: [Connections]
380
+ * responses:
381
+ * '200':
382
+ * $ref: '#/responses/200Get'
383
+ * '400':
384
+ * $ref: '#/responses/400Get'
385
+ * '401':
386
+ * $ref: '#/responses/401Get'
387
+ */
388
+ getConnections(body: GetConnectionsQuery): Promise<Array<any>>;
161
389
  /**
162
390
  * @swagger
163
- *
164
391
  * /api/v1/saml/config:
165
392
  * get:
166
- * summary: Get SAML configuration
393
+ * summary: Get SAML Config
167
394
  * operationId: get-saml-config
168
- * tags:
169
- * - SAML Config
395
+ * tags: [SAML Config - Deprecated]
396
+ * deprecated: true
170
397
  * parameters:
171
- * - in: query
172
- * name: tenant
173
- * type: string
174
- * description: Tenant
175
- * - in: query
176
- * name: product
177
- * type: string
178
- * description: Product
179
- * - in: query
180
- * name: clientID
181
- * type: string
182
- * description: Client ID
398
+ * - $ref: '#/parameters/tenantParamGet'
399
+ * - $ref: '#/parameters/productParamGet'
400
+ * - $ref: '#/parameters/clientIDParamGet'
183
401
  * responses:
184
- * '200':
402
+ * '200':
185
403
  * description: Success
186
404
  * schema:
187
405
  * type: object
188
406
  * example:
189
407
  * {
190
- * "idpMetadata": {
191
- * "sso": {
192
- * "postUrl": "https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxxx/sso/saml",
193
- * "redirectUrl": "https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxxx/sso/saml"
194
- * },
195
- * "entityID": "http://www.okta.com/xxxxxxxxxxxxx",
196
- * "thumbprint": "Eo+eUi3UM3XIMkFFtdVK3yJ5vO9f7YZdasdasdad",
197
- * "loginType": "idp",
198
- * "provider": "okta.com"
199
- * },
200
- * "defaultRedirectUrl": "https://hoppscotch.io/",
201
- * "redirectUrl": ["https://hoppscotch.io/"],
202
- * "tenant": "hoppscotch.io",
203
- * "product": "API Engine",
204
- * "name": "Hoppscotch-SP",
205
- * "description": "SP for hoppscotch.io",
206
- * "clientID": "Xq8AJt3yYAxmXizsCWmUBDRiVP1iTC8Y/otnvFIMitk",
207
- * "clientSecret": "00e3e11a3426f97d8000000738300009130cd45419c5943",
208
- * "certs": {
209
- * "publicKey": "-----BEGIN CERTIFICATE-----.......-----END CERTIFICATE-----",
210
- * "privateKey": "-----BEGIN PRIVATE KEY-----......-----END PRIVATE KEY-----"
211
- * }
212
- * }
213
- * '400':
214
- * description: Please provide `clientID` or `tenant` and `product`.
215
- * '401':
216
- * description: Unauthorized
408
+ * "idpMetadata": {
409
+ * "sso": {
410
+ * "postUrl": "https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxxx/sso/saml",
411
+ * "redirectUrl": "https://dev-20901260.okta.com/app/dev-20901260_jacksonnext_1/xxxxxxxxxxxxx/sso/saml"
412
+ * },
413
+ * "entityID": "http://www.okta.com/xxxxxxxxxxxxx",
414
+ * "thumbprint": "Eo+eUi3UM3XIMkFFtdVK3yJ5vO9f7YZdasdasdad",
415
+ * "loginType": "idp",
416
+ * "provider": "okta.com"
417
+ * },
418
+ * "defaultRedirectUrl": "https://hoppscotch.io/",
419
+ * "redirectUrl": ["https://hoppscotch.io/"],
420
+ * "tenant": "hoppscotch.io",
421
+ * "product": "API Engine",
422
+ * "name": "Hoppscotch-SP",
423
+ * "description": "SP for hoppscotch.io",
424
+ * "clientID": "Xq8AJt3yYAxmXizsCWmUBDRiVP1iTC8Y/otnvFIMitk",
425
+ * "clientSecret": "00e3e11a3426f97d8000000738300009130cd45419c5943",
426
+ * "certs": {
427
+ * "publicKey": "-----BEGIN CERTIFICATE-----.......-----END CERTIFICATE-----",
428
+ * "privateKey": "-----BEGIN PRIVATE KEY-----......-----END PRIVATE KEY-----"
429
+ * }
430
+ * }
431
+ * '400':
432
+ * $ref: '#/responses/400Get'
433
+ * '401':
434
+ * $ref: '#/responses/401Get'
217
435
  */
218
- getConfig(body: {
219
- clientID: string;
220
- tenant: string;
221
- product: string;
222
- }): Promise<any>;
436
+ getConfig(body: GetConfigQuery): Promise<any>;
223
437
  /**
224
438
  * @swagger
439
+ * parameters:
440
+ * clientIDDel:
441
+ * name: clientID
442
+ * in: formData
443
+ * type: string
444
+ * description: Client ID
445
+ * clientSecretDel:
446
+ * name: clientSecret
447
+ * in: formData
448
+ * type: string
449
+ * description: Client Secret
450
+ * tenantDel:
451
+ * name: tenant
452
+ * in: formData
453
+ * type: string
454
+ * description: Tenant
455
+ * productDel:
456
+ * name: product
457
+ * in: formData
458
+ * type: string
459
+ * description: Product
460
+ * strategyDel:
461
+ * name: strategy
462
+ * in: formData
463
+ * type: string
464
+ * description: Strategy
465
+ * /api/v1/connections:
466
+ * delete:
467
+ * parameters:
468
+ * - $ref: '#/parameters/clientIDDel'
469
+ * - $ref: '#/parameters/clientSecretDel'
470
+ * - $ref: '#/parameters/tenantDel'
471
+ * - $ref: '#/parameters/productDel'
472
+ * - $ref: '#/parameters/strategyDel'
473
+ * summary: Delete SSO Connections
474
+ * operationId: delete-sso-connection
475
+ * tags: [Connections]
476
+ * consumes:
477
+ * - application/x-www-form-urlencoded
478
+ * - application/json
479
+ * responses:
480
+ * '200':
481
+ * description: Success
482
+ * '400':
483
+ * description: clientSecret mismatch | Please provide `clientID` and `clientSecret` or `tenant` and `product`.
484
+ * '401':
485
+ * description: Unauthorized
225
486
  * /api/v1/saml/config:
226
487
  * delete:
227
- * summary: Delete SAML configuration
488
+ * summary: Delete SAML Config
228
489
  * operationId: delete-saml-config
229
- * tags:
230
- * - SAML Config
490
+ * tags: [SAML Config - Deprecated]
491
+ * deprecated: true
231
492
  * consumes:
232
493
  * - application/x-www-form-urlencoded
494
+ * - application/json
233
495
  * parameters:
234
- * - name: clientID
235
- * in: formData
236
- * type: string
237
- * required: true
238
- * description: Client ID
239
- * - name: clientSecret
240
- * in: formData
241
- * type: string
242
- * required: true
243
- * description: Client Secret
244
- * - name: tenant
245
- * in: formData
246
- * type: string
247
- * description: Tenant
248
- * - name: product
249
- * in: formData
250
- * type: string
251
- * description: Product
496
+ * - $ref: '#/parameters/clientIDDel'
497
+ * - $ref: '#/parameters/clientSecretDel'
498
+ * - $ref: '#/parameters/tenantDel'
499
+ * - $ref: '#/parameters/productDel'
252
500
  * responses:
253
501
  * '200':
254
502
  * description: Success
255
503
  * '400':
256
- * description: clientSecret mismatch | Please provide `clientID` and `clientSecret` or `tenant` and `product`.'
504
+ * description: clientSecret mismatch | Please provide `clientID` and `clientSecret` or `tenant` and `product`.
257
505
  * '401':
258
506
  * description: Unauthorized
259
507
  */
260
- deleteConfig(body: {
261
- clientID: string;
262
- clientSecret: string;
263
- tenant: string;
264
- product: string;
265
- }): Promise<void>;
508
+ deleteConnections(body: DelConnectionsQuery): Promise<void>;
509
+ deleteConfig(body: DelConnectionsQuery): Promise<void>;
266
510
  }