@frontegg/rest-api 3.1.74-alpha.9437937621 → 3.1.74
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.
- package/ContextHolder/index.d.ts +27 -108
- package/ContextHolder/index.js +50 -155
- package/account-settings/index.d.ts +7 -19
- package/account-settings/index.js +13 -23
- package/applications/index.d.ts +44 -49
- package/applications/index.js +37 -51
- package/audits/index.d.ts +15 -27
- package/audits/index.js +17 -27
- package/auth/index.d.ts +768 -817
- package/auth/index.js +721 -902
- package/auth/secutiry-poilicy/index.d.ts +102 -58
- package/auth/secutiry-poilicy/index.js +90 -122
- package/auth/utils.d.ts +2 -2
- package/auth/utils.js +8 -9
- package/connectivity/index.d.ts +26 -125
- package/connectivity/index.js +114 -147
- package/directory/index.d.ts +22 -31
- package/directory/index.js +15 -27
- package/entitlements/index.d.ts +8 -14
- package/entitlements/index.js +4 -12
- package/feature-flags/index.d.ts +2 -8
- package/feature-flags/index.js +8 -16
- package/fetch.d.ts +24 -0
- package/fetch.js +265 -0
- package/groups/index.d.ts +49 -73
- package/groups/index.js +45 -64
- package/impersonate/index.d.ts +6 -15
- package/impersonate/index.js +5 -13
- package/index.d.ts +108 -154
- package/index.js +78 -109
- package/interfaces.d.ts +0 -10
- package/metadata/index.d.ts +7 -67
- package/metadata/index.js +32 -52
- package/node/ContextHolder/index.js +50 -155
- package/node/account-settings/index.js +16 -27
- package/node/applications/index.js +44 -51
- package/node/audits/index.js +20 -31
- package/node/auth/index.js +1035 -768
- package/node/auth/secutiry-poilicy/index.js +136 -125
- package/node/auth/utils.js +7 -9
- package/node/connectivity/index.js +187 -148
- package/node/directory/index.js +20 -29
- package/node/entitlements/index.js +5 -18
- package/node/feature-flags/index.js +9 -21
- package/node/fetch.js +306 -0
- package/node/groups/index.js +63 -65
- package/node/impersonate/index.js +5 -18
- package/node/index.js +71 -116
- package/node/metadata/index.js +52 -61
- package/node/notifications/index.js +27 -37
- package/node/reports/index.js +70 -78
- package/node/roles/index.js +51 -56
- package/node/security-center/index.js +9 -21
- package/node/sub-tenants/index.js +89 -90
- package/node/subscriptions/index.js +107 -79
- package/node/subscriptions/invoices.js +17 -25
- package/node/subscriptions/managedSubscriptions.js +27 -32
- package/node/subscriptions/paymentMethods.js +20 -27
- package/node/subscriptions/paymentProviders.js +6 -15
- package/node/subscriptions/plans.js +9 -17
- package/node/subscriptions/providers/index.js +18 -0
- package/node/subscriptions/providers/stripe/index.js +21 -26
- package/node/subscriptions/subscriptions.js +27 -32
- package/node/subscriptions/summaries.js +6 -15
- package/node/subscriptions/tenantConfiguration.js +9 -17
- package/node/subscriptions/vendorPublicConfigurations.js +6 -15
- package/node/teams/index.js +138 -130
- package/node/tenants/index.js +60 -65
- package/node/user-phone-numbers/index.js +24 -32
- package/node/users/index.js +53 -58
- package/node/vendor/index.js +6 -17
- package/notifications/index.d.ts +16 -22
- package/notifications/index.js +22 -33
- package/package.json +1 -1
- package/reports/index.d.ts +44 -50
- package/reports/index.js +62 -75
- package/roles/index.d.ts +38 -44
- package/roles/index.js +41 -57
- package/security-center/index.d.ts +2 -14
- package/security-center/index.js +6 -15
- package/sub-tenants/index.d.ts +15 -57
- package/sub-tenants/index.js +68 -88
- package/subscriptions/index.d.ts +11 -56
- package/subscriptions/index.js +11 -68
- package/subscriptions/invoices.d.ts +13 -16
- package/subscriptions/invoices.js +14 -24
- package/subscriptions/managedSubscriptions.d.ts +15 -18
- package/subscriptions/managedSubscriptions.js +22 -33
- package/subscriptions/paymentMethods.d.ts +13 -16
- package/subscriptions/paymentMethods.js +17 -26
- package/subscriptions/paymentProviders.d.ts +5 -8
- package/subscriptions/paymentProviders.js +4 -11
- package/subscriptions/plans.d.ts +8 -11
- package/subscriptions/plans.js +6 -14
- package/subscriptions/providers/index.d.ts +1 -0
- package/subscriptions/providers/index.js +1 -0
- package/subscriptions/providers/stripe/index.d.ts +21 -24
- package/subscriptions/providers/stripe/index.js +16 -27
- package/subscriptions/subscriptions.d.ts +21 -24
- package/subscriptions/subscriptions.js +22 -33
- package/subscriptions/summaries.d.ts +4 -7
- package/subscriptions/summaries.js +3 -10
- package/subscriptions/tenantConfiguration.d.ts +3 -6
- package/subscriptions/tenantConfiguration.js +7 -15
- package/subscriptions/vendorPublicConfigurations.d.ts +2 -5
- package/subscriptions/vendorPublicConfigurations.js +4 -11
- package/teams/index.d.ts +131 -35
- package/teams/index.js +93 -122
- package/tenants/index.d.ts +37 -25
- package/tenants/index.js +46 -62
- package/user-phone-numbers/index.d.ts +26 -32
- package/user-phone-numbers/index.js +19 -32
- package/users/index.d.ts +15 -21
- package/users/index.js +44 -60
- package/vendor/index.d.ts +6 -12
- package/vendor/index.js +4 -11
- package/BaseApiClient.d.ts +0 -16
- package/BaseApiClient.js +0 -39
- package/FetchClient.d.ts +0 -42
- package/FetchClient.js +0 -308
- package/node/BaseApiClient.js +0 -49
- package/node/FetchClient.js +0 -326
package/auth/index.d.ts
CHANGED
|
@@ -5,820 +5,771 @@ export { setTabTenantInSessionStorage, getTabTenantFromSessionStorage, getCurren
|
|
|
5
5
|
import { ISamlRolesGroup } from "../teams/interfaces";
|
|
6
6
|
import { IAcceptInvitation, IActivateAccount, IAllowedToRememberMfaDevice, ICreateSamlGroup, IDeleteApiToken, IDisableMfa, IEnrollMfaResponse, IForgotPassword, IGetActivateAccountStrategy, IGetActivateAccountStrategyResponse, IGetUserById, IGetUserPasswordConfig, ILogin, ILoginResponse, ILoginViaSocialLogin, ILoginViaSocialLoginResponse, ILoginWithMfa, IOidcPostLogin, IOidcConfiguration, IPostLogin, IPreLogin, IRecoverMFAToken, IResendActivationEmail, IResetPassword, ISamlConfiguration, ISamlVendorConfigResponse, ISignUpResponse, ISignUpUser, ISocialLoginProviderConfiguration, ITenantApiTokensData, IUpdateSamlConfiguration, IUpdateSamlGroup, IUpdateSamlRoles, IUpdateSamlVendorMetadata, IUpdateTenantApiTokensData, IUpdateUserApiTokensData, IUserApiTokensData, IUserIdResponse, IVendorConfig, IVerifyMfa, IVerifyMfaResponse, TestConfig, ISSOPublicConfiguration, IPreLoginWithIdpTypeResponse, IPasswordlessPreLogin, IPasswordlessPostLogin, ICreateSSODomain, IVerifyInviteToken, ISSODomain, ISSOConfigurationDefaultRoles, ISSOConfiguration, IUpdateSSOConfiguration, IOidcPostLoginV2, IExchangeOAuthTokens, IOAuthTokenResponse, ISocialLoginProviderConfigurationV2, ILoginResponseV2, IResetPhoneNumber, IVerifyResetPhoneNumber, IChangePhoneNumber, IVerifyResetPhoneNumberResponse, IResetPhoneNumberResponse, IWebAuthnPreLogin, IWebAuthnPostLogin, IVerifyNewWebAuthnDevice, IWebAuthnPreLoginResponse, ICreateNewDeviceSessionResponse, IAuthStrategiesConfig, ISessionResponse, IChangePhoneNumberWithVerification, IChangePhoneNumberWithVerificationResponse, IVerifyChangePhoneNumber, ISessionConfigurations, IResendInvitationEmail, IPreEnrollMFA, IEnrollMFAAuthenticatorApp, IPreEnrollMFASMS, IEnrollMFASMS, IEnrollMFAWebAuthn, IPreEnrollMFAAuthenticatorAppResponse, IPreEnrollMFAWebAuthnResponse, IVerifyMFAAuthenticatorApp, IPreVerifyMFA, IPreVerifyMFASMSResponse, IVerifyMFASMS, IPreVerifyMFAWebAuthnResponse, IVerifyMFAWebAuthn, IPreEnrollMFASMSResponse, IPreDisableMFASMSResponse, IDisableMFASMS, IDisableMFAWebAuthn, IPreDisableMFAWebAuthnResponse, UserMFADevicesResponse, WithoutMFAToken, IMFAStrategiesResponse, IOAuthLogout, IGetUserAccessTokens, IGetTenantAccessTokens, IDeleteAccessToken, ICreateTenantAccessTokenData, ICreateUserAccessTokenData, IWebAuthnDevices, ICustomSocialLoginProviderConfigurationV1, ILoginResponseV3, IPreVerifyMFAEmailCodeResponse, IVerifyMFAEmailCode, ICreateOrUpdateSSOConfigurationByMetadataUrl, GenerateStepUpRequest, GenerateStepUpResponse } from './interfaces';
|
|
7
7
|
import { IGetUserAuthorizationResponse, IUserProfile } from "../users/interfaces";
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
/** @deprecated use api.auth.securityPolicy.saveMfaPolicy() or api.securityPolicy.saveMfaPolicy() instead */
|
|
777
|
-
saveMfaPolicy: (body: import("./interfaces").ISaveSecurityPolicyMfa) => Promise<import("./interfaces").ISecurityPolicyMfa>;
|
|
778
|
-
/** @deprecated use api.auth.securityPolicy.getLockoutPolicy() or api.securityPolicy.getLockoutPolicy() instead */
|
|
779
|
-
getLockoutPolicy: () => Promise<import("./interfaces").ISecurityPolicyLockout>;
|
|
780
|
-
/** @deprecated use api.auth.securityPolicy.getVendorLockoutPolicy() or api.securityPolicy.getVendorLockoutPolicy() instead */
|
|
781
|
-
getVendorLockoutPolicy: () => Promise<import("./interfaces").ISecurityPolicyLockout>;
|
|
782
|
-
/** @deprecated use api.auth.securityPolicy.saveLockoutPolicy() or api.securityPolicy.saveLockoutPolicy() instead */
|
|
783
|
-
saveLockoutPolicy: (body: import("./interfaces").ISaveSecurityPolicyLockout) => Promise<import("./interfaces").ISecurityPolicyLockout>;
|
|
784
|
-
/** @deprecated use api.auth.securityPolicy.getCaptchaPolicy() or api.securityPolicy.getCaptchaPolicy() instead */
|
|
785
|
-
getCaptchaPolicy: () => Promise<import("./interfaces").ISecurityPolicyCaptcha | null>;
|
|
786
|
-
/** @deprecated use api.auth.securityPolicy.getPasswordHistoryPolicy() or api.securityPolicy.getPasswordHistoryPolicy() instead */
|
|
787
|
-
getPasswordHistoryPolicy: () => Promise<import("./interfaces").ISecurityPolicyPasswordHistory>;
|
|
788
|
-
/** @deprecated use api.auth.securityPolicy.getVendorPasswordHistoryPolicy() or api.securityPolicy.getVendorPasswordHistoryPolicy() instead */
|
|
789
|
-
getVendorPasswordHistoryPolicy: () => Promise<import("./interfaces").ISecurityPolicyPasswordHistory>;
|
|
790
|
-
/** @deprecated use api.auth.securityPolicy.savePasswordHistoryPolicy() or api.securityPolicy.savePasswordHistoryPolicy() instead */
|
|
791
|
-
savePasswordHistoryPolicy: (body: import("./interfaces").ISaveSecurityPolicyPasswordHistory) => Promise<import("./interfaces").ISecurityPolicyPasswordHistory>;
|
|
792
|
-
/** @deprecated use api.auth.securityPolicy.getPasswordConfigPolicy() or api.securityPolicy.getPasswordConfigPolicy() instead */
|
|
793
|
-
getPasswordConfigPolicy: () => Promise<Partial<TestConfig>>;
|
|
794
|
-
/** @deprecated use api.auth.securityPolicy.getDomainRestrictions() or api.securityPolicy.getDomainRestrictions() instead */
|
|
795
|
-
getDomainRestrictions: () => Promise<{
|
|
796
|
-
items: import("./interfaces").DomainRestriction[];
|
|
797
|
-
}>;
|
|
798
|
-
/** @deprecated use api.auth.securityPolicy.getDomainRestrictionsConfig() or api.securityPolicy.getDomainRestrictionsConfig() instead */
|
|
799
|
-
getDomainRestrictionsConfig: () => Promise<import("./interfaces").DomainRestrictionConfig>;
|
|
800
|
-
/** @deprecated use api.auth.securityPolicy.createDomainRestriction() or api.securityPolicy.createDomainRestriction() instead */
|
|
801
|
-
createDomainRestriction: (body: import("./interfaces").CreateDomainRestriction) => Promise<import("./interfaces").DomainRestriction>;
|
|
802
|
-
/** @deprecated use api.auth.securityPolicy.updateDomainRestrictionConfig() or api.securityPolicy.updateDomainRestrictionConfig() instead */
|
|
803
|
-
updateDomainRestrictionConfig: (body: import("./interfaces").UpdateDomainRestrictionsConfig) => Promise<import("./interfaces").DomainRestrictionConfig>;
|
|
804
|
-
/** @deprecated use api.auth.securityPolicy.deleteDomainRestriction() or api.securityPolicy.deleteDomainRestriction() instead */
|
|
805
|
-
deleteDomainRestriction: (id: string) => Promise<void>;
|
|
806
|
-
/** @deprecated use api.auth.securityPolicy.getIPRestrictions() or api.securityPolicy.getIPRestrictions() instead */
|
|
807
|
-
getIPRestrictions: (params: import("./interfaces").GetIPRestrictionsParams) => Promise<import("..").FronteggPaginationResult<import("./interfaces").IpRestriction[]>>;
|
|
808
|
-
/** @deprecated use api.auth.securityPolicy.getIPRestrictionsConfig() or api.securityPolicy.getIPRestrictionsConfig() instead */
|
|
809
|
-
getIPRestrictionsConfig: () => Promise<import("./interfaces").IPRestrictionsConfig>;
|
|
810
|
-
/** @deprecated use api.auth.securityPolicy.createIPRestriction() or api.securityPolicy.createIPRestriction() instead */
|
|
811
|
-
createIPRestriction: (body: import("./interfaces").CreateIpRestriction) => Promise<void>;
|
|
812
|
-
/** @deprecated use api.auth.securityPolicy.bulkCreateIPRestriction() or api.securityPolicy.bulkCreateIPRestriction() instead */
|
|
813
|
-
bulkCreateIPRestriction: (body: import("./interfaces").BulkCreateIpRestriction) => Promise<void>;
|
|
814
|
-
/** @deprecated use api.auth.securityPolicy.updateIPRestrictionConfig() or api.securityPolicy.updateIPRestrictionConfig() instead */
|
|
815
|
-
updateIPRestrictionConfig: (body: import("./interfaces").IPRestrictionsConfig) => Promise<void>;
|
|
816
|
-
/** @deprecated use api.auth.securityPolicy.deleteIPRestriction() or api.securityPolicy.deleteIPRestriction() instead */
|
|
817
|
-
deleteIPRestriction: (id: string) => Promise<void>;
|
|
818
|
-
/** @deprecated use api.auth.securityPolicy.testCurrentIp() or api.securityPolicy.testCurrentIp() instead */
|
|
819
|
-
testCurrentIp: () => Promise<import("./interfaces").IPValidResponse>;
|
|
820
|
-
/** @deprecated use api.auth.securityPolicy.testCurrentIpInAllowList() or api.securityPolicy.testCurrentIpInAllowList() instead */
|
|
821
|
-
testCurrentIpInAllowList: () => Promise<import("./interfaces").IPValidResponse>;
|
|
822
|
-
}
|
|
823
|
-
declare const _default: AuthenticationApi;
|
|
824
|
-
export default _default;
|
|
8
|
+
/*****************************************
|
|
9
|
+
* Authentication
|
|
10
|
+
*****************************************/
|
|
11
|
+
export declare function generateLoginResponse(loginResponse: ILoginResponse): Promise<ILoginResponse>;
|
|
12
|
+
export declare function generateLoginResponseV2(loginResponse: ILoginResponse): Promise<ILoginResponseV2>;
|
|
13
|
+
export declare function generateLoginResponseV3(loginResponse: ILoginResponse): Promise<ILoginResponseV3>;
|
|
14
|
+
export declare function generateLoginResponseFromOAuthResponse(oauthResponse: IOAuthTokenResponse): Promise<ILoginResponse>;
|
|
15
|
+
export declare function generateLoginResponseFromOAuthResponseV2(oauthResponse: IOAuthTokenResponse): Promise<ILoginResponseV3>;
|
|
16
|
+
/**
|
|
17
|
+
* Check if requested email address has sso configuration
|
|
18
|
+
* If true, this function will return the sso address to navigate to
|
|
19
|
+
* else, return null
|
|
20
|
+
*/
|
|
21
|
+
export declare function preLogin(body: IPreLogin): Promise<string | null>;
|
|
22
|
+
/**
|
|
23
|
+
* Check if requested email address has sso configuration
|
|
24
|
+
* If true, this function will return the sso address and IdpType to navigate to
|
|
25
|
+
*/
|
|
26
|
+
export declare function preLoginWithIdpType(body: IPreLogin): Promise<IPreLoginWithIdpTypeResponse | null>;
|
|
27
|
+
/**
|
|
28
|
+
* After calling preLogin and navigated to SSO url, the IDP will redirect you to the ACS Url
|
|
29
|
+
* Which configured in the SSO configuraation
|
|
30
|
+
* else, return null
|
|
31
|
+
*/
|
|
32
|
+
export declare function postLogin(body: IPostLogin): Promise<ILoginResponse>;
|
|
33
|
+
/**
|
|
34
|
+
* After calling preLogin and navigated to SSO url, the IDP will redirect you to the redirect url
|
|
35
|
+
* with code and state
|
|
36
|
+
*/
|
|
37
|
+
export declare function oidcPostLogin(body: IOidcPostLogin): Promise<ILoginResponse>;
|
|
38
|
+
/**
|
|
39
|
+
* login with username and password.
|
|
40
|
+
* if the user has two factor authentication
|
|
41
|
+
* the server will return mfaToken with mfaRequired: true,
|
|
42
|
+
* and then ``loginWithMfa`` should be called with the mfaToken and and generated code
|
|
43
|
+
* else, the server will accessToken and refreshToken.
|
|
44
|
+
* the refresh should be used to renew your access token by calling ``refreshToken``
|
|
45
|
+
*
|
|
46
|
+
* @throw exception if login failed
|
|
47
|
+
*/
|
|
48
|
+
export declare function login(body: ILogin): Promise<ILoginResponse>;
|
|
49
|
+
/**
|
|
50
|
+
* login with username and password.
|
|
51
|
+
* if the user has two factor authentication
|
|
52
|
+
* the server will return mfaToken with mfaRequired: true,
|
|
53
|
+
* and then ``loginWithMfa`` should be called with the mfaToken and and generated code
|
|
54
|
+
* else, the server will accessToken and refreshToken.
|
|
55
|
+
* the refresh should be used to renew your access token by calling ``refreshToken``
|
|
56
|
+
*
|
|
57
|
+
* @throw exception if login failed
|
|
58
|
+
*/
|
|
59
|
+
export declare function loginv2(body: ILogin): Promise<ILoginResponseV3>;
|
|
60
|
+
/**
|
|
61
|
+
* after login succeeded with mfaRequired token response, this function should be called
|
|
62
|
+
* with the mfaToken and the generated code from your authenticator app.
|
|
63
|
+
*
|
|
64
|
+
* @throw exception if generated code or mfaToken are incorrect
|
|
65
|
+
*/
|
|
66
|
+
export declare function loginWithMfa(body: ILoginWithMfa): Promise<ILoginResponse>;
|
|
67
|
+
/**
|
|
68
|
+
* after login succeeded with mfaRequired token response, this function should be called
|
|
69
|
+
* with the mfaToken and the generated code from your authenticator app.
|
|
70
|
+
*
|
|
71
|
+
* @throw exception if generated code or mfaToken are incorrect
|
|
72
|
+
*/
|
|
73
|
+
export declare function loginWithMfaV2(body: ILoginWithMfa): Promise<ILoginResponseV3>;
|
|
74
|
+
/**
|
|
75
|
+
* activating account should be called after registering new user of deactivate account
|
|
76
|
+
* ``activateAccount`` should contains userId and the token that has been sent to the user after activation requested.
|
|
77
|
+
*
|
|
78
|
+
* @throws exception if activation failed
|
|
79
|
+
*/
|
|
80
|
+
export declare function activateAccount(body: IActivateAccount): Promise<void>;
|
|
81
|
+
/**
|
|
82
|
+
* activating account should be called after registering new user of deactivate account
|
|
83
|
+
* ``activateAccount`` should contains userId and the token that has been sent to the user after activation requested.
|
|
84
|
+
*
|
|
85
|
+
* @throws exception if activation failed
|
|
86
|
+
*/
|
|
87
|
+
export declare function activateAccountV2(body: IActivateAccount): Promise<ILoginResponseV3>;
|
|
88
|
+
/**
|
|
89
|
+
* get account activation configuration.
|
|
90
|
+
*/
|
|
91
|
+
export declare function getActivateAccountStrategy(params: IGetActivateAccountStrategy): Promise<IGetActivateAccountStrategyResponse>;
|
|
92
|
+
/**
|
|
93
|
+
* resend activation email should be called after a failed user activation.
|
|
94
|
+
* ``resend activation email`` should contain the user email.
|
|
95
|
+
*
|
|
96
|
+
* @throws exception if resend failed
|
|
97
|
+
*/
|
|
98
|
+
export declare function resendActivationEmail(body: IResendActivationEmail): Promise<void>;
|
|
99
|
+
/**
|
|
100
|
+
* resend invitation email should be called after a failed user invitation.
|
|
101
|
+
* ``resend invitation email`` should contain the user email.
|
|
102
|
+
*
|
|
103
|
+
* @throws exception if resend failed
|
|
104
|
+
*/
|
|
105
|
+
export declare function resendInvitationEmail(body: IResendInvitationEmail): Promise<void>;
|
|
106
|
+
/**
|
|
107
|
+
* activating account should be called after registering new user of deactivate account
|
|
108
|
+
* ``activateAccount`` should contains userId and the token that has been sent to the user after activation requested.
|
|
109
|
+
*
|
|
110
|
+
* @throws exception if activation failed
|
|
111
|
+
*/
|
|
112
|
+
export declare function acceptInvitation(body: IAcceptInvitation): Promise<void>;
|
|
113
|
+
/**
|
|
114
|
+
* refresh token called as authenticated use, access and refresh tokens resolved by the cookies.
|
|
115
|
+
* the server will return ILoginResponse with new access Token and refresh token and store it in the browser cookies.
|
|
116
|
+
*/
|
|
117
|
+
export declare function refreshToken(): Promise<ILoginResponse>;
|
|
118
|
+
/**
|
|
119
|
+
* refresh token called as authenticated use, access and refresh tokens resolved by the cookies.
|
|
120
|
+
* the server will return ILoginResponseV2 with new access Token and refresh token and store it in the browser cookies, as well as the tenants.
|
|
121
|
+
*/
|
|
122
|
+
export declare function refreshTokenV2(): Promise<ILoginResponseV2>;
|
|
123
|
+
/**
|
|
124
|
+
* refresh token called as authenticated use, access and refresh tokens resolved by the cookies.
|
|
125
|
+
* the server will return ILoginResponseV3 with new access Token and refresh token and store it in the browser cookies, as well as the tenants and the active tenant.
|
|
126
|
+
*/
|
|
127
|
+
export declare function refreshTokenV3(): Promise<ILoginResponseV3>;
|
|
128
|
+
/**
|
|
129
|
+
* logout from server, invalidate access and refresh token, remove it from cookies.
|
|
130
|
+
*/
|
|
131
|
+
export declare function logout(): Promise<void>;
|
|
132
|
+
/**
|
|
133
|
+
* logout from server on Hosted Login, invalidate access and refresh token, remove it from cookies.
|
|
134
|
+
*/
|
|
135
|
+
export declare function OAuthLogout(params?: IOAuthLogout): Promise<void>;
|
|
136
|
+
/**
|
|
137
|
+
* calling forgot password request will send email with link to reset user's password.
|
|
138
|
+
*
|
|
139
|
+
* @throws exception if the user not found
|
|
140
|
+
*/
|
|
141
|
+
export declare function forgotPassword(body: IForgotPassword): Promise<void>;
|
|
142
|
+
/**
|
|
143
|
+
* reset password should be called after forget password request.
|
|
144
|
+
* userId, new password and the token has been sent to the user email.
|
|
145
|
+
*
|
|
146
|
+
* @throws exception if the user not found, password validation failed or invalid token.
|
|
147
|
+
*/
|
|
148
|
+
export declare function resetPassword(body: IResetPassword): Promise<void>;
|
|
149
|
+
/**
|
|
150
|
+
* load password configuration for user.
|
|
151
|
+
*/
|
|
152
|
+
export declare function loadPasswordConfig(params?: IGetUserPasswordConfig): Promise<Partial<TestConfig> | null>;
|
|
153
|
+
/**
|
|
154
|
+
* recover Multi-Factor authentication by providing the recoveryCode
|
|
155
|
+
* that has been received when activated it
|
|
156
|
+
*
|
|
157
|
+
* @throws exception if recovery code is not valid
|
|
158
|
+
*/
|
|
159
|
+
export declare function recoverMfaToken(body: IRecoverMFAToken): Promise<void>;
|
|
160
|
+
/**
|
|
161
|
+
* Multi-Factor Settings
|
|
162
|
+
*/
|
|
163
|
+
/**
|
|
164
|
+
* enroll Multi-Factor Auth Code to use in 3rd party apps like Google Authenticator.
|
|
165
|
+
* the server returns qrCode as png image in base64 format
|
|
166
|
+
*
|
|
167
|
+
* @throws exception if the user already have mfa-enabled
|
|
168
|
+
* ``authorized user``
|
|
169
|
+
*/
|
|
170
|
+
export declare function enrollMfa(): Promise<IEnrollMfaResponse>;
|
|
171
|
+
/**
|
|
172
|
+
* pre enroll Multi-Factor Auth Code to use in 3rd party apps like Google Authenticator.
|
|
173
|
+
* the server returns qrCode as png image in base64 format
|
|
174
|
+
*
|
|
175
|
+
* @throws exception if the user already have mfa-enabled
|
|
176
|
+
* ``authorized user``
|
|
177
|
+
*/
|
|
178
|
+
export declare function preEnrollMFAAuthenticatorApp(): Promise<IPreEnrollMFAAuthenticatorAppResponse>;
|
|
179
|
+
/**
|
|
180
|
+
* enroll Multi-Factor Auth Code to use in 3rd party apps like Google Authenticator.
|
|
181
|
+
*/
|
|
182
|
+
export declare function enrollMFAAuthenticatorApp(body: WithoutMFAToken<IEnrollMFAAuthenticatorApp>): Promise<void>;
|
|
183
|
+
/**
|
|
184
|
+
* pre enroll Multi-Factor SMS
|
|
185
|
+
* the server returns otcToken that should be sent to the enroll function with the code that was sent to
|
|
186
|
+
*/
|
|
187
|
+
export declare function preEnrollMFASMS(body: WithoutMFAToken<IPreEnrollMFASMS>): Promise<IPreEnrollMFASMSResponse>;
|
|
188
|
+
/**
|
|
189
|
+
* after pre enroll with SMS, enroll SMS function should be called
|
|
190
|
+
* with the otcToken and the code that has been sent to the phone number that was requested
|
|
191
|
+
*/
|
|
192
|
+
export declare function enrollMFASMS(body: WithoutMFAToken<IEnrollMFASMS>): Promise<void>;
|
|
193
|
+
/**
|
|
194
|
+
* pre enroll Multi-Factor to use with WebAuthn
|
|
195
|
+
* the server returns attestation object
|
|
196
|
+
* the request phone number
|
|
197
|
+
*/
|
|
198
|
+
export declare function preEnrollMFAWebAuthn(): Promise<IPreEnrollMFAWebAuthnResponse>;
|
|
199
|
+
/**
|
|
200
|
+
* after pre enroll with WebAuthn, enroll WebAuthn function should be called
|
|
201
|
+
* with the webauthnToken and the attestation object response
|
|
202
|
+
*/
|
|
203
|
+
export declare function enrollMFAWebAuthn(body: WithoutMFAToken<IEnrollMFAWebAuthn>): Promise<void>;
|
|
204
|
+
/**
|
|
205
|
+
* after enrolling MFA QR code, verify function should be called
|
|
206
|
+
* with the generated code in the Authenticator App
|
|
207
|
+
*
|
|
208
|
+
* @return recoveryCode to use to disable mfa if your device is lost, this code won't show it again.
|
|
209
|
+
* @throws exception if the generated token is invalid
|
|
210
|
+
* ``authorized user``
|
|
211
|
+
*/
|
|
212
|
+
export declare function verifyMfa(body: IVerifyMfa): Promise<IVerifyMfaResponse>;
|
|
213
|
+
/**
|
|
214
|
+
* disable MFA by either passing the recoveryCode or the generated code from the Authenticator App.
|
|
215
|
+
*
|
|
216
|
+
* @throws exception if the generated token or the recoveryCode are incorrect.
|
|
217
|
+
* * ``authorized user``
|
|
218
|
+
*/
|
|
219
|
+
export declare function disableMfa(body: IDisableMfa): Promise<void>;
|
|
220
|
+
/**
|
|
221
|
+
* disable MFA Authenticator App.
|
|
222
|
+
*
|
|
223
|
+
* @throws exception if the generated token is incorrect.
|
|
224
|
+
* * ``authorized user``
|
|
225
|
+
*/
|
|
226
|
+
export declare function disableMFAAuthenticatorApp(deviceId: string, body: IDisableMfa): Promise<void>;
|
|
227
|
+
/**
|
|
228
|
+
* pre disable MFA SMS, should be called if user has just one mfa device
|
|
229
|
+
*
|
|
230
|
+
* @throws exception if pre disable is not required for disable
|
|
231
|
+
* * ``authorized user``
|
|
232
|
+
*/
|
|
233
|
+
export declare function preDisableMFASMS(deviceId: string): Promise<IPreDisableMFASMSResponse>;
|
|
234
|
+
/**
|
|
235
|
+
* after pre disable MFA SMS, disable MFA SMS should be called. can also be called without pre disable if
|
|
236
|
+
* user has more than one mfa device
|
|
237
|
+
*
|
|
238
|
+
* @throws exception if pre disable is not required for disable
|
|
239
|
+
* * ``authorized user``
|
|
240
|
+
*/
|
|
241
|
+
export declare function disableMFASMS(deviceId: string, body: IDisableMFASMS): Promise<void>;
|
|
242
|
+
/**
|
|
243
|
+
* pre disable MFA WebAuthn, should be called if user has just one mfa device
|
|
244
|
+
*
|
|
245
|
+
* @throws exception if pre disable is not required for disable
|
|
246
|
+
* * ``authorized user``
|
|
247
|
+
*/
|
|
248
|
+
export declare function preDisableMFAWebAuthn(deviceId: string): Promise<IPreDisableMFAWebAuthnResponse>;
|
|
249
|
+
/**
|
|
250
|
+
* after pre disable MFA WebAuthn, disable MFA WebAuthn should be called. can also be called without pre disable if
|
|
251
|
+
* user has more than one mfa device
|
|
252
|
+
*
|
|
253
|
+
* @throws exception if pre disable is not required for disable
|
|
254
|
+
* * ``authorized user``
|
|
255
|
+
*/
|
|
256
|
+
export declare function disableMFAWebAuthn(deviceId: string, body: IDisableMFAWebAuthn): Promise<void>;
|
|
257
|
+
/**
|
|
258
|
+
* returns user mfa devices list splitted into 3 arrays. webauthn, phones and authenticators.
|
|
259
|
+
*/
|
|
260
|
+
export declare function getMFADevices(): Promise<UserMFADevicesResponse>;
|
|
261
|
+
/**
|
|
262
|
+
* pre enroll Multi-Factor Auth Code to use in 3rd party apps like Google Authenticator.
|
|
263
|
+
* the server returns qrCode as png image in base64 format
|
|
264
|
+
*/
|
|
265
|
+
export declare function preEnrollMFAAuthenticatorAppForLogin(body: IPreEnrollMFA): Promise<IPreEnrollMFAAuthenticatorAppResponse>;
|
|
266
|
+
/**
|
|
267
|
+
* after pre enroll with authenticator app, enroll authenticator app function should be called
|
|
268
|
+
* with the generated code in the Authenticator App
|
|
269
|
+
*/
|
|
270
|
+
export declare function enrollMFAAuthenticatorAppForLogin(body: IEnrollMFAAuthenticatorApp): Promise<ILoginResponse>;
|
|
271
|
+
/**
|
|
272
|
+
* after pre enroll with authenticator app, enroll authenticator app function should be called
|
|
273
|
+
* with the generated code in the Authenticator App
|
|
274
|
+
*/
|
|
275
|
+
export declare function enrollMFAAuthenticatorAppForLoginV2(body: IEnrollMFAAuthenticatorApp): Promise<ILoginResponseV3>;
|
|
276
|
+
/**
|
|
277
|
+
* after login succeeded with mfaRequired token response, this function should be called
|
|
278
|
+
* with the selected authenticator app id, mfaToken and the generated code from your authenticator app.
|
|
279
|
+
*/
|
|
280
|
+
export declare function verifyMFAAuthenticatorAppForLogin(deviceId: string, body: IVerifyMFAAuthenticatorApp): Promise<ILoginResponse>;
|
|
281
|
+
/**
|
|
282
|
+
* pre verify Multi-Factor Email Code
|
|
283
|
+
* the server returns otcToken that should be sent to the verify function with the code that was sent to
|
|
284
|
+
*/
|
|
285
|
+
export declare function preVerifyMFAEmailCode(body: IPreVerifyMFA): Promise<IPreVerifyMFAEmailCodeResponse>;
|
|
286
|
+
/**
|
|
287
|
+
* after pre verify with Email Code, verify Email Code function should be called
|
|
288
|
+
* with the otcToken and the code that has been sent to the email
|
|
289
|
+
*/
|
|
290
|
+
export declare function verifyMFAEmailCode(body: IVerifyMFAEmailCode): Promise<ILoginResponse>;
|
|
291
|
+
/**
|
|
292
|
+
* after pre verify with Email Code, verify Email Code function should be called
|
|
293
|
+
* with the otcToken and the code that has been sent to the email
|
|
294
|
+
*/
|
|
295
|
+
export declare function verifyMFAEmailCodeV2(body: IVerifyMFAEmailCode): Promise<ILoginResponseV3>;
|
|
296
|
+
/**
|
|
297
|
+
* pre enroll Multi-Factor to use with SMS
|
|
298
|
+
* the server returns otcToken that should be sent to the enroll function with the code that was sent to
|
|
299
|
+
* the request phone number
|
|
300
|
+
*/
|
|
301
|
+
export declare function preEnrollMFASMSForLogin(body: IPreEnrollMFASMS): Promise<IPreEnrollMFASMSResponse>;
|
|
302
|
+
/**
|
|
303
|
+
* after pre enroll with SMS, enroll SMS function should be called
|
|
304
|
+
* with the otcToken and the code that has been sent to the phone number that was requested
|
|
305
|
+
*/
|
|
306
|
+
export declare function enrollMFASMSForLogin(body: IEnrollMFASMS): Promise<ILoginResponse>;
|
|
307
|
+
/**
|
|
308
|
+
* after pre enroll with SMS, enroll SMS function should be called
|
|
309
|
+
* with the otcToken and the code that has been sent to the phone number that was requested
|
|
310
|
+
*/
|
|
311
|
+
export declare function enrollMFASMSForLoginV2(body: IEnrollMFASMS): Promise<ILoginResponseV3>;
|
|
312
|
+
/**
|
|
313
|
+
* after login succeeded with mfaRequired token response, if the user asked to use SMS as MFA
|
|
314
|
+
* this function should be called with the selected device id and mfaToken
|
|
315
|
+
*/
|
|
316
|
+
export declare function preVerifyMFASMSForLogin(deviceId: string, body: IPreVerifyMFA): Promise<IPreVerifyMFASMSResponse>;
|
|
317
|
+
/**
|
|
318
|
+
* after pre verify with SMS, this function should be called with otcToken, mfaToken and the code
|
|
319
|
+
* that has been sent to the selected device.
|
|
320
|
+
*/
|
|
321
|
+
export declare function verifyMFASMSForLogin(deviceId: string, body: IVerifyMFASMS): Promise<ILoginResponse>;
|
|
322
|
+
/**
|
|
323
|
+
* after pre verify with SMS, this function should be called with otcToken, mfaToken and the code
|
|
324
|
+
* that has been sent to the selected device.
|
|
325
|
+
*/
|
|
326
|
+
export declare function verifyMFASMSForLoginV2(deviceId: string, body: IVerifyMFASMS): Promise<ILoginResponseV3>;
|
|
327
|
+
/**
|
|
328
|
+
* pre enroll Multi-Factor to use with WebAuthn
|
|
329
|
+
* the server returns attestation object
|
|
330
|
+
* the request phone number
|
|
331
|
+
*/
|
|
332
|
+
export declare function preEnrollMFAWebAuthnForLogin(body: IPreEnrollMFA): Promise<IPreEnrollMFAWebAuthnResponse>;
|
|
333
|
+
/**
|
|
334
|
+
* after pre enroll with WebAuthn, enroll WebAuthn function should be called
|
|
335
|
+
* with the webauthnToken and the attestation object response
|
|
336
|
+
*/
|
|
337
|
+
export declare function enrollMFAWebAuthnForLogin(body: IEnrollMFAWebAuthn): Promise<ILoginResponse>;
|
|
338
|
+
/**
|
|
339
|
+
* after pre enroll with WebAuthn, enroll WebAuthn function should be called
|
|
340
|
+
* with the webauthnToken and the attestation object response
|
|
341
|
+
*/
|
|
342
|
+
export declare function enrollMFAWebAuthnForLoginV2(body: IEnrollMFAWebAuthn): Promise<ILoginResponseV3>;
|
|
343
|
+
/**
|
|
344
|
+
* after login succeeded with mfaRequired token response, if the user asked to use WebAuthn as MFA
|
|
345
|
+
* this function should be called with the selected device id and mfaToken.
|
|
346
|
+
*/
|
|
347
|
+
export declare function preVerifyMFAWebAuthnForLogin(deviceId: string, body: IPreVerifyMFA): Promise<IPreVerifyMFAWebAuthnResponse>;
|
|
348
|
+
/**
|
|
349
|
+
* after pre verify with WebAuthn, this function should be called with webauthnTokenToken, mfaToken
|
|
350
|
+
* and the assertion response.
|
|
351
|
+
*/
|
|
352
|
+
export declare function verifyMFAWebAuthnForLogin(deviceId: string, body: IVerifyMFAWebAuthn): Promise<ILoginResponse>;
|
|
353
|
+
/**
|
|
354
|
+
* after pre verify with WebAuthn, this function should be called with webauthnTokenToken, mfaToken
|
|
355
|
+
* and the assertion response.
|
|
356
|
+
*/
|
|
357
|
+
export declare function verifyMFAWebAuthnForLoginV2(deviceId: string, body: IVerifyMFAWebAuthn): Promise<ILoginResponseV3>;
|
|
358
|
+
/**
|
|
359
|
+
* SSO Configurations
|
|
360
|
+
*/
|
|
361
|
+
/**
|
|
362
|
+
* Retrieve SAML configurations from server by logged in user (tenantId, vendorId)
|
|
363
|
+
*
|
|
364
|
+
* @return {enabled: false} if no saml configuration found. else ISamlConfiguration
|
|
365
|
+
* * ``authorized user``
|
|
366
|
+
*/
|
|
367
|
+
export declare function getSamlConfiguration(): Promise<ISamlConfiguration>;
|
|
368
|
+
/**
|
|
369
|
+
* Update SAML configuration by logged in user (tenantId, vendorId)
|
|
370
|
+
* * ``authorized user``
|
|
371
|
+
*/
|
|
372
|
+
export declare function updateSamlConfiguration(body: IUpdateSamlConfiguration): Promise<ISamlConfiguration>;
|
|
373
|
+
/**
|
|
374
|
+
* Retrieve 'Vendor' Saml config from server by logged in user (tenantId, vendorId)
|
|
375
|
+
*
|
|
376
|
+
* @throws exception 'ACS url information not found' if no saml vendor configuration found.
|
|
377
|
+
* * ``authorized user``
|
|
378
|
+
*/
|
|
379
|
+
export declare function getSamlVendorConfiguration(): Promise<ISamlVendorConfigResponse>;
|
|
380
|
+
/**
|
|
381
|
+
* Update Vendor Saml metadata by logged in user (tenantId, vendorId)
|
|
382
|
+
*
|
|
383
|
+
* @return {enabled: false} if no saml configuration found. else ISamlConfiguration
|
|
384
|
+
* * ``authorized user``
|
|
385
|
+
*/
|
|
386
|
+
export declare function updateSamlVendorMetadata(body: IUpdateSamlVendorMetadata): Promise<ISamlConfiguration>;
|
|
387
|
+
/**
|
|
388
|
+
* Validate Saml configuration's domain by logged in user (tenantId, vendorId)
|
|
389
|
+
*
|
|
390
|
+
* @return {enabled: false} if no saml configuration found. else ISamlConfiguration
|
|
391
|
+
* * ``authorized user``
|
|
392
|
+
*/
|
|
393
|
+
export declare function validateSamlDomain(): Promise<ISamlConfiguration>;
|
|
394
|
+
/**
|
|
395
|
+
* Get Saml roles for authorization
|
|
396
|
+
* @return array of role IDs
|
|
397
|
+
*/
|
|
398
|
+
export declare function getSamlRoles(): Promise<string[]>;
|
|
399
|
+
/**
|
|
400
|
+
* Get Saml roles groups
|
|
401
|
+
* @return array of groups and assigend role IDs
|
|
402
|
+
*/
|
|
403
|
+
export declare function getSamlRolesGroups(): Promise<ISamlRolesGroup[]>;
|
|
404
|
+
/**
|
|
405
|
+
* Update Saml roles for authorization
|
|
406
|
+
*/
|
|
407
|
+
export declare function updateSamlRoles({ roleIds, }: IUpdateSamlRoles): Promise<void>;
|
|
408
|
+
/**
|
|
409
|
+
* Create Saml group roles for authorization
|
|
410
|
+
*/
|
|
411
|
+
export declare function createSamlGroup({ roleIds, group, }: ICreateSamlGroup): Promise<void>;
|
|
412
|
+
/**
|
|
413
|
+
* Update Saml group roles for authorization
|
|
414
|
+
*/
|
|
415
|
+
export declare function updateSamlGroup({ roleIds, group, id, }: IUpdateSamlGroup): Promise<void>;
|
|
416
|
+
/**
|
|
417
|
+
* Delete Saml group
|
|
418
|
+
*/
|
|
419
|
+
export declare function deleteSamlGroup({ id }: {
|
|
420
|
+
id: string;
|
|
421
|
+
}): Promise<void>;
|
|
422
|
+
/**
|
|
423
|
+
* Retrieve OIDC configurations from server by logged in user (vendorId)
|
|
424
|
+
*
|
|
425
|
+
* @return {active: true} if no oidc configuration found. else IOidcConfiguration
|
|
426
|
+
* * ``authorized user``
|
|
427
|
+
*/
|
|
428
|
+
export declare function getOidcConfiguration(): Promise<IOidcConfiguration>;
|
|
429
|
+
/**
|
|
430
|
+
* Check if one or more saml/oidc configuration are active
|
|
431
|
+
*
|
|
432
|
+
** @return {isActive: true/false}
|
|
433
|
+
*/
|
|
434
|
+
export declare function getSSOPublicConfiguration(): Promise<ISSOPublicConfiguration>;
|
|
435
|
+
/**
|
|
436
|
+
* Get social logins providers configurations for vendor
|
|
437
|
+
* @return array of providers configurations
|
|
438
|
+
*/
|
|
439
|
+
export declare function getSocialLoginProviders(): Promise<ISocialLoginProviderConfiguration[]>;
|
|
440
|
+
/**
|
|
441
|
+
* ##### Public route
|
|
442
|
+
* Get social logins providers configurations V2 supports dev credentials as well
|
|
443
|
+
* @return array of providers configurations
|
|
444
|
+
*/
|
|
445
|
+
export declare function getSocialLoginProvidersV2(): Promise<ISocialLoginProviderConfigurationV2[]>;
|
|
446
|
+
/**
|
|
447
|
+
* ##### Authenticated route
|
|
448
|
+
* Get social logins providers configurations V2 supports dev credentials as well
|
|
449
|
+
* @return array of providers configurations
|
|
450
|
+
*/
|
|
451
|
+
export declare function getSocialLoginProvidersV2ForAuthenticatedUser(): Promise<ISocialLoginProviderConfigurationV2[]>;
|
|
452
|
+
/**
|
|
453
|
+
* Get social logins custom providers configurations
|
|
454
|
+
* @return array of custom providers configurations
|
|
455
|
+
*/
|
|
456
|
+
export declare function getCustomSocialLoginProvidersV1(): Promise<ICustomSocialLoginProviderConfigurationV1>;
|
|
457
|
+
/**
|
|
458
|
+
* Login using social login
|
|
459
|
+
* @return cookie with refresh token
|
|
460
|
+
*/
|
|
461
|
+
export declare function loginViaSocialLogin({ provider, code, idToken, redirectUri, codeVerifier, metadata, invitationToken, state, }: ILoginViaSocialLogin): Promise<ILoginViaSocialLoginResponse>;
|
|
462
|
+
/**
|
|
463
|
+
* Get vendor secure access configuration
|
|
464
|
+
*/
|
|
465
|
+
export declare function getVendorConfig(): Promise<IVendorConfig>;
|
|
466
|
+
/**
|
|
467
|
+
* Sign up new user
|
|
468
|
+
* create new user with a new tenant
|
|
469
|
+
*/
|
|
470
|
+
export declare function signUpUser(body: ISignUpUser): Promise<ISignUpResponse>;
|
|
471
|
+
/**
|
|
472
|
+
* Get all current user active sessions
|
|
473
|
+
*/
|
|
474
|
+
export declare function getCurrentUserSessions(): Promise<ISessionResponse[]>;
|
|
475
|
+
/**
|
|
476
|
+
* Get current user session
|
|
477
|
+
*/
|
|
478
|
+
export declare function getCurrentUserSession(): Promise<ISessionResponse>;
|
|
479
|
+
/**
|
|
480
|
+
* Revoke sessions for user
|
|
481
|
+
*/
|
|
482
|
+
export declare function revokeSessionsForUser(userId: string): Promise<void>;
|
|
483
|
+
/**
|
|
484
|
+
* Get session configurations
|
|
485
|
+
*/
|
|
486
|
+
export declare function getSessionConfigurations(): Promise<ISessionConfigurations>;
|
|
487
|
+
/**
|
|
488
|
+
* Create or update session configurations
|
|
489
|
+
*/
|
|
490
|
+
export declare function createOrUpdateSessionConfigrations(body: ISessionConfigurations): Promise<void>;
|
|
491
|
+
/**
|
|
492
|
+
* Delete user session
|
|
493
|
+
*/
|
|
494
|
+
export declare function deleteSessionForUser(id: string): Promise<void>;
|
|
495
|
+
/**
|
|
496
|
+
* Delete all user sessions
|
|
497
|
+
*/
|
|
498
|
+
export declare function deleteAllSessionsForUser(): Promise<void>;
|
|
499
|
+
/**
|
|
500
|
+
* Access tokens Configurations
|
|
501
|
+
*/
|
|
502
|
+
/**
|
|
503
|
+
* Get user access tokens data
|
|
504
|
+
*/
|
|
505
|
+
export declare function getUserAccessTokensData(): Promise<IGetUserAccessTokens>;
|
|
506
|
+
/**
|
|
507
|
+
* Get tenant access tokens data
|
|
508
|
+
*/
|
|
509
|
+
export declare function getTenantAccessTokensData(): Promise<IGetTenantAccessTokens>;
|
|
510
|
+
/**
|
|
511
|
+
* Delete Tenant access Token
|
|
512
|
+
*/
|
|
513
|
+
export declare function deleteTenantAccessToken({ id, }: IDeleteAccessToken): Promise<void>;
|
|
514
|
+
/**
|
|
515
|
+
* Delete Tenant access Token
|
|
516
|
+
*/
|
|
517
|
+
export declare function deleteUserAccessToken({ id, }: IDeleteAccessToken): Promise<void>;
|
|
518
|
+
/**
|
|
519
|
+
* Create User Access Token.
|
|
520
|
+
*/
|
|
521
|
+
export declare function createUserAccessToken(body: ICreateUserAccessTokenData): Promise<IUserApiTokensData>;
|
|
522
|
+
/**
|
|
523
|
+
* Create Tenant Access Token
|
|
524
|
+
*/
|
|
525
|
+
export declare function createTenantAccessToken(body: ICreateTenantAccessTokenData): Promise<ITenantApiTokensData>;
|
|
526
|
+
/**
|
|
527
|
+
* Api tokens Configurations
|
|
528
|
+
*/
|
|
529
|
+
/**
|
|
530
|
+
* Get user api tokens data
|
|
531
|
+
*/
|
|
532
|
+
export declare function getUserApiTokensData(): Promise<IUserApiTokensData[]>;
|
|
533
|
+
/**
|
|
534
|
+
* Get tenant api tokens data
|
|
535
|
+
*/
|
|
536
|
+
export declare function getTenantApiTokensData(): Promise<ITenantApiTokensData[]>;
|
|
537
|
+
/**
|
|
538
|
+
* Update User Api Tokens
|
|
539
|
+
*/
|
|
540
|
+
export declare function updateUserApiTokensData(body: IUpdateUserApiTokensData): Promise<IUserApiTokensData>;
|
|
541
|
+
/**
|
|
542
|
+
* Update Tenant Api Tokens
|
|
543
|
+
*/
|
|
544
|
+
export declare function updateTenantApiTokensData(body: IUpdateTenantApiTokensData): Promise<ITenantApiTokensData>;
|
|
545
|
+
/**
|
|
546
|
+
* Delete Tenant Api Token
|
|
547
|
+
*/
|
|
548
|
+
export declare function deleteTenantApiToken({ tokenId, }: IDeleteApiToken): Promise<void>;
|
|
549
|
+
/**
|
|
550
|
+
* Delete Tenant Api Token
|
|
551
|
+
*/
|
|
552
|
+
export declare function deleteUserApiToken({ tokenId, }: IDeleteApiToken): Promise<void>;
|
|
553
|
+
/**
|
|
554
|
+
* Get Tenant Api Token Creator User
|
|
555
|
+
*/
|
|
556
|
+
export declare function getUserById({ userId, }: IGetUserById): Promise<IUserIdResponse>;
|
|
557
|
+
/**
|
|
558
|
+
* Checks if remember MFA device is enabled for user.
|
|
559
|
+
*/
|
|
560
|
+
export declare function checkIfAllowToRememberMfaDevice(mfaToken: string): Promise<IAllowedToRememberMfaDevice>;
|
|
561
|
+
/**
|
|
562
|
+
* Passwordless prelogin authentication
|
|
563
|
+
*/
|
|
564
|
+
export declare function passwordlessPreLogin({ type, ...body }: IPasswordlessPreLogin): Promise<void>;
|
|
565
|
+
export declare function passwordlessPostLoginV2({ type, ...body }: IPasswordlessPostLogin): Promise<ILoginResponseV3>;
|
|
566
|
+
export declare function passwordlessPostLogin({ type, ...body }: IPasswordlessPostLogin): Promise<ILoginResponse>;
|
|
567
|
+
/**
|
|
568
|
+
* Check if tenant invitation token is valid
|
|
569
|
+
* @param token - invitation token
|
|
570
|
+
* @returns tenant name
|
|
571
|
+
*/
|
|
572
|
+
export declare function verifyInviteToken({ token, }: IVerifyInviteToken): Promise<string>;
|
|
573
|
+
/**
|
|
574
|
+
* SSO Configurations V1
|
|
575
|
+
*/
|
|
576
|
+
/**
|
|
577
|
+
* Retrieve SSO configurations from server by logged in user (tenantId, vendorId)
|
|
578
|
+
*
|
|
579
|
+
* @return ISSOConfiguration[]
|
|
580
|
+
* * ``authorized user``
|
|
581
|
+
*/
|
|
582
|
+
export declare function getSSOConfigurations(): Promise<ISSOConfiguration[]>;
|
|
583
|
+
/**
|
|
584
|
+
* Create SSO configuration by logged in user (tenantId, vendorId)
|
|
585
|
+
*
|
|
586
|
+
* @returns ISSOConfiguration
|
|
587
|
+
* * ``authorized user``
|
|
588
|
+
*/
|
|
589
|
+
export declare function createSSOConfiguration(body: IUpdateSSOConfiguration): Promise<ISSOConfiguration>;
|
|
590
|
+
/**
|
|
591
|
+
* Update SSO configuration by logged in user (tenantId, vendorId)
|
|
592
|
+
*
|
|
593
|
+
* @returns ISSOConfiguration
|
|
594
|
+
* * ``authorized user``
|
|
595
|
+
*/
|
|
596
|
+
export declare function updateSSOConfiguration(ssoConfigId: string, body: IUpdateSSOConfiguration): Promise<ISSOConfiguration>;
|
|
597
|
+
/**
|
|
598
|
+
* Delete SSO configuration by logged in user (tenantId, vendorId)
|
|
599
|
+
* * ``authorized user``
|
|
600
|
+
*/
|
|
601
|
+
export declare function deleteSSOConfiguration(ssoConfigId: string): Promise<void>;
|
|
602
|
+
/**
|
|
603
|
+
* Create SSO configuration by metadata by logged in user (tenantId, vendorId)
|
|
604
|
+
*
|
|
605
|
+
* @returns ISSOConfiguration
|
|
606
|
+
* * ``authorized user``
|
|
607
|
+
*/
|
|
608
|
+
export declare function createSSOConfigurationByMetadata(body: IUpdateSamlVendorMetadata): Promise<ISSOConfiguration>;
|
|
609
|
+
/**
|
|
610
|
+
* Update SSO configuration by metadata by logged in user (tenantId, vendorId)
|
|
611
|
+
*
|
|
612
|
+
* @returns ISSOConfiguration
|
|
613
|
+
* * ``authorized user``
|
|
614
|
+
*/
|
|
615
|
+
export declare function updateSSOConfigurationByMetadata(ssoConfigId: string, body: IUpdateSamlVendorMetadata): Promise<ISSOConfiguration>;
|
|
616
|
+
/**
|
|
617
|
+
* Create SSO configuration by metadata url by logged in user (tenantId, vendorId)
|
|
618
|
+
*
|
|
619
|
+
* @returns ISSOConfiguration
|
|
620
|
+
* * ``authorized user``
|
|
621
|
+
*/
|
|
622
|
+
export declare function createSSOConfigurationByMetadataUrl(body: ICreateOrUpdateSSOConfigurationByMetadataUrl): Promise<ISSOConfiguration>;
|
|
623
|
+
/**
|
|
624
|
+
* Update SSO configuration by metadata url by logged in user (tenantId, vendorId)
|
|
625
|
+
*
|
|
626
|
+
* @returns ISSOConfiguration
|
|
627
|
+
* * ``authorized user``
|
|
628
|
+
*/
|
|
629
|
+
export declare function updateSSOConfigurationByMetadataUrl(ssoConfigId: string, body: ICreateOrUpdateSSOConfigurationByMetadataUrl): Promise<ISSOConfiguration>;
|
|
630
|
+
/**
|
|
631
|
+
* Create SSO configuration domain by logged in user (tenantId, vendorId)
|
|
632
|
+
*
|
|
633
|
+
* @returns ISSODomain
|
|
634
|
+
* * ``authorized user``
|
|
635
|
+
*/
|
|
636
|
+
export declare function createSSODomain(ssoConfigId: string, body: ICreateSSODomain): Promise<ISSODomain>;
|
|
637
|
+
/**
|
|
638
|
+
* Create SSO configuration domain by logged in user (tenantId, vendorId)
|
|
639
|
+
* * ``authorized user``
|
|
640
|
+
*/
|
|
641
|
+
export declare function deleteSSODomain(ssoConfigId: string, domainId: string): Promise<void>;
|
|
642
|
+
/**
|
|
643
|
+
* Validate SSO configuration domain by logged in user (tenantId, vendorId)
|
|
644
|
+
* * ``authorized user``
|
|
645
|
+
* @deprecated(Use validateSSODomainV2 instead)
|
|
646
|
+
*/
|
|
647
|
+
export declare function validateSSODomain(ssoConfigId: string, domainId: string): Promise<void>;
|
|
648
|
+
/**
|
|
649
|
+
* Validate SSO configuration domain by logged in user (tenantId, vendorId)
|
|
650
|
+
* * ``authorized user``
|
|
651
|
+
*/
|
|
652
|
+
export declare function validateSSODomainV2(ssoConfigId: string, domainId: string): Promise<void>;
|
|
653
|
+
/**
|
|
654
|
+
* Get SSO configuration default roles by logged in user (tenantId, vendorId)
|
|
655
|
+
* * ``authorized user``
|
|
656
|
+
*/
|
|
657
|
+
export declare function getSSODefaultRoles(ssoConfigId: string): Promise<ISSOConfigurationDefaultRoles>;
|
|
658
|
+
/**
|
|
659
|
+
* Create SSO configuration default roles by logged in user (tenantId, vendorId)
|
|
660
|
+
* * ``authorized user``
|
|
661
|
+
*/
|
|
662
|
+
export declare function setSSODefaultRoles(ssoConfigId: string, body: IUpdateSamlRoles): Promise<void>;
|
|
663
|
+
/**
|
|
664
|
+
* Create SSO configuration group roles for authorization
|
|
665
|
+
*/
|
|
666
|
+
export declare function createSSOGroup(ssoConfigId: string, body: ICreateSamlGroup): Promise<void>;
|
|
667
|
+
/**
|
|
668
|
+
* Update SSO configuration group roles for authorization
|
|
669
|
+
*/
|
|
670
|
+
export declare function updateSSOGroup(ssoConfigId: string, { roleIds, group, id }: IUpdateSamlGroup): Promise<void>;
|
|
671
|
+
/**
|
|
672
|
+
* Delete SSO configuration group
|
|
673
|
+
*/
|
|
674
|
+
export declare function deleteSSOGroup(ssoConfigId: string, groupId: string): Promise<void>;
|
|
675
|
+
/**
|
|
676
|
+
* Get SSO configuration groups
|
|
677
|
+
*/
|
|
678
|
+
export declare function getSSOGroups(ssoConfigId: string): Promise<ISamlRolesGroup[]>;
|
|
679
|
+
/**
|
|
680
|
+
* Check if requested email address has sso configuration
|
|
681
|
+
* If true, this function will return the sso address to navigate to
|
|
682
|
+
* else, return null
|
|
683
|
+
*/
|
|
684
|
+
export declare function preLoginV2(body: IPreLogin): Promise<IPreLoginWithIdpTypeResponse | null>;
|
|
685
|
+
/**
|
|
686
|
+
* After calling preLogin and navigated to SSO url, the IDP will redirect you to the redirect url
|
|
687
|
+
* with code and state
|
|
688
|
+
*/
|
|
689
|
+
export declare function oidcPostLoginV2(body: IOidcPostLoginV2): Promise<ILoginResponse>;
|
|
690
|
+
export declare function exchangeOAuthTokensV2(body: IExchangeOAuthTokens): Promise<ILoginResponseV3>;
|
|
691
|
+
export declare function silentOAuthRefreshTokenV2(): Promise<ILoginResponseV3>;
|
|
692
|
+
export declare function exchangeOAuthTokens(body: IExchangeOAuthTokens): Promise<ILoginResponse>;
|
|
693
|
+
export declare function silentOAuthRefreshToken(): Promise<ILoginResponse>;
|
|
694
|
+
/**
|
|
695
|
+
* reset phone should be called in case user want to reset his phone number
|
|
696
|
+
* when using sms authentication strategy. a 6-digits code will be send to the user email.
|
|
697
|
+
*/
|
|
698
|
+
export declare function resetPhoneNumber(body: IResetPhoneNumber): Promise<IResetPhoneNumberResponse>;
|
|
699
|
+
/**
|
|
700
|
+
* verify reset phone should be called after reset phone number request
|
|
701
|
+
* with the token received from the reset phone number request and a code that was sent to the user email
|
|
702
|
+
*/
|
|
703
|
+
export declare function verifyResetPhoneNumber(body: IVerifyResetPhoneNumber): Promise<IVerifyResetPhoneNumberResponse>;
|
|
704
|
+
/**
|
|
705
|
+
* change phone number with verification.
|
|
706
|
+
*/
|
|
707
|
+
export declare function changePhoneNumberWithVerification(body: IChangePhoneNumberWithVerification): Promise<IChangePhoneNumberWithVerificationResponse>;
|
|
708
|
+
/**
|
|
709
|
+
* verify new phone number.
|
|
710
|
+
*/
|
|
711
|
+
export declare function verifyChangePhoneNumber(body: IVerifyChangePhoneNumber): Promise<void>;
|
|
712
|
+
/**
|
|
713
|
+
* change phone number should be called after verify reset phone number with the new phone number
|
|
714
|
+
*/
|
|
715
|
+
export declare function changePhoneNumber(body: IChangePhoneNumber): Promise<void>;
|
|
716
|
+
/**
|
|
717
|
+
* webauthn prelogin should be called when the user wants to be authenticated using his device/android/usb key
|
|
718
|
+
*/
|
|
719
|
+
export declare function webAuthnPreLogin(body: IWebAuthnPreLogin): Promise<IWebAuthnPreLoginResponse>;
|
|
720
|
+
/**
|
|
721
|
+
* webauthn postlogin should be called after the user used his authenticator (device/android/usb key) in order to login
|
|
722
|
+
*/
|
|
723
|
+
export declare function webAuthnPostLogin(body: IWebAuthnPostLogin): Promise<ILoginResponse>;
|
|
724
|
+
/**
|
|
725
|
+
* webauthn postlogin should be called after the user used his authenticator (device/android/usb key) in order to login
|
|
726
|
+
*/
|
|
727
|
+
export declare function webAuthnPostLoginV2(body: IWebAuthnPostLogin): Promise<ILoginResponseV3>;
|
|
728
|
+
/**
|
|
729
|
+
* webauthn create new device should be called once the user wants to add new device as authenticator
|
|
730
|
+
*/
|
|
731
|
+
export declare function webAuthnCreateNewDeviceSession(): Promise<ICreateNewDeviceSessionResponse>;
|
|
732
|
+
/**
|
|
733
|
+
* get webauthn devices should be called in order to get user's webAuthn devices
|
|
734
|
+
*/
|
|
735
|
+
export declare function getWebAuthnDevices(): Promise<IWebAuthnDevices>;
|
|
736
|
+
/**
|
|
737
|
+
* delete webauthn device should be called in order to delete user's webAuthn device
|
|
738
|
+
*/
|
|
739
|
+
export declare function deleteWebAuthnDevice(deviceId: string): Promise<void>;
|
|
740
|
+
/**
|
|
741
|
+
* webauthn verify new device should be called after the user used his authenticator in order to register the new device
|
|
742
|
+
*/
|
|
743
|
+
export declare function verifyNewDeviceSession(body: IVerifyNewWebAuthnDevice): Promise<void>;
|
|
744
|
+
/**
|
|
745
|
+
* ##### Public route
|
|
746
|
+
* Get public vendor auth strategies public configuration
|
|
747
|
+
*/
|
|
748
|
+
export declare function getVendorPublicAuthStrategiesConfig(): Promise<IAuthStrategiesConfig>;
|
|
749
|
+
/**
|
|
750
|
+
* ##### Authenticated route
|
|
751
|
+
* Get public vendor auth strategies public configuration
|
|
752
|
+
*/
|
|
753
|
+
export declare function getPublicAuthStrategiesConfigForAuthenticatedUser(): Promise<IAuthStrategiesConfig>;
|
|
754
|
+
/**
|
|
755
|
+
* Get vendor mfa strategies configuration
|
|
756
|
+
*/
|
|
757
|
+
export declare function getMFAStrategiesConfig(): Promise<IMFAStrategiesResponse>;
|
|
758
|
+
/**
|
|
759
|
+
* Get user permissions and roles
|
|
760
|
+
*/
|
|
761
|
+
export declare function getUserAuthorization(): Promise<IGetUserAuthorizationResponse>;
|
|
762
|
+
/**
|
|
763
|
+
* Get user profile
|
|
764
|
+
*/
|
|
765
|
+
export declare function getMeV2(): Promise<IUserProfile>;
|
|
766
|
+
/**
|
|
767
|
+
* @returns me and authorization response with entitlements inside user.entitlements
|
|
768
|
+
* Me request will be executed, and me authorization and entitlements will be executed according to FF and configuration.
|
|
769
|
+
*/
|
|
770
|
+
export declare function getMeAndEntitlements(): Promise<IUserProfile>;
|
|
771
|
+
/**
|
|
772
|
+
* generate step-up session
|
|
773
|
+
* this request returns the step up details to continue step up, or the generated login response when stepped up jwt received from the BE
|
|
774
|
+
*/
|
|
775
|
+
export declare function generateStepupSession(body: GenerateStepUpRequest): Promise<GenerateStepUpResponse | ILoginResponseV3>;
|