From 3831955d9c0d56bfb660e576f9135f5530c79323 Mon Sep 17 00:00:00 2001 From: Yogesh Chaudhary Date: Tue, 28 Apr 2026 09:17:42 +0530 Subject: [PATCH] Release v2.9.0 --- .version | 2 +- CHANGELOG.md | 8 + docs/assets/hierarchy.js | 2 +- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/classes/AbstractNavigator.html | 6 +- docs/classes/Auth0ClientFactory.html | 4 +- docs/classes/AuthClientConfig.html | 8 +- docs/classes/AuthGuard.html | 10 +- docs/classes/AuthHttpInterceptor.html | 6 +- docs/classes/AuthModule.html | 4 +- docs/classes/AuthService.html | 146 +- docs/classes/AuthState.html | 22 +- docs/classes/AuthenticationError.html | 2 +- docs/classes/ConnectError.html | 2 +- docs/classes/GenericError.html | 16 +- docs/classes/MfaChallengeError.html | 1243 ++++++++++++++++ docs/classes/MfaEnrollmentError.html | 1243 ++++++++++++++++ docs/classes/MfaEnrollmentFactorsError.html | 1247 ++++++++++++++++ docs/classes/MfaError.html | 1259 +++++++++++++++++ docs/classes/MfaListAuthenticatorsError.html | 1247 ++++++++++++++++ docs/classes/MfaRequiredError.html | 2 +- docs/classes/MfaVerifyError.html | 1239 ++++++++++++++++ docs/classes/MissingRefreshTokenError.html | 2 +- docs/classes/PopupCancelledError.html | 2 +- docs/classes/PopupOpenError.html | 1203 ++++++++++++++++ docs/classes/PopupTimeoutError.html | 2 +- docs/classes/TimeoutError.html | 2 +- docs/classes/UseDpopNonceError.html | 2 +- docs/enums/HttpMethod.html | 14 +- docs/functions/authGuardFn.html | 2 +- docs/functions/authHttpInterceptorFn.html | 2 +- .../isHttpInterceptorRouteConfig.html | 2 +- docs/functions/provideAuth0.html | 2 +- docs/hierarchy.html | 105 +- docs/interfaces/AppState.html | 8 +- docs/interfaces/AuthConfig.html | 10 +- docs/interfaces/Authenticator.html | 692 +++++++++ .../ChallengeAuthenticatorParams.html | 500 +++++++ docs/interfaces/ChallengeResponse.html | 496 +++++++ docs/interfaces/EnrollEmailParams.html | 504 +++++++ docs/interfaces/EnrollOtpParams.html | 454 ++++++ docs/interfaces/EnrollPushParams.html | 454 ++++++ docs/interfaces/EnrollSmsParams.html | 507 +++++++ docs/interfaces/EnrollVoiceParams.html | 507 +++++++ docs/interfaces/EnrollmentFactor.html | 382 +++++ docs/interfaces/GetTokenWithPopupOptions.html | 2 +- docs/interfaces/HttpInterceptorConfig.html | 4 +- .../HttpInterceptorRouteConfig.html | 12 +- docs/interfaces/LogoutOptions.html | 6 +- docs/interfaces/ObservableMfaApiClient.html | 1036 ++++++++++++++ docs/interfaces/OobEnrollmentResponse.html | 708 +++++++++ docs/interfaces/OtpEnrollmentResponse.html | 593 ++++++++ docs/interfaces/PopupLoginOptions.html | 2 +- docs/interfaces/RedirectLoginOptions.html | 6 +- docs/interfaces/VerifyParams.html | 603 ++++++++ docs/modules.html | 891 +++++++++++- docs/types/ApiRouteDefinition.html | 2 +- docs/types/AuthenticatorType.html | 260 ++++ docs/types/ConnectedAccount.html | 2 +- docs/types/EnrollParams.html | 280 ++++ docs/types/EnrollmentResponse.html | 263 ++++ docs/types/InteractiveErrorHandler.html | 259 ++++ docs/types/MfaFactorType.html | 261 ++++ docs/types/MfaGrantType.html | 262 ++++ docs/types/OobChannel.html | 262 ++++ docs/variables/Auth0ClientService.html | 2 +- docs/variables/AuthConfigService.html | 2 +- projects/auth0-angular/package.json | 2 +- 69 files changed, 19091 insertions(+), 205 deletions(-) create mode 100644 docs/classes/MfaChallengeError.html create mode 100644 docs/classes/MfaEnrollmentError.html create mode 100644 docs/classes/MfaEnrollmentFactorsError.html create mode 100644 docs/classes/MfaError.html create mode 100644 docs/classes/MfaListAuthenticatorsError.html create mode 100644 docs/classes/MfaVerifyError.html create mode 100644 docs/classes/PopupOpenError.html create mode 100644 docs/interfaces/Authenticator.html create mode 100644 docs/interfaces/ChallengeAuthenticatorParams.html create mode 100644 docs/interfaces/ChallengeResponse.html create mode 100644 docs/interfaces/EnrollEmailParams.html create mode 100644 docs/interfaces/EnrollOtpParams.html create mode 100644 docs/interfaces/EnrollPushParams.html create mode 100644 docs/interfaces/EnrollSmsParams.html create mode 100644 docs/interfaces/EnrollVoiceParams.html create mode 100644 docs/interfaces/EnrollmentFactor.html create mode 100644 docs/interfaces/ObservableMfaApiClient.html create mode 100644 docs/interfaces/OobEnrollmentResponse.html create mode 100644 docs/interfaces/OtpEnrollmentResponse.html create mode 100644 docs/interfaces/VerifyParams.html create mode 100644 docs/types/AuthenticatorType.html create mode 100644 docs/types/EnrollParams.html create mode 100644 docs/types/EnrollmentResponse.html create mode 100644 docs/types/InteractiveErrorHandler.html create mode 100644 docs/types/MfaFactorType.html create mode 100644 docs/types/MfaGrantType.html create mode 100644 docs/types/OobChannel.html diff --git a/.version b/.version index 62fd0835..ed51b084 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.8.1 \ No newline at end of file +v2.9.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index d356ae80..23abc1cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Change Log +## [v2.9.0](https://github.com/auth0/auth0-angular/tree/v2.9.0) (2026-04-28) + +[Full Changelog](https://github.com/auth0/auth0-angular/compare/v2.8.1...v2.9.0) + +**Added** + +- feat: add Multi-Factor Authentication (MFA) support [\#909](https://github.com/auth0/auth0-angular/pull/909) ([yogeshchoudhary147](https://github.com/yogeshchoudhary147)) + ## [v2.8.1](https://github.com/auth0/auth0-angular/tree/v2.8.1) (2026-04-17) [Full Changelog](https://github.com/auth0/auth0-angular/compare/v2.8.0...v2.8.1) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index cb07d12e..db7f838a 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1,2 +1,2 @@ window.hierarchyData = - 'eJyVlM1OwzAQhN9lz4YmtZ00uaGCEBJ/KiAOiIPlbhuL1A62c6r67iipQC5pcThFcmbzzex6swVrjHdQvjE2I5RxQpPinYDFVY3SK6MdlFugSdE9tNgglPBomra5NWulH5q9hMCH0ksopzwj0NoaSlDao10JiW4y0J9XflMDAVkL56AE75Zn3QfOfoq6l5WqlxY1lG805e87AjTlgYtr9M/mA/Wr8lVPGGfmVNkIT50FFlq4mQtZYQS4F/07cpb2kbM04N0aKeonb6xY4yE6nc6+0T0B3WQgPmlhf7AjwNjsoMEarZJX1hr7FyjURRgHEVlOCSsywnlCeF6QLGEkoynJKeuis5wGZp7VBk3ro2ZC3X/M8Gl/xViRBdC7lVjgZ6ssLqPg39p4t/mU/16qsSkH4hE0ngS0i9ZXqL2Sorv8Ud4R+QhiPvhpzIWWWNcj2nlEHidmCQunp5xTer3AlUVX9Usfn+KJmhFsGm7q3GiNMj7IUBdn5DTM9+LwsjHNvdESo6CBOEbb7b4ApJwHAw=='; + 'eJyVlF9v2yAUxb8Lz3SNbYyN36Z0myal69R120PVB0SuY1QCHpCHqcp3n5xoLbaTQp4iOef6d8794xdkjfEONY+ElrigOS5y+oSRhVaB8NJoh5oXVOR0+NF8C6hB302/61dmI/Vdf5Rg9Cz1GjV5STHaWYUaJLUH23IB7nqm/9D5rUIYCcWdQw3ybn01vODqtWj4s5NqbUGj5rEo8qc9RkWRBy6+gH8wz6B/S98dCGlmzpUleBos0NDC1yUXHUSAR9HFkav6ELmqA97KCK5+eGP5BsboLK//ow8EcNcz8VkLxwd7jAgtRw3WYKX4ZK2x74FCXYQxikjYApdZgUta4ZItMM0YpoRgWmW4qgiuMza0gLBFYOpBbsHsfNRUqLvEVEkOq1ZmRQC9bfk9/NlJC+soeKqNd70k+fS4UlPOxAk0Wk1pdz3oNNSrMoEzGtvHne9Aeyn4cGxR2Al5nEgzNk225FqAUgljOyFPIBISbol0TurNPbQWXHf4yMS35UxNArvKAvbSaA0ivjChLs6oqjDfTwc3vem/GS0gCpqJ47R6NL/blqfc2sUHXhOCa8pwzQhmGcOMkOHg6/EoW76SzgdraKxLsXOmKiE8nYbX1ii1BR0f6lydwGOTvMuOKwV6Ex/tTBynselof4GV7d8UVKBM4Eyn+NaXz1ykDvF0UYy+3/8Dnj4VfQ=='; diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 57b186f6..09b5a1ff 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1,2 +1,2 @@ window.navigationData = - 'eJyll11v2yAUhv+Lr7P1Y2u39a5K1y5S01Zpp11Mu6D4JEZ1gMEhajbtv0+20wTz5Yhcv6+fFw74AD//FgivWFwU3xDlFLASZTEqJMGquCiAm6U+2invK1zWxah4YbwsLj7/G22/noGWgmt4Wktwv7c1hzAqaE20Li4K1OU7pt/BK4LipC4s9uWzRkUo3pEVWxAUahfQfg36yLP0c05O7bFeGqyOxzUDjteEolDrANDzDBE781jwOVuEebZjiAYcGSXIBP+qVHDGvslj7lddg9WNIaoMZ7TS0GibHTLhCIqCDK+PbxpiTkVpagijOm2I8AhqxWgEsREHGUgwRmik1PdjwTlQjCygreat3DUgrSCA3gh51BvgoBiNjNpW8/gTPoWlUOsxoVWgsj05L+FWUFI/olBkAZEUz5KXNJ2TGfw2TEEZqZfryMxhWjO+mMFcga6exAvE2kLMmZf7IKSRY8Ip1HV0igHTAWlPbAnCxH4az5KXlA45nP9dw5UU8k5wCpEQz5KdFIbnngZSOi2PNS17TmjT9TZiH316du4ehc4haCO28hBEKPanPdseiCJLHaU5Pg+7Z9PD9l95ZDVwrNf3siGGQyPew4J/MKzazb1PsmvOi3bO48SiBZ2p9XM+mAmDsD/fsqdCJk5vt4CTQE/ftyyTsq1xmNtpeeBbsRAGU+vbc6Sm3rXctkIpnm/LG3nLuRULxgfTbFde2AxKpoDi5n50SakwPFm25BeHDWJw0iFjsrNJ1m7vK5gzzhr7Dotr2TZZ1+Hwjr98Ojk7te+ZzWYnz/ZluUNthSBhr0L0a/o22xloU6MXl/AePAIoN9xI6lYfrJbRKJbtFXnKOFuS+t6gND434jtgJi2xu5O90orwBXhby84OOfPTN48Ctw13gT0xP6MbMS+lYM0G6J79blbQlJ9pvdS9B9+KKNbs/957Pvjy+3AavMMMEHumBJC8PaSvrd99bjht1/TIkvuQ848OxDkp4zjPmAAzvc95veOn/IkYqcSKldCuRAhr6x7m1381O3Y8'; + 'eJytmU1z2zYQhv8Lz07tuE3a+uZRbEczVuSR3fTQ6QECVyImIIACS43VTv97R6RMgfiiAva8L94Hn4sF+cc/BcIrFjfFZ0S1AKxkWVwUimBV3BQgmtpcniI/VFjz4qL4xkRZ3Pzy70XfegVGSWHgZa/AbW/HHIeLgnJiTHFToCnfMfMOXhG0ILywvG/XBjWh+IXs2Jag1CdA2xrMpScZct5f2329bbC6mnEGAu8JRan3AUNPM+bYiWdSbNg27GcrxtxAIKMEmRR3WgdH7Is8z/Nmt8HqoSG6DDPa0FhvDztkLhA0BRVeH1805rmQZcMhbNXFxhyeQe8YjVgcg6MeSDDmcAil2s+kEEAxsoB2NG/l7gFpBQHrYyDP9QEEaEYjvbajef5zsYBa6v2M0Cows4NwHuFRUsKfUWqyhQjFk+SRFhsyqwjnILYQmTBPkk26E1pyXoOI7Shf8z+wuuxnzkHa0nxyHDTJ95EZtHJmckgRbTZ7BX81TEMZJw4U2ZyvoNlmH6dY8UwGM4aJ7Qo2Gkz1Ir9B7HqKKfO4T1I1akYEBc6j0xgQTaAtVXRsw/gExgurQTax4+xJ8khpyHT/3wx8UlJ9kYLGcqAnySaFzXMrH6Wc650dypMNoYcb/hgcWl9/+OiWfU7BZ1v04TGTPtFEfXqFZ3V2kSc1+7stFp+IJrWJohxdHrC/8wadT5BTDSZ24e39kea+qfJg3S14VxPGE4P0VFNgpys3wTqJpqCWqEZH1WumgJ4aU42STqIpqOfajJJ6zRTQV8kojKIsVR7sAbC9Zp8ZB4F8v1SHMxxGRrTTwL8zrI5X4zjZFeehnSdlIhcHlam07DRYyQbhfH9LnoLMneeJZTgPPEvOnZZ52c5x2LeL5Rk/yq1sMLW+A0Vq6Mu1Ab0jaw6LDblVrPs4EvQMS5Pmcn1Kf8n0H1TmTc4S1bnQkDIP2hW97UZLLYsvm4B7lFsmRmm2Kg+2gpJpoHj8UnJLqWxEcvclW0zrxOigQ8LUHu0eY4l7wRZkVn2KtYnoE2yYYIcenUC4V22V6yoc0tWvP7//cB0rV4dfe4+WriDoeF4Fd0iBh3PvMvrABO/BFnlbvBWYhqOHS2gn9wDKo2+E2sfHVmbWGJR1++1vwQSrCV82qBrfN6KbMJLWsXvkv9KKiC14J8Vmh5T59FTS7aijyfa7ae6xtTnBE/sdhOPXW7fY6BCDYD6jLVUIRbbrHuSfiSi5/bruaBFZPnexId1rJJQ5BsFJjAdNBEYQfSyfsJTrWUWEAO76nyL57t3pEKWSLL6lg6J8pvW7y/trsiOaHXLt4KdY8PfJj+5F0W3TEceBKGFI3v5G3VvX2KYRtM0fl1Z4aPLxJ8fEqdXjdp4wYczMOS+Gk39Kn8AoLXesbD+SXIVs7bhn8+d/1kVclQ=='; diff --git a/docs/assets/search.js b/docs/assets/search.js index a7b29236..5c945503 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1,2 +1,2 @@ window.searchData = - 'eJytnFtvnMgSx78LOY+jZOgb2G85zt6k7G60ey4Po2hFmLYHBQMCxnsiK9/9qLkMVXTB1Iz9ZMt0/auo/lV309B+Dury7ya43T0HX7NiH9zGm6BIHm1wG/zcttWvtj2U+2ATHOs8uA1scXxs3k0X3h7axzzYBGmeNI1tgtsg+L4ZlUJzkvpgc9vadZk3+7ERUNsEVVLbosXhkD5+su0ZBw9di+vUf7bJmTS8OfRNrtP/lLTp4YyDamhzpYeyOZegqm9ypf7xrPzxUnUx0fj+S9PWSdr+ljxlD0lb1idng+A7r8UqnToUJ+20LJq2PqZ81TfYhL4nP+TJvdiq6d6KvoH957d/1zk3gtHoy7djnV8VA0rvsT1s7/LMFu2Piburb34cXpPXSTAty8uwH/VCitPaJq3tm/JD6IzS0eiKGOYp7tvdlcV99kCGARu8Wno9UXZyUbwLqX2wdEZ9r2sDMNdbw/bWXOdt3mU/HZN6T7rsrrxaJ01q7N7pQ1siPinep232lICJd8lfUiRT05f7uztk+bmUQafp0P56zx/LhOMwL1emaMrPHAY3Tf1StLZObbXUkbM2rwYIpctGZR74QiqzsQk/Amhyjf95in8t98ecRra/9GoJBXLsPA7RLaTvvqz/KEs6edDbfVnXfbsLPM0T9aetn7KUztRw7dVSBfXYuRoDBLewFerkM6mqP9uktf847zGpqqY9NzqdcWfruqwZvrp2L3GU7f9VfrXFXZ5kjw3DYbZvXfu0a/8ix41rZIs2S5PW7jmumwRavMy5G4Oz4oHlNu/bvsThsbGc7nTNLnSDJ5eyKGzavk/T8li0/83awx92n9U2pat8XijONult/87aQz3ZXh9Rtyr90bbpwXKqtWt+f2p+td8HW9g6ae2Hqqw+1WV5f973aLKvyqoaTF7g3/WCbZquvP7Mclu0Of2YMgvC9YBtmq7MmsnulSJxTHwqq2N1aSgOiGowfEksrkN+KwvGVOACcH1RDK2v9npIin1ux0q4S/L8S5J+Pe+/txurIJ3sro4kLx+yrgvujk1bPnY98sP/0kNSPDDy0Vm7fkg7665b7GT98qiYYJzieDEPJ8/8Yerk/DVGp7x8KI88p+XKfhDDU/Hwe/HBNm1dMgaB4qEs9qfGV/tsLqq25vpq8xZ77dJzXHfl9RZ6JzX+Mq8L7YpV1+SKseZac8JZcU3OLlhvrTplrbaA20vWWuuO11da0CVrnbXmbGWVNfk5v8aauUA1Vdv72jaHc06mZlf6adCsfc5dg6bqF3n9YaD7nL/Lq2Du6ZcRDYa36+AQetrxfz88wJ2cdVsB90nq/A3X1t8QQdKGxbLdD0vts6pvThbJyWLhRsZAF1zXtqnKorF/td+q83fzZt78OqdtUsOd00Vvp3ZsN6iP3EYn3m6Gnk5X+f3UUfopaQ8MwX5gr/rGKzux3h4sdHhY2HNbcetMMmRyrfPma1YtLnNXInB2Fy1z/V1v0Iuz3bPlDiUb8vs2yfPyb7v/mDUkmMvqbwbLPDvzBtG/C9Yd/1EeW8u+bdD6wnt/X5TFt8fy2Fzhpc9BAhRYaYC3tlIBszfxF4TlrB9H69cKqZsVf6/arCyuylVnX57sXyusY51dE01v9opB/Jrg3ZnLYnlM1jdrWCHBavrYPWytdBdqsFozUHYcGD+6B8gVdardupPtTRRqAVYaWXeTH+x9VmTO/uTGzcFuypw3uEj/bmnt0avPL69qS4Em3+HV8Hyz/imps+RLjl8+c3btZ/J9t6+rozar4gYMh+PbsB+nXN8fi7TrvHfg6iWCM3AXpb12XCdZw5g4Jl9rzbkuq7p8yva260bCBbxMSX7eBFmxt/8Lbp+DJ1s3ju3bQLyVb2+CTXCf2XzvPs/qvW2CtHx87L9G2Jfpsfv189DsP9Y9qrvGfet322Cz226kfqtuzOfPm91o3F3o/jBqTH/pDMNgsws3avvWbBUyDD3DEBmKYLMTlEfhGQpkKIPNTlIepWcokaEKNjtFGSrPUCFDHWx2mjLUnqFGhibY7AxlaDxDgwyjYLOLKMPIM4yQYRxsdvFGyLdCx8gw9gxjZHgTbHY3lMcbz/AGA+B4CLckAj484YyecCnekOAHAxQ6LEKaPZ+hEEMUOjRCQRr7HIUYpFAtRu2jFGKWQr3EfejTFGKcQgdJSLIf+kSFGKnQgRKS/Ic+VSHGKlzkKvTBCjFZoeMlJOsn9OEKMV2io4usIeHTJTBdohucyDoSPl5iNj51eMWkMTFEYbyEXMqX8OkSmC7hgAnJWhQ+XgLjJTq8yGoUPl8C8yXMYtQ+XgLjJRwwgqxG4eMlMF7CESPIahQ+XwLzJW4Wo/bxEhgv6YARkipH6eMlMV7SASMUaezjJTFespv/NGns4yVnU6AjRhjSmJgFMV/SESMi0tjnS2K+ZMdXTBr7fEnMl3TICJJs6QMmMWDSISNJsqUPmMSASYeMJOmUPmASAyYdM5KkU/qESUyYcsxIcsxWPmEKE6YcM5Jes/iEKUyYcsxIctxVPmEKE6a6VRY57iqfMDVbaDlmJDnuKmKthQlTjhlJjrvKJ0xhwpRjRpKEKZ8whQlTjhlFEqZ8whQmTDlmFEmY8glTmDDlmFEkYconTGHC9HZp/NM+YBoDppeHMO0DpjFgenkI0z5gGgOml4cw7QOmMWB6eQjTPmB6tppfHsI0saDHgGmHjCLLWfuAaQyY7gAjy1n7gGkMmO4Aox9DfMA0Bkx3gJHlrH3ANAbMLE+SxifMYMKMY0aRXWV8wgwmzDhmFDkWGJ8wgwkzjhlFjgXGJ8xgwoxjRpNjgfEJM5gw0z0wkmOB8Qkzs2dGx4wmxwJDPDZiwoxjRpN4Gp8wgwkzjhlN4ml8wgwmzDhmNImn8QkzmLDIMaNJPCOfsAgTFjlmNP207BMWYcIisbTxEfmARRiwyCGjSTojH7AIAxZ1gJF0Rj5gEQYscsgYks7IByzCgEXdrgRJZ+QDFs02JhwyhqQzIvYmMGCRQ8aQdEY+YBEGLLpZHEgiH7AIAxY7ZAyJduwDFmPAYoeMIdGOfcBiDFjsmDEk2rFPWIwJix0zhkQ79gmLMWGxY8aQeMY+YTEmLO4II/GMfcKGP3X7k0+2bu3+l36fcrcLkuFUWTEdxnsO/hr2MaNxa/Q5iILb5+/fp13L2+fvYOPSXXMu5+/NJikNtUK+2PgiEijpScnc8JSqrHbbwXvw0mESNBKEFjMFx6/YJxkBZOS2NzRbnpzbUu4Pp92PR/Ym4XA7CYcXCzbjCwVww2oSjPmCvV467MCD+ASIT/LlPCENbtSoC4Wo+wSkxEzmju3hoT8mBm4Q5CtkFsKoc49RMyAiwVbyPoIAscWTorhacRYlqNWY36GPw3EfUBKgQ4VmCxFdKQBjglmjTmlepAroKN7ggY7UgcQDuMKLlYZzckAOkCF4NXk6BQdUQM8JHvFrJxtA/m/A4GYuEQbfdIFuAHGasBeImEmE37JOiqAM4t4yHHRDNfwc/i7k8NMMP2/6n5qZdXSSGKQ+BDzwCnF2nmPSkqBuJG/AGf/lAggIxMOSGD5aBJ0Oxj05ZFNfoNV/LQbGdxCS4Q0Hp+N1ICqgInjJIQ6vgGQDPckbWrqv+EBEIKCBNd7dLZ1nAcEBbckrkMWTKUAVLFUUD3t83ARIAUYUj42lkyNAFIytildL/b/sABIgbzyB5TlWg04wvMFvpkasdUDeDI+6mWa3oiWEwUQS8foWflY2CYExaFjNRryumH2VD+oEdKscKkUzNaejyWCEA5OS4K0XvU/3QXQgcXKYIzSPnazh9Y2BsxQ34NO33SBUMH3KYXrTPL31Y1KgfkA2FC8L85NPQAzEqy6Mk1qNSJBHxRtqx0NKQATQo3hV3YucvnUEHQvmkIinNfunL5MWCIs34KMDUWCNBQpY8ebJ4d8SAQ0gwVMoZw/rkwCvn4aPrJL+GyyQYZCWmCmF+xsAzeuhkbwORarTwbQQ8RJ8OvkCUgxmKs0NDJ1aAFqgLgxvYG3wUiYE0YS8aObHa0A4AB/NS1CzsMxQoMAUb7qcjuEAGcgjW4YcgxXgSfMKlT5JAIoFJN/w8jUeKQFxgUIxvIEbf8EN4gE4RTyp7vNroACCiXgjCPxoGtQaGMwiXvn3R9nApAnuRuph0mRIfd4EVVbZPCtscLv7/P37/wFoE/Nv'; + 'eJytnFuPm8gSx78Lcx6tZOgbeN5yJnuTkt1o91werGhF7PYYBQMCPLvRKN991YBNFV3gssdPHo27/lXd/auiaWi/BFXxVx08rF6Cr2m+CR7iRZAnexs8BD83TfnRNrtiEyyCQ5UFD4HND/v67fDFm12zz4JFsM6SurZ18BAE3xdHpdCcpN7bzDZ2XuZuc2wE1BZBmVQ2b3A4pI+fbHPGwVPb4jr1n21yZhjudl2T6/Q/Jc16d8ZB2be50kNRnxugsmtypf7hrPzhUnUx0PjuS91Uybr5NXlOn5KmqE7OesG3XotZOnUoTtrrIq+b6rDmq95hE7pPfsiDe3Gvhr7lXQP772//rTJuBEejL98OVXZVDGh4D83u/jFLbd78mLheffPj8JrcZoBpWd4I+1FPDPG6sklju6b8EFqj9dHoihjGQ9y1eyzybfpEhgEb3Gx4PVH24KJ4J4b2ydIj6nudK8BcbzXbW32dt/GU/XRIqg3psv3mZpM0qLFnpwttivgkf7du0ucEXHin/CV5MjR9vb/HXZqdGzLodN23v97zhyLhOMyKmUs05WcMg7tM/ZI3tlrbcmoiR21uBgily0ZlHPjEUKbHJvwIoMk1/sdD/LHYHDIa2e6rmw0okGOPYx/dxPBti+r3oqAHD3rbFlXVtbvA03ig/rDVc7qmR6r/7mZDBfXYY3UMEHThXqiTz6Qs/2iSxv7rvMekLOvmXHU6485WVVExfLXtXuMo3fyn+GrzxyxJ9zXDYbppXPt12/5VjmvXyOZNuk4au+G4rhNo8Trnrgan+RPLbda1fY3D/TY576lrdLWPQ205yLhmF7rBF7Aiz+26ebdeF4e8+X/a7H63m7Sya7qSjJPR2Sad7V9ps6sG2+sjale+P9pmvbOcitA2356aX+33yea2Shr7vizKT1VRbM/7PppsyqIse5NX+HezYOu6TeE/0szmTUbfCo2CcDNg67pN5Xqwu1EkjolPRXkoLw3FAVH2hq+JxU3Ir0XOuNy4ANxc5H3rq73uknyT2WMmPCZZ9iVZfz3vv7M7ZsF6sLs6kqx4StspeDzUTbFvZ+SHv9e7JH9ijEdr7eZh3Vq302IH69dHxQTjFMereTh55pepk/NbVKeseCoOPKfFzJ4Tw1P+9Fv+3tZNVTCKQP5U5JtT46t91hdlW319tnkLymbqXrH95naLyZMafynZhnbFym5wxVjXzTnhrOoGZxes6WadslZ0wO0l67l5x/OrOeiStZabczazyhr8nF9jjVygnKrstrL17pyTodmVfmp01T7nrkaX6ld5/aGn+5y/y7Ng7OmXIxoMb9fBIfTwVOFdf5N4ctZuN2yTtfPXfzf/FAqS1i+W7aZfap9VvTtZJCeLiY4cA51wXdm6LPLa/tl8K8/35m7c/DqnTVLB3dlJb6d2bDdojtxmKt7Shp5O3/LnqaX0U9LsGIJdYS+7xjO7vd4+L3S4m9jXm3HrTFJkcq3z+mtaTi5zZyJwdhctc/2ddTCLox266QklG/LnNsmy4i+7+ZDWJJjT6ne9ZZaeeUrp94LV49+LQ2PZ3QatL+z7u7zIv+2LQ32Fl24MEqDAGgbYtZkMGD3tvyAsZ70/Wt8qpPaq+FvZpEV+1Vi19sXJ/lZhHar0mmg6sxsG8THBuzOXxbJP5jdrWCHBbPrQ3mzNTBdqMJszUPa3L7WtnpMvmf24Td6V6egRLtCnW847QnteuyTLLLyl54nfQUN6MCc6MRGIzasiyy6N4mR1ixDc7tNwJ1FU5ITOReN2ocYCNwrsh7aj+9Pz9mtisyeN7UnjFuE92yrdfrs0oJPVtSGAfDkuJD64DZeZbKTancmVZRRqAVbmaVsU3tttmqfO/uTGrVndEnPc4CL9x6m1eqc+/npWWwq0WO1f1xg/QHtOqtSNMnohhPMkbSTflcl5ddRmVtyA5cPxCfWPw1hvD/m6nby34NtLBEeFflLaa8d1ktaMhdbga64512VZFc/pxrbTSLiAX1OSnxdBmm/s38HDi8vo2rH9EIg38s0yWATb1GYb98pk520RrIv9vrsmbYr1of3zc9/sf7arLg+rrvXb+2Cxul9I80ZEnz8vVkfb9v/tP44Sw39auzBYrMKFCt/IKEaGoWcYIkMRLFaCcCg8O4HsZLBYScqh9AwlMlTBYqUoQ+UZKmSog8VKU4baM9TI0ASLlaEMjWdokGEULFYRZRh5hhEyjIPFKl4I9eZeCmQYe4YxMlwGi9WS8rj0DJd4/h0O4T1JgM9OOIInnIo3JPDB/IQOi5BGz2coxBCFDo1QkMY+RyEGKVSTUfsohZilUE9gH/owhZim0DESkuiHPlAhJip0nIQk/qEPVYipCiexCn2uQgxW6HAJyfQJfbZCDJdo4SJTSPhwCQyXaEsTmUbCp0uMqlNLV0waExUK0yXk1HgJHy6B4RKOl5BMReHTJTBdoqWLTEbh8yUwX8JMRu3jJTBewgEjyGQUPl4C4yUcMYJMRuHzJTBfYjkZtY+XwHhJB4yQRDZKny6J6ZKOF6EoWx8uieGS7bVPU7Y+W3J0+XO4CEPZEhdAzJZ0tIiIsvXRkhgt2aJFJoT00ZIYLeloEUvKsY+WxGhJB4skmZY+WhKjJR0skuRS+mhJjJZ0tEiSS+mzJTFbyuEiyWqtfLgUhks5XiS9WPHpUpgu5YCRZMVVPl4K46Xa5RVZcZXPlxqtsBwykqy4ilhkYcCUQ0aSgCkfMIUBU44ZSVZN5ROmMGHKMaNIwpRPmMKEKceMIglTPmEKE6YcM4okTPmEKUyYdswokjDtE6YxYXpy5aV9wDQGTIup0qd9vjTmS8up0qd9vDTGS6up0qd9uvRoDa+nSp8mVvEYLj1ZvbTPlsZs6ZYtMpO1z5bGbOmWLfrWw2dLY7Z0yxaZydpnS2O2TMsWmcnGZ8tgtkw4dVk1PlsGs2UcLiqmbH22DGbLOFwUWQSMD5fBcBnHiyaLgPHpMpgu094ikkXA+HiZ0V2iI0aTRcAQN4qYL+OI0WQRMD5fBvNlHDGahNP4fBnMl3HEaBJO4/NlMF+RI0aTcEY+XxHmK3LIaPr+2AcswoBFjhlNXmYin7AIExbJiV2SyOcrwnxFLV8knJHPV4T5ihwxhoQz8vmKMF9Ruw1Bwhn5fEWjnQhHjCHhjIjNCMxX5IgxJJyRz1eE+YocMYaEM/L5ijBfsSPGkHDGPl8x5it2xBgSztjnK8Z8xY4YQ8IZ+3zFmK/YMWNIOGOfsBgTFjtmDElY7BMWY8Jix0xEEhb7hMWYsNhMFe3YByzGgMXtXhdJZ+wDFo+2uxwyEUlnTOx4YcBih0xE0hn7gMUYsKVDJiLpXPqALTFgS4dMRNK59AFbYsCWDpmIpHPpA9b/q904frZVYze/dBvIq1WQ9Edw8+Hk8kvwZ7/BHB33rF+CKHh4+f592E5+ePkOdpTdd87l+AWAQUrHQEvwxY5vVAAlA5TueUplWrl9+g14GgR6eT8IxpopeDzyM8gIOcjI+87QhDw5t9ffneTdHs83D8IhiC9kdngQrI9PekCHQ9Bh5sQeml2nt+4fjYD4BIhP8uU8IQ3iMsyJOAlR/QSBxTFb76k7Uws6qEAH+ePV6mwxaoCReMlW8t7mArGBvBLMvPIVR1GC/i75wO37s5EgJQC5gj+hxFQKMJWCP5VekiowAZrXNXT+GAy8BlDwptI/VAzkQFUT7MC6I8NABVRswas94P2QQccAAiJm52aOeg3CEhAheankv+QKphPQb0QnEBuu7PBy/6AIBOPOMgz7T9V/9v8Xsv80/eey+9TMcUc/3wCmEBTBkJfQowNuYLSBluRlzfF3bkBAIB6WxPFdH4ATyJWYB3f/KjioAABJ2U+J5o0PeAcXXGxARTE8ZE4Ho0FUYHQEj2fiSCCYMRCV5CVe+240iAgE1APLq7xTpwRBcKB4Kt40Tp73A6pgYhWPMOL9LQAbqKQxWw8cUwKhAW4VjzX69S0QHajQMU9y6sggiBN0WfFWYN3vQQEJwB1PYHpNooGY4SXFSI1YG4KpMLzEGGm2dwCEMLzJ4eEC3ycehMCVrV/9R7yRHB3HAqkM+iz7ZNZMzeF3L0AlX4LaoHg64zNbIDoAneyvhZqrypubCAzAkjc34FAPCBXMsewv45pXFefPx4L8AS4UbxTGR16BGFiFqAvjJFddYOIV71p3PJ0K1loAcMXL6k7k9JI7qILgKhXxtNofSwBTCoZI8oZo9JtkgxYYHV5lQWdpwQiBxYDiLbeK09uz+22SlKm/HjSgmEY80f6n+EBgIC6eQjHacwF3TTyB7iXGpHvHEWQ0KBpL3uWvxBgCAR7Jx4RoM4RiEUx/zBue00lMMMRgjDWP6NEpOqAFIjK8el/jRWAIoAl5wzQ+7gnCgbPPI7CeWFApkPeKl2vDsVAgAyDQbBny0qBA3Ta8NS19sg0kC0DB8MbreMQRiIBqa3hU4hNFQArgFPGk2uNAIEVAMBGvAMBDPEAIVMiIx2V3tBoUftAb2d96a57U8SQDiAfe7jMy7fMiKNPSZmlug4fV5+/f/wFNk1pT'; diff --git a/docs/classes/AbstractNavigator.html b/docs/classes/AbstractNavigator.html index dedec733..e109e69f 100644 --- a/docs/classes/AbstractNavigator.html +++ b/docs/classes/AbstractNavigator.html @@ -93,7 +93,7 @@

Class AbstractNavigator

  • Defined in projects/auth0-angular/src/lib/abstract-navigator.ts:8
  • @@ -237,7 +237,7 @@

  • Defined in projects/auth0-angular/src/lib/abstract-navigator.ts:11
  • @@ -326,7 +326,7 @@

  • Defined in projects/auth0-angular/src/lib/abstract-navigator.ts:23
  • diff --git a/docs/classes/Auth0ClientFactory.html b/docs/classes/Auth0ClientFactory.html index 10d59e2d..9141d21e 100644 --- a/docs/classes/Auth0ClientFactory.html +++ b/docs/classes/Auth0ClientFactory.html @@ -93,7 +93,7 @@

    Class Auth0ClientFactory

  • Defined in projects/auth0-angular/src/lib/auth.client.ts:6
  • @@ -287,7 +287,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.client.ts:7
  • diff --git a/docs/classes/AuthClientConfig.html b/docs/classes/AuthClientConfig.html index 552bb768..477d553b 100644 --- a/docs/classes/AuthClientConfig.html +++ b/docs/classes/AuthClientConfig.html @@ -118,7 +118,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.config.ts:238
  • @@ -337,7 +337,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.config.ts:256
  • @@ -410,7 +410,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.config.ts:249
  • diff --git a/docs/classes/AuthGuard.html b/docs/classes/AuthGuard.html index c6266f69..0cf0dcbd 100644 --- a/docs/classes/AuthGuard.html +++ b/docs/classes/AuthGuard.html @@ -93,7 +93,7 @@

    Class AuthGuard

  • Defined in projects/auth0-angular/src/lib/auth.guard.ts:15
  • @@ -247,7 +247,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.guard.ts:16
  • @@ -348,7 +348,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.guard.ts:22
  • @@ -436,7 +436,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.guard.ts:29
  • @@ -514,7 +514,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.guard.ts:18
  • diff --git a/docs/classes/AuthHttpInterceptor.html b/docs/classes/AuthHttpInterceptor.html index 03e22d9f..d011d665 100644 --- a/docs/classes/AuthHttpInterceptor.html +++ b/docs/classes/AuthHttpInterceptor.html @@ -99,7 +99,7 @@

    Implements

  • Defined in projects/auth0-angular/src/lib/auth.interceptor.ts:45
  • @@ -292,7 +292,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.interceptor.ts:46
  • @@ -414,7 +414,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.interceptor.ts:53
  • diff --git a/docs/classes/AuthModule.html b/docs/classes/AuthModule.html index d63c018a..8a9a8616 100644 --- a/docs/classes/AuthModule.html +++ b/docs/classes/AuthModule.html @@ -93,7 +93,7 @@

    Class AuthModule

  • Defined in projects/auth0-angular/src/lib/auth.module.ts:8
  • @@ -301,7 +301,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.module.ts:15
  • diff --git a/docs/classes/AuthService.html b/docs/classes/AuthService.html index 40ad714d..68b3a8dc 100644 --- a/docs/classes/AuthService.html +++ b/docs/classes/AuthService.html @@ -121,8 +121,8 @@

    Implements

  • Defined in projects/auth0-angular/src/lib/auth.service.ts:51projects/auth0-angular/src/lib/auth.service.ts:60
  • @@ -205,6 +205,15 @@

    Properties

    isLoading$ + + mfa
  • Defined in projects/auth0-angular/src/lib/auth.service.ts:90projects/auth0-angular/src/lib/auth.service.ts:99
  • @@ -606,8 +615,8 @@
  • Defined in projects/auth0-angular/src/lib/auth.state.ts:26
  • @@ -307,7 +307,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.state.ts:112
  • @@ -361,7 +361,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.state.ts:127
  • @@ -668,7 +668,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.state.ts:136
  • @@ -736,7 +736,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.state.ts:145
  • @@ -807,7 +807,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.state.ts:119
  • diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index 4d9f3636..cc4aa971 100644 --- a/docs/classes/AuthenticationError.html +++ b/docs/classes/AuthenticationError.html @@ -100,7 +100,7 @@

    Class AuthenticationError

    -
    +

    Hierarchy (View SummaryClass ConnectError

    -
    +

    Hierarchy (View Summary) diff --git a/docs/classes/GenericError.html b/docs/classes/GenericError.html index f4b750a9..e6d8b5d5 100644 --- a/docs/classes/GenericError.html +++ b/docs/classes/GenericError.html @@ -93,7 +93,7 @@

    Class GenericError

    Thrown when network requests to the Auth server fail.

    -
    +

    Hierarchy (View Summary) @@ -119,6 +119,13 @@

    >MfaRequiredError +
  • + PopupOpenError +
  • >UseDpopNonceError
  • +
  • + MfaError +
  • diff --git a/docs/classes/MfaChallengeError.html b/docs/classes/MfaChallengeError.html new file mode 100644 index 00000000..0c25808e --- /dev/null +++ b/docs/classes/MfaChallengeError.html @@ -0,0 +1,1243 @@ + + + + + + MfaChallengeError | @auth0/auth0-angular + + + + + + + + + + + + +
    +
    + @auth0/auth0-angular + + + + +
      +
      +
      Preparing search index...
      +
      +
      + +
      +
      +
      +
      +
      + +

      Class MfaChallengeError

      +
      +
      +
      +

      Error thrown when initiating an MFA challenge fails.

      +
      +
      +
      + +
      try {
      const challenge = await mfa.challenge({
      mfaToken: mfaToken,
      challengeType: 'otp',
      authenticatorId: 'otp|dev_123'
      });
      } catch (error) {
      if (error instanceof MfaChallengeError) {
      console.log(error.error); // 'too_many_attempts'
      console.log(error.error_description); // 'Rate limit exceeded'
      }
      } +
      +
      +
      +
      +
      +

      + Hierarchy (View Summary) +

      +
        +
      • + MfaError +
          +
        • + MfaChallengeError +
        • +
        +
      • +
      +
      + +
      +
      +
      + + +
      Index
      +
      + +
      +
      +
      +
      + + +

      Constructors

      +
      +
      +
      + +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • + error: + string +
        • +
        • + error_description: + string +
        • +
        +
        +

        + Returns + MfaChallengeError +

        + +
        +
      • +
      +
      +
      +
      +
      + + +

      Properties

      +
      +
      +
      + +
      + error: + string +
      + +
      +
      + +
      + error_description: + string +
      + +
      +
      + +
      + message: + string +
      + +
      +
      + +
      + name: + string +
      + +
      +
      + +
      + stack?: + string +
      + +
      +
      + +
      + stackTraceLimit: + number +
      +
      +

      + The Error.stackTraceLimit property specifies the + number of stack frames collected by a stack trace (whether + generated by new Error().stack or + Error.captureStackTrace(obj)). +

      +

      + The default value is 10 but may be set to any + valid JavaScript number. Changes will affect any stack trace + captured after the value has been changed. +

      +

      + If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +

      +
      + +
      +
      +
      +
      + + +

      Methods

      +
      +
      +
      + +
        +
      • + +
        +
        +

        + Creates a .stack property on + targetObject, which when accessed returns a + string representing the location in the code at which + Error.captureStackTrace() was called. +

        +
        const myObject = {};
        Error.captureStackTrace(myObject);
        myObject.stack; // Similar to `new Error().stack` +
        + +

        + The first line of the trace will be prefixed with + ${myObject.name}: ${myObject.message}. +

        +

        + The optional constructorOpt argument + accepts a function. If given, all frames above + constructorOpt, including + constructorOpt, will be omitted from the + generated stack trace. +

        +

        + The constructorOpt argument is useful for + hiding implementation details of error generation from + the user. For instance: +

        +
        function a() {
        b();
        }

        function b() {
        c();
        }

        function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
        }

        a(); +
        +
        +
        +

        Parameters

        +
          +
        • + targetObject: + object +
        • +
        • + OptionalconstructorOpt: + Function +
        • +
        +
        +

        + Returns void +

        + +
        +
      • +
      +
      +
      + +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • + __namedParameters: { + error: + string; + error_description: + string + } +
        • +
        +
        +

        + Returns + MfaError +

        + +
        +
      • +
      +
      +
      + + +
      +
      +
      +
      +
      + + +
      +
      +
      +
      + + diff --git a/docs/classes/MfaEnrollmentError.html b/docs/classes/MfaEnrollmentError.html new file mode 100644 index 00000000..825a3957 --- /dev/null +++ b/docs/classes/MfaEnrollmentError.html @@ -0,0 +1,1243 @@ + + + + + + MfaEnrollmentError | @auth0/auth0-angular + + + + + + + + + + + + +
      +
      + @auth0/auth0-angular + + + + +
        +
        +
        Preparing search index...
        +
        +
        + +
        +
        +
        +
        +
        + +

        Class MfaEnrollmentError

        +
        +
        +
        +

        Error thrown when enrolling an MFA authenticator fails.

        +
        +
        +
        + +
        try {
        const enrollment = await mfa.enroll({
        authenticator_types: ['otp']
        });
        } catch (error) {
        if (error instanceof MfaEnrollmentError) {
        console.log(error.error); // 'invalid_phone_number'
        console.log(error.error_description); // 'Invalid phone number format'
        }
        } +
        +
        +
        +
        +
        +

        + Hierarchy (View Summary) +

        +
          +
        • + MfaError +
            +
          • + MfaEnrollmentError +
          • +
          +
        • +
        +
        + +
        +
        +
        + + +
        Index
        +
        + +
        +
        +
        +
        + + +

        Constructors

        +
        +
        +
        + +
          +
        • + +
          +
          +

          Parameters

          +
            +
          • + error: + string +
          • +
          • + error_description: + string +
          • +
          +
          +

          + Returns + MfaEnrollmentError +

          + +
          +
        • +
        +
        +
        +
        +
        + + +

        Properties

        +
        +
        +
        + +
        + error: + string +
        + +
        +
        + +
        + error_description: + string +
        + +
        +
        + +
        + message: + string +
        + +
        +
        + +
        + name: + string +
        + +
        +
        + +
        + stack?: + string +
        + +
        +
        + +
        + stackTraceLimit: + number +
        +
        +

        + The Error.stackTraceLimit property specifies the + number of stack frames collected by a stack trace (whether + generated by new Error().stack or + Error.captureStackTrace(obj)). +

        +

        + The default value is 10 but may be set to any + valid JavaScript number. Changes will affect any stack trace + captured after the value has been changed. +

        +

        + If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +

        +
        + +
        +
        +
        +
        + + +

        Methods

        +
        +
        +
        + +
          +
        • + +
          +
          +

          + Creates a .stack property on + targetObject, which when accessed returns a + string representing the location in the code at which + Error.captureStackTrace() was called. +

          +
          const myObject = {};
          Error.captureStackTrace(myObject);
          myObject.stack; // Similar to `new Error().stack` +
          + +

          + The first line of the trace will be prefixed with + ${myObject.name}: ${myObject.message}. +

          +

          + The optional constructorOpt argument + accepts a function. If given, all frames above + constructorOpt, including + constructorOpt, will be omitted from the + generated stack trace. +

          +

          + The constructorOpt argument is useful for + hiding implementation details of error generation from + the user. For instance: +

          +
          function a() {
          b();
          }

          function b() {
          c();
          }

          function c() {
          // Create an error without stack trace to avoid calculating the stack trace twice.
          const { stackTraceLimit } = Error;
          Error.stackTraceLimit = 0;
          const error = new Error();
          Error.stackTraceLimit = stackTraceLimit;

          // Capture the stack trace above function b
          Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
          throw error;
          }

          a(); +
          +
          +
          +

          Parameters

          +
            +
          • + targetObject: + object +
          • +
          • + OptionalconstructorOpt: + Function +
          • +
          +
          +

          + Returns void +

          + +
          +
        • +
        +
        +
        + +
          +
        • + +
          +
          +

          Parameters

          +
            +
          • + __namedParameters: { + error: + string; + error_description: + string + } +
          • +
          +
          +

          + Returns + MfaError +

          + +
          +
        • +
        +
        +
        + + +
        +
        +
        +
        +
        + + +
        +
        +
        +
        + + diff --git a/docs/classes/MfaEnrollmentFactorsError.html b/docs/classes/MfaEnrollmentFactorsError.html new file mode 100644 index 00000000..111b87b1 --- /dev/null +++ b/docs/classes/MfaEnrollmentFactorsError.html @@ -0,0 +1,1247 @@ + + + + + + MfaEnrollmentFactorsError | @auth0/auth0-angular + + + + + + + + + + + + +
        +
        + @auth0/auth0-angular + + + + +
          +
          +
          Preparing search index...
          +
          +
          + +
          +
          +
          +
          +
          + +

          Class MfaEnrollmentFactorsError

          +
          +
          +
          +

          Error thrown when getting enrollment factors fails.

          +
          +
          +
          + +
          try {
          const factors = await mfa.getEnrollmentFactors(mfaToken);
          } catch (error) {
          if (error instanceof MfaEnrollmentFactorsError) {
          console.log(error.error); // 'mfa_context_not_found'
          console.log(error.error_description); // 'MFA context not found...'
          }
          } +
          +
          +
          +
          +
          +

          + Hierarchy (View Summary) +

          +
            +
          • + MfaError +
              +
            • + MfaEnrollmentFactorsError +
            • +
            +
          • +
          +
          + +
          +
          +
          + + +
          Index
          +
          + +
          +
          +
          +
          + + +

          Constructors

          +
          +
          +
          + +
            +
          • + +
            +
            +

            Parameters

            +
              +
            • + error: + string +
            • +
            • + error_description: + string +
            • +
            +
            +

            + Returns + MfaEnrollmentFactorsError +

            + +
            +
          • +
          +
          +
          +
          +
          + + +

          Properties

          +
          +
          +
          + +
          + error: + string +
          + +
          +
          + +
          + error_description: + string +
          + +
          +
          + +
          + message: + string +
          + +
          +
          + +
          + name: + string +
          + +
          +
          + +
          + stack?: + string +
          + +
          +
          + +
          + stackTraceLimit: + number +
          +
          +

          + The Error.stackTraceLimit property specifies the + number of stack frames collected by a stack trace (whether + generated by new Error().stack or + Error.captureStackTrace(obj)). +

          +

          + The default value is 10 but may be set to any + valid JavaScript number. Changes will affect any stack trace + captured after the value has been changed. +

          +

          + If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +

          +
          + +
          +
          +
          +
          + + +

          Methods

          +
          +
          +
          + +
            +
          • + +
            +
            +

            + Creates a .stack property on + targetObject, which when accessed returns a + string representing the location in the code at which + Error.captureStackTrace() was called. +

            +
            const myObject = {};
            Error.captureStackTrace(myObject);
            myObject.stack; // Similar to `new Error().stack` +
            + +

            + The first line of the trace will be prefixed with + ${myObject.name}: ${myObject.message}. +

            +

            + The optional constructorOpt argument + accepts a function. If given, all frames above + constructorOpt, including + constructorOpt, will be omitted from the + generated stack trace. +

            +

            + The constructorOpt argument is useful for + hiding implementation details of error generation from + the user. For instance: +

            +
            function a() {
            b();
            }

            function b() {
            c();
            }

            function c() {
            // Create an error without stack trace to avoid calculating the stack trace twice.
            const { stackTraceLimit } = Error;
            Error.stackTraceLimit = 0;
            const error = new Error();
            Error.stackTraceLimit = stackTraceLimit;

            // Capture the stack trace above function b
            Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
            throw error;
            }

            a(); +
            +
            +
            +

            Parameters

            +
              +
            • + targetObject: + object +
            • +
            • + OptionalconstructorOpt: + Function +
            • +
            +
            +

            + Returns void +

            + +
            +
          • +
          +
          +
          + +
            +
          • + +
            +
            +

            Parameters

            +
              +
            • + __namedParameters: { + error: + string; + error_description: + string + } +
            • +
            +
            +

            + Returns + MfaError +

            + +
            +
          • +
          +
          +
          + + +
          +
          +
          +
          +
          + + +
          +
          +
          +
          + + diff --git a/docs/classes/MfaError.html b/docs/classes/MfaError.html new file mode 100644 index 00000000..a365d19a --- /dev/null +++ b/docs/classes/MfaError.html @@ -0,0 +1,1259 @@ + + + + + + MfaError | @auth0/auth0-angular + + + + + + + + + + + + +
          +
          + @auth0/auth0-angular + + + + +
            +
            +
            Preparing search index...
            +
            +
            + +
            +
            +
            +
            +
            + +

            Class MfaError

            +
            +
            +
            +

            + Base class for MFA-related errors in auth0-spa-js. Extends + GenericError for unified error hierarchy across the SDK. +

            +
            +
            +
            +

            + Hierarchy (View Summary) +

            + +
            + +
            +
            +
            + + +
            Index
            +
            + +
            +
            +
            +
            + + +

            Constructors

            +
            +
            +
            + +
              +
            • + +
              +
              +

              Parameters

              +
                +
              • + error: + string +
              • +
              • + error_description: + string +
              • +
              +
              +

              + Returns + MfaError +

              + +
              +
            • +
            +
            +
            +
            +
            + + +

            Properties

            +
            +
            +
            + +
            + error: + string +
            + +
            +
            + +
            + error_description: + string +
            + +
            +
            + +
            + message: + string +
            + +
            +
            + +
            + name: + string +
            + +
            +
            + +
            + stack?: + string +
            + +
            +
            + +
            + stackTraceLimit: + number +
            +
            +

            + The Error.stackTraceLimit property specifies the + number of stack frames collected by a stack trace (whether + generated by new Error().stack or + Error.captureStackTrace(obj)). +

            +

            + The default value is 10 but may be set to any + valid JavaScript number. Changes will affect any stack trace + captured after the value has been changed. +

            +

            + If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +

            +
            + +
            +
            +
            +
            + + +

            Methods

            +
            +
            +
            + +
              +
            • + +
              +
              +

              + Creates a .stack property on + targetObject, which when accessed returns a + string representing the location in the code at which + Error.captureStackTrace() was called. +

              +
              const myObject = {};
              Error.captureStackTrace(myObject);
              myObject.stack; // Similar to `new Error().stack` +
              + +

              + The first line of the trace will be prefixed with + ${myObject.name}: ${myObject.message}. +

              +

              + The optional constructorOpt argument + accepts a function. If given, all frames above + constructorOpt, including + constructorOpt, will be omitted from the + generated stack trace. +

              +

              + The constructorOpt argument is useful for + hiding implementation details of error generation from + the user. For instance: +

              +
              function a() {
              b();
              }

              function b() {
              c();
              }

              function c() {
              // Create an error without stack trace to avoid calculating the stack trace twice.
              const { stackTraceLimit } = Error;
              Error.stackTraceLimit = 0;
              const error = new Error();
              Error.stackTraceLimit = stackTraceLimit;

              // Capture the stack trace above function b
              Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
              throw error;
              }

              a(); +
              +
              +
              +

              Parameters

              +
                +
              • + targetObject: + object +
              • +
              • + OptionalconstructorOpt: + Function +
              • +
              +
              +

              + Returns void +

              + +
              +
            • +
            +
            +
            + +
              +
            • + +
              +
              +

              Parameters

              +
                +
              • + __namedParameters: { + error: + string; + error_description: + string + } +
              • +
              +
              +

              + Returns + MfaError +

              + +
              +
            • +
            +
            +
            + + +
            +
            +
            +
            +
            + + +
            +
            +
            +
            + + diff --git a/docs/classes/MfaListAuthenticatorsError.html b/docs/classes/MfaListAuthenticatorsError.html new file mode 100644 index 00000000..6bf750ad --- /dev/null +++ b/docs/classes/MfaListAuthenticatorsError.html @@ -0,0 +1,1247 @@ + + + + + + MfaListAuthenticatorsError | @auth0/auth0-angular + + + + + + + + + + + + +
            +
            + @auth0/auth0-angular + + + + +
              +
              +
              Preparing search index...
              +
              +
              + +
              +
              +
              +
              +
              + +

              Class MfaListAuthenticatorsError

              +
              +
              +
              +

              Error thrown when listing MFA authenticators fails.

              +
              +
              +
              + +
              try {
              const authenticators = await mfa.getAuthenticators();
              } catch (error) {
              if (error instanceof MfaListAuthenticatorsError) {
              console.log(error.error); // 'access_denied'
              console.log(error.error_description); // 'Unauthorized'
              }
              } +
              +
              +
              +
              +
              +

              + Hierarchy (View Summary) +

              +
                +
              • + MfaError +
                  +
                • + MfaListAuthenticatorsError +
                • +
                +
              • +
              +
              + +
              +
              +
              + + +
              Index
              +
              + +
              +
              +
              +
              + + +

              Constructors

              +
              +
              +
              + +
                +
              • + +
                +
                +

                Parameters

                +
                  +
                • + error: + string +
                • +
                • + error_description: + string +
                • +
                +
                +

                + Returns + MfaListAuthenticatorsError +

                + +
                +
              • +
              +
              +
              +
              +
              + + +

              Properties

              +
              +
              +
              + +
              + error: + string +
              + +
              +
              + +
              + error_description: + string +
              + +
              +
              + +
              + message: + string +
              + +
              +
              + +
              + name: + string +
              + +
              +
              + +
              + stack?: + string +
              + +
              +
              + +
              + stackTraceLimit: + number +
              +
              +

              + The Error.stackTraceLimit property specifies the + number of stack frames collected by a stack trace (whether + generated by new Error().stack or + Error.captureStackTrace(obj)). +

              +

              + The default value is 10 but may be set to any + valid JavaScript number. Changes will affect any stack trace + captured after the value has been changed. +

              +

              + If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +

              +
              + +
              +
              +
              +
              + + +

              Methods

              +
              +
              +
              + +
                +
              • + +
                +
                +

                + Creates a .stack property on + targetObject, which when accessed returns a + string representing the location in the code at which + Error.captureStackTrace() was called. +

                +
                const myObject = {};
                Error.captureStackTrace(myObject);
                myObject.stack; // Similar to `new Error().stack` +
                + +

                + The first line of the trace will be prefixed with + ${myObject.name}: ${myObject.message}. +

                +

                + The optional constructorOpt argument + accepts a function. If given, all frames above + constructorOpt, including + constructorOpt, will be omitted from the + generated stack trace. +

                +

                + The constructorOpt argument is useful for + hiding implementation details of error generation from + the user. For instance: +

                +
                function a() {
                b();
                }

                function b() {
                c();
                }

                function c() {
                // Create an error without stack trace to avoid calculating the stack trace twice.
                const { stackTraceLimit } = Error;
                Error.stackTraceLimit = 0;
                const error = new Error();
                Error.stackTraceLimit = stackTraceLimit;

                // Capture the stack trace above function b
                Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                throw error;
                }

                a(); +
                +
                +
                +

                Parameters

                +
                  +
                • + targetObject: + object +
                • +
                • + OptionalconstructorOpt: + Function +
                • +
                +
                +

                + Returns void +

                + +
                +
              • +
              +
              +
              + +
                +
              • + +
                +
                +

                Parameters

                +
                  +
                • + __namedParameters: { + error: + string; + error_description: + string + } +
                • +
                +
                +

                + Returns + MfaError +

                + +
                +
              • +
              +
              +
              + + +
              +
              +
              +
              +
              + + +
              +
              +
              +
              + + diff --git a/docs/classes/MfaRequiredError.html b/docs/classes/MfaRequiredError.html index 7c7881fd..d013fe42 100644 --- a/docs/classes/MfaRequiredError.html +++ b/docs/classes/MfaRequiredError.html @@ -96,7 +96,7 @@

              Class MfaRequiredError

              -
              +

              Hierarchy (View Summary + + + + + MfaVerifyError | @auth0/auth0-angular + + + + + + + + + + + + +
              +
              + @auth0/auth0-angular + + + + +
                +
                +
                Preparing search index...
                +
                +
                + +
                +
                +
                +
                +
                + +

                Class MfaVerifyError

                +
                +
                +
                +

                Error thrown when verifying an MFA challenge fails.

                +
                +
                +
                + +
                try {
                const tokens = await mfa.verify({
                mfaToken: mfaToken,
                grant_type: 'http://auth0.com/oauth/grant-type/mfa-otp',
                otp: '123456'
                });
                } catch (error) {
                if (error instanceof MfaVerifyError) {
                console.log(error.error); // 'invalid_otp' or 'context_not_found'
                console.log(error.error_description); // Error details
                }
                } +
                +
                +
                +
                +
                +

                + Hierarchy (View Summary) +

                +
                  +
                • + MfaError +
                    +
                  • + MfaVerifyError +
                  • +
                  +
                • +
                +
                + +
                +
                +
                + + +
                Index
                +
                + +
                +
                +
                +
                + + +

                Constructors

                +
                +
                +
                + +
                  +
                • + +
                  +
                  +

                  Parameters

                  +
                    +
                  • + error: + string +
                  • +
                  • + error_description: + string +
                  • +
                  +
                  +

                  + Returns + MfaVerifyError +

                  + +
                  +
                • +
                +
                +
                +
                +
                + + +

                Properties

                +
                +
                +
                + +
                + error: + string +
                + +
                +
                + +
                + error_description: + string +
                + +
                +
                + +
                + message: + string +
                + +
                +
                + +
                + name: + string +
                + +
                +
                + +
                + stack?: + string +
                + +
                +
                + +
                + stackTraceLimit: + number +
                +
                +

                + The Error.stackTraceLimit property specifies the + number of stack frames collected by a stack trace (whether + generated by new Error().stack or + Error.captureStackTrace(obj)). +

                +

                + The default value is 10 but may be set to any + valid JavaScript number. Changes will affect any stack trace + captured after the value has been changed. +

                +

                + If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +

                +
                + +
                +
                +
                +
                + + +

                Methods

                +
                +
                +
                + +
                  +
                • + +
                  +
                  +

                  + Creates a .stack property on + targetObject, which when accessed returns a + string representing the location in the code at which + Error.captureStackTrace() was called. +

                  +
                  const myObject = {};
                  Error.captureStackTrace(myObject);
                  myObject.stack; // Similar to `new Error().stack` +
                  + +

                  + The first line of the trace will be prefixed with + ${myObject.name}: ${myObject.message}. +

                  +

                  + The optional constructorOpt argument + accepts a function. If given, all frames above + constructorOpt, including + constructorOpt, will be omitted from the + generated stack trace. +

                  +

                  + The constructorOpt argument is useful for + hiding implementation details of error generation from + the user. For instance: +

                  +
                  function a() {
                  b();
                  }

                  function b() {
                  c();
                  }

                  function c() {
                  // Create an error without stack trace to avoid calculating the stack trace twice.
                  const { stackTraceLimit } = Error;
                  Error.stackTraceLimit = 0;
                  const error = new Error();
                  Error.stackTraceLimit = stackTraceLimit;

                  // Capture the stack trace above function b
                  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                  throw error;
                  }

                  a(); +
                  +
                  +
                  +

                  Parameters

                  +
                    +
                  • + targetObject: + object +
                  • +
                  • + OptionalconstructorOpt: + Function +
                  • +
                  +
                  +

                  + Returns void +

                  + +
                  +
                • +
                +
                +
                + +
                  +
                • + +
                  +
                  +

                  Parameters

                  +
                    +
                  • + __namedParameters: { + error: + string; + error_description: + string + } +
                  • +
                  +
                  +

                  + Returns + MfaError +

                  + +
                  +
                • +
                +
                +
                + + +
                +
                +
                +
                +
                + + +
                +
                +
                +
                + + diff --git a/docs/classes/MissingRefreshTokenError.html b/docs/classes/MissingRefreshTokenError.html index 976f1feb..fcb9f15f 100644 --- a/docs/classes/MissingRefreshTokenError.html +++ b/docs/classes/MissingRefreshTokenError.html @@ -93,7 +93,7 @@

                Class MissingRefreshTokenError

                Error thrown when there is no refresh token to use

                -
                +

                Hierarchy (View SummaryClass PopupCancelledError

                Thrown when network requests to the Auth server fail.

                -
                +

                Hierarchy (View Summary + + + + + PopupOpenError | @auth0/auth0-angular + + + + + + + + + + + + +
                +
                + @auth0/auth0-angular + + + + +
                  +
                  +
                  Preparing search index...
                  +
                  +
                  + +
                  +
                  +
                  +
                  +
                  + +

                  Class PopupOpenError

                  +
                  +
                  +
                  +

                  Thrown when network requests to the Auth server fail.

                  +
                  +
                  +
                  +

                  + Hierarchy (View Summary) +

                  + +
                  + +
                  +
                  +
                  + + +
                  Index
                  +
                  + +
                  +
                  +
                  +
                  + + +

                  Constructors

                  +
                  +
                  +
                  + + +
                  +
                  +
                  +
                  + + +

                  Properties

                  +
                  +
                  +
                  + +
                  + error: + string +
                  + +
                  +
                  + +
                  + error_description: + string +
                  + +
                  +
                  + +
                  + message: + string +
                  + +
                  +
                  + +
                  + name: + string +
                  + +
                  +
                  + +
                  + stack?: + string +
                  + +
                  +
                  + +
                  + stackTraceLimit: + number +
                  +
                  +

                  + The Error.stackTraceLimit property specifies the + number of stack frames collected by a stack trace (whether + generated by new Error().stack or + Error.captureStackTrace(obj)). +

                  +

                  + The default value is 10 but may be set to any + valid JavaScript number. Changes will affect any stack trace + captured after the value has been changed. +

                  +

                  + If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +

                  +
                  + +
                  +
                  +
                  +
                  + + +

                  Methods

                  +
                  +
                  +
                  + +
                    +
                  • + +
                    +
                    +

                    + Creates a .stack property on + targetObject, which when accessed returns a + string representing the location in the code at which + Error.captureStackTrace() was called. +

                    +
                    const myObject = {};
                    Error.captureStackTrace(myObject);
                    myObject.stack; // Similar to `new Error().stack` +
                    + +

                    + The first line of the trace will be prefixed with + ${myObject.name}: ${myObject.message}. +

                    +

                    + The optional constructorOpt argument + accepts a function. If given, all frames above + constructorOpt, including + constructorOpt, will be omitted from the + generated stack trace. +

                    +

                    + The constructorOpt argument is useful for + hiding implementation details of error generation from + the user. For instance: +

                    +
                    function a() {
                    b();
                    }

                    function b() {
                    c();
                    }

                    function c() {
                    // Create an error without stack trace to avoid calculating the stack trace twice.
                    const { stackTraceLimit } = Error;
                    Error.stackTraceLimit = 0;
                    const error = new Error();
                    Error.stackTraceLimit = stackTraceLimit;

                    // Capture the stack trace above function b
                    Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                    throw error;
                    }

                    a(); +
                    +
                    +
                    +

                    Parameters

                    +
                      +
                    • + targetObject: + object +
                    • +
                    • + OptionalconstructorOpt: + Function +
                    • +
                    +
                    +

                    + Returns void +

                    + +
                    +
                  • +
                  +
                  +
                  + +
                    +
                  • + +
                    +
                    +

                    Parameters

                    +
                      +
                    • + __namedParameters: { + error: + string; + error_description: + string + } +
                    • +
                    +
                    +

                    + Returns + GenericError +

                    + +
                    +
                  • +
                  +
                  +
                  + + +
                  +
                  +
                  +
                  +
                  + + +
                  +
                  +
                  +
                  + + diff --git a/docs/classes/PopupTimeoutError.html b/docs/classes/PopupTimeoutError.html index 3f123053..9a271257 100644 --- a/docs/classes/PopupTimeoutError.html +++ b/docs/classes/PopupTimeoutError.html @@ -96,7 +96,7 @@

                  Class PopupTimeoutError

                  -
                  +

                  Hierarchy (View SummaryClass TimeoutError

                  -
                  +

                  Hierarchy (View Summary) diff --git a/docs/classes/UseDpopNonceError.html b/docs/classes/UseDpopNonceError.html index 2717dc13..c098c5da 100644 --- a/docs/classes/UseDpopNonceError.html +++ b/docs/classes/UseDpopNonceError.html @@ -96,7 +96,7 @@

                  Class UseDpopNonceError

                  -
                  +

                  Hierarchy (View SummaryEnumeration HttpMethodConst

                • Defined in projects/auth0-angular/src/lib/auth.config.ts:15
                • @@ -221,7 +221,7 @@

                • Defined in projects/auth0-angular/src/lib/auth.config.ts:17
                • @@ -346,7 +346,7 @@

                • Defined in projects/auth0-angular/src/lib/functional.ts:17
                • diff --git a/docs/functions/authHttpInterceptorFn.html b/docs/functions/authHttpInterceptorFn.html index fe6a9613..eb901a81 100644 --- a/docs/functions/authHttpInterceptorFn.html +++ b/docs/functions/authHttpInterceptorFn.html @@ -214,7 +214,7 @@

                • Defined in projects/auth0-angular/src/lib/functional.ts:32
                • diff --git a/docs/functions/isHttpInterceptorRouteConfig.html b/docs/functions/isHttpInterceptorRouteConfig.html index b5b6de15..9567d029 100644 --- a/docs/functions/isHttpInterceptorRouteConfig.html +++ b/docs/functions/isHttpInterceptorRouteConfig.html @@ -164,7 +164,7 @@

                • Defined in projects/auth0-angular/src/lib/auth.config.ts:37
                • diff --git a/docs/functions/provideAuth0.html b/docs/functions/provideAuth0.html index 0e2a0ba7..c93fe096 100644 --- a/docs/functions/provideAuth0.html +++ b/docs/functions/provideAuth0.html @@ -171,7 +171,7 @@

                  Hierarchy Summary

                    -
                  • +
                  • Hierarchy Summary >ICache
                      -
                    • +
                    • Hierarchy Summary >PopupLoginOptions
                        -
                      • +
                      • Indexable
                      • Defined in projects/auth0-angular/src/lib/auth.config.ts:153
                      • @@ -262,7 +262,7 @@

                        Interface AuthConfig

                        >} -
                        +

                        Hierarchy

                        • @@ -310,7 +310,7 @@

                          Hierarchy

                        • Defined in projects/auth0-angular/src/lib/auth.config.ts:109
                        • @@ -1002,7 +1002,7 @@

                          Interface GetTokenWithPopupOptions

                          >} -
                          +

                          Hierarchy (View SummaryInterface HttpInterceptorConfig

                        • Defined in projects/auth0-angular/src/lib/auth.config.ts:46
                        • @@ -195,7 +195,7 @@

                          Interface HttpInterceptorRouteConfig

                        • Defined in projects/auth0-angular/src/lib/auth.config.ts:53
                        • @@ -269,7 +269,7 @@

                          Interface LogoutOptions

                          >;
                          } -
                          +

                          Hierarchy

                          diff --git a/docs/interfaces/ObservableMfaApiClient.html b/docs/interfaces/ObservableMfaApiClient.html new file mode 100644 index 00000000..06307247 --- /dev/null +++ b/docs/interfaces/ObservableMfaApiClient.html @@ -0,0 +1,1036 @@ + + + + + + ObservableMfaApiClient | @auth0/auth0-angular + + + + + + + + + + + + +
                          +
                          + @auth0/auth0-angular + + + + +
                            +
                            +
                            Preparing search index...
                            +
                            +
                            + +
                            +
                            +
                            +
                            +
                            + +

                            Interface ObservableMfaApiClient

                            +
                            +
                            +
                            +

                            + Observable-based MFA API client exposed by + AuthService.mfa. +

                            +

                            + This is the Angular counterpart of MfaApiClient from + @auth0/auth0-spa-js. All methods return + Observable instead of Promise. +

                            +
                            +
                            +
                            + interface + ObservableMfaApiClient + {
                                challenge(
                                    params: + ChallengeAuthenticatorParams,
                                ): + Observable<ChallengeResponse>;
                                enroll(params: + EnrollParams): + Observable<EnrollmentResponse>;
                                getAuthenticators(mfaToken: + string): + Observable<Authenticator[]>;
                                getEnrollmentFactors(mfaToken: + string): + Observable<EnrollmentFactor[]>;
                                verify(params: + VerifyParams): + Observable<TokenEndpointResponse>;
                            } +
                            + +
                            +
                            +
                            + + +
                            Index
                            +
                            + +
                            +
                            +
                            +
                            + + +

                            Methods

                            +
                            +
                            +
                            + + +
                            +
                            + + +
                            +
                            + +
                              +
                            • + +
                              +
                              +

                              + Returns the list of enrolled MFA authenticators for the + current user, filtered by the challenge types stored in + the MFA context. +

                              +
                              +
                              +

                              Parameters

                              +
                                +
                              • + mfaToken: + string +
                              • +
                              +
                              +

                              + Returns Observable<Authenticator[]> +

                              +
                              +
                              + +
                              +
                              + +
                              +
                            • +
                            +
                            +
                            + +
                              +
                            • + +
                              +
                              +

                              + Returns the available enrollment factors from the stored + MFA context. A non-empty result means the user must + enroll before they can authenticate. +

                              +
                              +
                              +

                              Parameters

                              +
                                +
                              • + mfaToken: + string +
                              • +
                              +
                              +

                              + Returns Observable<EnrollmentFactor[]> +

                              +
                              +
                              + +
                              +
                              + +
                              +
                            • +
                            +
                            +
                            + +
                              +
                            • + +
                              +
                              +

                              + Verifies an MFA challenge and returns raw tokens. The + grant type is inferred automatically from the provided + field: otp, oobCode, or + recoveryCode. Angular auth state + (isAuthenticated$, user$) is + not updated automatically — call + getAccessTokenSilently() afterwards to + reflect the new session. +

                              +
                              +
                              +

                              Parameters

                              + +
                              +

                              + Returns Observable<TokenEndpointResponse> +

                              +
                              +
                              + +
                              +
                              + +
                              +
                            • +
                            +
                            +
                            +
                            +
                            +
                            + + +
                            +
                            +
                            +
                            + + diff --git a/docs/interfaces/OobEnrollmentResponse.html b/docs/interfaces/OobEnrollmentResponse.html new file mode 100644 index 00000000..98d9ec0d --- /dev/null +++ b/docs/interfaces/OobEnrollmentResponse.html @@ -0,0 +1,708 @@ + + + + + + OobEnrollmentResponse | @auth0/auth0-angular + + + + + + + + + + + + +
                            +
                            + @auth0/auth0-angular + + + + +
                              +
                              +
                              Preparing search index...
                              +
                              +
                              + +
                              +
                              +
                              +
                              +
                              + +

                              Interface OobEnrollmentResponse

                              +
                              +
                              +
                              +

                              Response when enrolling an OOB authenticator

                              +
                              +
                              +
                              + interface + OobEnrollmentResponse + {
                                  authenticatorType: + "oob";
                                  barcodeUri?: + string;
                                  bindingMethod?: + string;
                                  id?: + string;
                                  oobChannel: + OobChannel;
                                  oobCode?: + string;
                                  recoveryCodes?: + string[];
                              } +
                              + +
                              +
                              +
                              + + +
                              Index
                              +
                              + +
                              +
                              +
                              +
                              + + +

                              Properties

                              +
                              +
                              +
                              + +
                              + authenticatorType: + "oob" +
                              +
                              +

                              Authenticator type

                              +
                              + +
                              +
                              + +
                              + barcodeUri?: + string +
                              +
                              +

                              URI for QR code (for Push/Guardian enrollment)

                              +
                              + +
                              +
                              + +
                              + bindingMethod?: + string +
                              +
                              +

                              Binding method (e.g., 'prompt' for user code entry)

                              +
                              + +
                              +
                              + +
                              + id?: + string +
                              +
                              +

                              Authenticator ID

                              +
                              + +
                              +
                              + +
                              + oobChannel: + OobChannel +
                              +
                              +

                              Delivery channel used

                              +
                              + +
                              +
                              + +
                              + oobCode?: + string +
                              +
                              +

                              Out-of-band code for verification

                              +
                              + +
                              +
                              + +
                              + recoveryCodes?: + string[] +
                              +
                              +

                              + Recovery codes (generated when enrolling first MFA factor) +

                              +
                              + +
                              +
                              +
                              +
                              +
                              + + +
                              +
                              +
                              +
                              + + diff --git a/docs/interfaces/OtpEnrollmentResponse.html b/docs/interfaces/OtpEnrollmentResponse.html new file mode 100644 index 00000000..2dc3ea04 --- /dev/null +++ b/docs/interfaces/OtpEnrollmentResponse.html @@ -0,0 +1,593 @@ + + + + + + OtpEnrollmentResponse | @auth0/auth0-angular + + + + + + + + + + + + +
                              +
                              + @auth0/auth0-angular + + + + +
                                +
                                +
                                Preparing search index...
                                +
                                +
                                + +
                                +
                                +
                                +
                                +
                                + +

                                Interface OtpEnrollmentResponse

                                +
                                +
                                +
                                +

                                Response when enrolling an OTP authenticator

                                +
                                +
                                +
                                + interface + OtpEnrollmentResponse + {
                                    authenticatorType: + "otp";
                                    barcodeUri: + string;
                                    id?: + string;
                                    recoveryCodes?: + string[];
                                    secret: + string;
                                } +
                                + +
                                +
                                +
                                + + +
                                Index
                                +
                                + +
                                +
                                +
                                +
                                + + +

                                Properties

                                +
                                +
                                +
                                + +
                                + authenticatorType: + "otp" +
                                +
                                +

                                Authenticator type

                                +
                                + +
                                +
                                + +
                                + barcodeUri: + string +
                                +
                                +

                                URI for generating QR code (otpauth://...)

                                +
                                + +
                                +
                                + +
                                + id?: + string +
                                +
                                +

                                Authenticator ID

                                +
                                + +
                                +
                                + +
                                + recoveryCodes?: + string[] +
                                +
                                +

                                Recovery codes for account recovery

                                +
                                + +
                                +
                                + +
                                + secret: + string +
                                +
                                +

                                Base32-encoded secret for TOTP generation

                                +
                                + +
                                +
                                +
                                +
                                +
                                + + +
                                +
                                +
                                +
                                + + diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 1675c5f6..5fe90983 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -105,7 +105,7 @@

                                Interface PopupLoginOptions

                                >} -
                                +

                                Hierarchy (View SummaryType Parameters

                              -
                              +

                              Hierarchy

                              diff --git a/docs/interfaces/VerifyParams.html b/docs/interfaces/VerifyParams.html new file mode 100644 index 00000000..8ed60d30 --- /dev/null +++ b/docs/interfaces/VerifyParams.html @@ -0,0 +1,603 @@ + + + + + + VerifyParams | @auth0/auth0-angular + + + + + + + + + + + + +
                              +
                              + @auth0/auth0-angular + + + + +
                                +
                                +
                                Preparing search index...
                                +
                                +
                                + +
                                +
                                +
                                +
                                +
                                + +

                                Interface VerifyParams

                                +
                                +
                                +
                                +

                                Parameters for verifying an MFA challenge.

                                +

                                + The grant_type is automatically inferred from which verification + field is provided: +

                                +
                                  +
                                • otp field → MFA-OTP grant type
                                • +
                                • oobCode field → MFA-OOB grant type
                                • +
                                • + recoveryCode field → MFA-RECOVERY-CODE grant type +
                                • +
                                +
                                +
                                +
                                + interface + VerifyParams + {
                                    bindingCode?: + string;
                                    mfaToken: + string;
                                    oobCode?: + string;
                                    otp?: + string;
                                    recoveryCode?: + string;
                                } +
                                + +
                                +
                                +
                                + + +
                                Index
                                +
                                + +
                                +
                                +
                                +
                                + + +

                                Properties

                                +
                                +
                                +
                                + +
                                + bindingCode?: + string +
                                +
                                +

                                Binding code (for OOB challenges with binding)

                                +
                                + +
                                +
                                + +
                                + mfaToken: + string +
                                +
                                +

                                MFA token from challenge flow

                                +
                                + +
                                +
                                + +
                                + oobCode?: + string +
                                +
                                +

                                Out-of-band code (for OOB challenges)

                                +
                                + +
                                +
                                + +
                                + otp?: + string +
                                +
                                +

                                One-time password (for OTP challenges)

                                +
                                + +
                                +
                                + +
                                + recoveryCode?: + string +
                                +
                                +

                                Recovery code (for recovery code verification)

                                +
                                + +
                                +
                                +
                                +
                                +
                                + + +
                                +
                                +
                                +
                                + + diff --git a/docs/modules.html b/docs/modules.html index c2bc3b42..eeea825f 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -411,6 +411,110 @@

                                Classes

                                >
                                +
                                + + MfaChallengeError +
                                +
                                +
                                + + MfaEnrollmentError +
                                +
                                +
                                + + MfaEnrollmentFactorsError +
                                +
                                +
                                + + MfaError +
                                +
                                +
                                + + MfaListAuthenticatorsError +
                                +
                                Classes >
                                +
                                + + MfaVerifyError +
                                +
                                Classes >
                                +
                                + + PopupOpenError +
                                +
                                Interfaces >
                                +
                                + + Authenticator +
                                +
                                Interfaces >
                                +
                                + + ChallengeAuthenticatorParams +
                                +
                                +
                                + + ChallengeResponse +
                                +
                                +
                                + + EnrollEmailParams +
                                +
                                +
                                + + EnrollmentFactor +
                                +
                                +
                                + + EnrollOtpParams +
                                +
                                +
                                + + EnrollPushParams +
                                +
                                +
                                + + EnrollSmsParams +
                                +
                                +
                                + + EnrollVoiceParams +
                                +
                                Interfaces >
                                +
                                + + ObservableMfaApiClient +
                                +
                                +
                                + + OobEnrollmentResponse +
                                +
                                +
                                + + OtpEnrollmentResponse +
                                +
                                Interfaces viewBox="0 0 24 24" aria-label="Interface" > - RedirectConnectAccountOptionsRedirectConnectAccountOptions +
                                +
                                +
                                + + RedirectLoginOptions +
                                +
                                +
                                + + VerifyParams +
                                +
                                + + +
                                + + +

                                Type Aliases

                                +
                                +
                                +
                                + + ApiRouteDefinition +
                                +
                                +
                                + + AuthenticatorType +
                                +
                                +
                                + + Cacheable +
                                +
                                +
                                + + ConnectAccountRedirectResult +
                                +
                                +
                                + + ConnectedAccount +
                                +
                                +
                                + + CustomFetchMinimalOutput

                                Interfaces

                                >
                                -
                                +
                                - RedirectLoginOptionsCustomTokenExchangeOptions
                                -
                                -
                                -
                                -
                                - -
                                - - -

                                Type Aliases

                                -
                                -
                                -
                                Type Aliases aria-label="Type Alias" > ApiRouteDefinitionEnrollmentResponse
                                -
                                -
                                +
                                +
                                Type Aliases aria-label="Type Alias" > CacheableEnrollParams

                                Type Aliases

                                >
                                -
                                +
                                Type Aliases aria-label="Type Alias" > ConnectAccountRedirectResultFetcherConfig

                                Type Aliases

                                >
                                -
                                +
                                Type Aliases aria-label="Type Alias" > ConnectedAccountInteractiveErrorHandler
                                -
                                -
                                +
                                +
                                Type Aliases aria-label="Type Alias" > CustomFetchMinimalOutputMfaFactorType

                                Type Aliases

                                >
                                -
                                +
                                Type Aliases aria-label="Type Alias" > CustomTokenExchangeOptionsMfaGrantType

                                Type Aliases

                                >
                                -
                                +
                                Type Aliases aria-label="Type Alias" > FetcherConfigOobChannel

                                On This Page

                                > LocalStorageCache
                                + MfaChallengeError + MfaEnrollmentError + MfaEnrollmentFactorsError + MfaError + MfaListAuthenticatorsErrorOn This Page > MfaRequiredError + MfaVerifyErrorOn This Page > PopupCancelledError + PopupOpenErrorOn This Page > AuthConfig + AuthenticatorOn This Page > AuthorizationParams + ChallengeAuthenticatorParams + ChallengeResponse + EnrollEmailParams + EnrollmentFactor + EnrollOtpParams + EnrollPushParams + EnrollSmsParams + EnrollVoiceParamsOn This Page > LogoutOptions + ObservableMfaApiClient + OobEnrollmentResponse + OtpEnrollmentResponseOn This Page > RedirectLoginOptions + VerifyParams
                                @@ -1705,6 +2412,14 @@

                                On This Page

                                > ApiRouteDefinition + AuthenticatorTypeOn This Page >CustomTokenExchangeOptions + EnrollmentResponse + EnrollParamsOn This Page > FetcherConfig + InteractiveErrorHandler + MfaFactorType + MfaGrantType + OobChannelType Alias ApiRouteDefinition
                              • Defined in projects/auth0-angular/src/lib/auth.config.ts:30
                              • diff --git a/docs/types/AuthenticatorType.html b/docs/types/AuthenticatorType.html new file mode 100644 index 00000000..97b3d819 --- /dev/null +++ b/docs/types/AuthenticatorType.html @@ -0,0 +1,260 @@ + + + + + + AuthenticatorType | @auth0/auth0-angular + + + + + + + + + + + + +
                                +
                                + @auth0/auth0-angular + + + + +
                                  +
                                  +
                                  Preparing search index...
                                  +
                                  +
                                  + +
                                  +
                                  +
                                  +
                                  +
                                  + +

                                  Type Alias AuthenticatorType

                                  +
                                  +
                                  + AuthenticatorType: + "otp" + | + "oob" + | + "recovery-code" +
                                  +
                                  +

                                  + Supported authenticator types. Note: Email authenticators use 'oob' + type with oobChannel: 'email' +

                                  +
                                  + +
                                  +
                                  + + +
                                  +
                                  +
                                  +
                                  + + diff --git a/docs/types/ConnectedAccount.html b/docs/types/ConnectedAccount.html index 4bda732c..50411ebf 100644 --- a/docs/types/ConnectedAccount.html +++ b/docs/types/ConnectedAccount.html @@ -114,7 +114,7 @@

                                  Type Alias ConnectedAccount

                                • Defined in projects/auth0-angular/src/lib/auth.config.ts:144
                                • diff --git a/docs/types/EnrollParams.html b/docs/types/EnrollParams.html new file mode 100644 index 00000000..cf587d98 --- /dev/null +++ b/docs/types/EnrollParams.html @@ -0,0 +1,280 @@ + + + + + + EnrollParams | @auth0/auth0-angular + + + + + + + + + + + + +
                                  +
                                  + @auth0/auth0-angular + + + + +
                                    +
                                    +
                                    Preparing search index...
                                    +
                                    +
                                    + +
                                    +
                                    +
                                    +
                                    +
                                    + +

                                    Type Alias EnrollParams

                                    +
                                    +
                                    + EnrollParams:
                                        | + EnrollOtpParams
                                        | + EnrollSmsParams
                                        | + EnrollVoiceParams
                                        | + EnrollEmailParams
                                        | + EnrollPushParams +
                                    +
                                    +

                                    Union type for all enrollment parameter types

                                    +
                                    + +
                                    +
                                    + + +
                                    +
                                    +
                                    +
                                    + + diff --git a/docs/types/EnrollmentResponse.html b/docs/types/EnrollmentResponse.html new file mode 100644 index 00000000..1591a3ba --- /dev/null +++ b/docs/types/EnrollmentResponse.html @@ -0,0 +1,263 @@ + + + + + + EnrollmentResponse | @auth0/auth0-angular + + + + + + + + + + + + +
                                    +
                                    + @auth0/auth0-angular + + + + +
                                      +
                                      +
                                      Preparing search index...
                                      +
                                      +
                                      + +
                                      +
                                      +
                                      +
                                      +
                                      + +

                                      Type Alias EnrollmentResponse

                                      +
                                      +
                                      + EnrollmentResponse: + OtpEnrollmentResponse + | + OobEnrollmentResponse +
                                      +
                                      +

                                      Union type for all enrollment response types

                                      +
                                      + +
                                      +
                                      + + +
                                      +
                                      +
                                      +
                                      + + diff --git a/docs/types/InteractiveErrorHandler.html b/docs/types/InteractiveErrorHandler.html new file mode 100644 index 00000000..9eb414f7 --- /dev/null +++ b/docs/types/InteractiveErrorHandler.html @@ -0,0 +1,259 @@ + + + + + + InteractiveErrorHandler | @auth0/auth0-angular + + + + + + + + + + + + +
                                      +
                                      + @auth0/auth0-angular + + + + +
                                        +
                                        +
                                        Preparing search index...
                                        +
                                        +
                                        + +
                                        +
                                        +
                                        +
                                        +
                                        + +

                                        Type Alias InteractiveErrorHandler

                                        +
                                        +
                                        + InteractiveErrorHandler: + "popup" +
                                        +
                                        +

                                        Configuration option for automatic interactive error handling.

                                        +
                                          +
                                        • + 'popup': SDK automatically opens Universal Login + popup on MFA error +
                                        • +
                                        +
                                        + +
                                        +
                                        + + +
                                        +
                                        +
                                        +
                                        + + diff --git a/docs/types/MfaFactorType.html b/docs/types/MfaFactorType.html new file mode 100644 index 00000000..3dd80001 --- /dev/null +++ b/docs/types/MfaFactorType.html @@ -0,0 +1,261 @@ + + + + + + MfaFactorType | @auth0/auth0-angular + + + + + + + + + + + + +
                                        +
                                        + @auth0/auth0-angular + + + + +
                                          +
                                          +
                                          Preparing search index...
                                          +
                                          +
                                          + +
                                          +
                                          +
                                          +
                                          +
                                          + +

                                          Type Alias MfaFactorType

                                          +
                                          +
                                          + MfaFactorType: + "otp" + | + "sms" + | + "email" + | + "push" + | + "voice" +
                                          +
                                          +

                                          Supported MFA factors for enrollment

                                          +
                                          + +
                                          +
                                          + + +
                                          +
                                          +
                                          +
                                          + + diff --git a/docs/types/MfaGrantType.html b/docs/types/MfaGrantType.html new file mode 100644 index 00000000..d95c21a1 --- /dev/null +++ b/docs/types/MfaGrantType.html @@ -0,0 +1,262 @@ + + + + + + MfaGrantType | @auth0/auth0-angular + + + + + + + + + + + + +
                                          +
                                          + @auth0/auth0-angular + + + + +
                                            +
                                            +
                                            Preparing search index...
                                            +
                                            +
                                            + +
                                            +
                                            +
                                            +
                                            +
                                            + +

                                            Type Alias MfaGrantType

                                            +
                                            +
                                            + MfaGrantType: + typeof + MfaGrantTypes[keyof + typeof + MfaGrantTypes] +
                                            +
                                            +

                                            + Grant types for MFA verification (derived from MfaGrantTypes + constants) +

                                            +
                                            + +
                                            +
                                            + + +
                                            +
                                            +
                                            +
                                            + + diff --git a/docs/types/OobChannel.html b/docs/types/OobChannel.html new file mode 100644 index 00000000..72374ba5 --- /dev/null +++ b/docs/types/OobChannel.html @@ -0,0 +1,262 @@ + + + + + + OobChannel | @auth0/auth0-angular + + + + + + + + + + + + +
                                            +
                                            + @auth0/auth0-angular + + + + +
                                              +
                                              +
                                              Preparing search index...
                                              +
                                              +
                                              + +
                                              +
                                              +
                                              +
                                              +
                                              + +

                                              Type Alias OobChannel

                                              +
                                              +
                                              + OobChannel: + "sms" + | + "voice" + | + "auth0" + | + "email" +
                                              +
                                              +

                                              + Out-of-band delivery channels. Includes 'email' which is also + delivered out-of-band. +

                                              +
                                              + +
                                              +
                                              + + +
                                              +
                                              +
                                              +
                                              + + diff --git a/docs/variables/Auth0ClientService.html b/docs/variables/Auth0ClientService.html index a77cc397..66fd81b2 100644 --- a/docs/variables/Auth0ClientService.html +++ b/docs/variables/Auth0ClientService.html @@ -102,7 +102,7 @@

                                              Variable Auth0ClientServiceConst

                                            • Defined in projects/auth0-angular/src/lib/auth.client.ts:29
                                            • diff --git a/docs/variables/AuthConfigService.html b/docs/variables/AuthConfigService.html index 308ef519..f47a5cb0 100644 --- a/docs/variables/AuthConfigService.html +++ b/docs/variables/AuthConfigService.html @@ -127,7 +127,7 @@