From 305688d15faa6a557dba8ed2d8e6bf3fa0842229 Mon Sep 17 00:00:00 2001 From: Siddhi Kotak Date: Mon, 28 Sep 2026 17:54:16 +0530 Subject: [PATCH] Release v2.13.0 --- .version | 2 +- CHANGELOG.md | 6 + docs/assets/hierarchy.js | 3 +- docs/assets/highlight.css | 146 +- docs/assets/navigation.js | 3 +- docs/assets/search.js | 3 +- docs/classes/AbstractNavigator.html | 681 +-- docs/classes/Auth0ClientFactory.html | 630 +-- docs/classes/AuthClientConfig.html | 792 +-- docs/classes/AuthGuard.html | 910 +--- docs/classes/AuthHttpInterceptor.html | 780 +-- docs/classes/AuthModule.html | 649 +-- docs/classes/AuthService.html | 3514 ++---------- docs/classes/AuthState.html | 1360 +---- docs/classes/AuthenticationError.html | 1351 +---- docs/classes/ConnectError.html | 1411 +---- docs/classes/Fetcher.html | 2472 +-------- docs/classes/GenericError.html | 1238 +---- docs/classes/InvalidConfigurationError.html | 1281 +---- docs/classes/MfaChallengeError.html | 1240 +---- docs/classes/MfaEnrollmentError.html | 1240 +---- docs/classes/MfaEnrollmentFactorsError.html | 1244 +---- docs/classes/MfaError.html | 1257 +---- docs/classes/MfaListAuthenticatorsError.html | 1244 +---- docs/classes/MfaRequiredError.html | 1354 +---- docs/classes/MfaVerifyError.html | 1236 +---- docs/classes/MissingRefreshTokenError.html | 1318 +---- docs/classes/MissingScopesError.html | 1315 +---- docs/classes/MyAccountApiError.html | 1167 +--- docs/classes/PasskeyChallengeError.html | 1158 +--- docs/classes/PasskeyError.html | 978 +--- docs/classes/PasskeyGetTokenError.html | 1164 +--- docs/classes/PasskeyRegisterError.html | 1158 +--- docs/classes/PopupCancelledError.html | 1253 +---- docs/classes/PopupOpenError.html | 1189 +---- docs/classes/PopupTimeoutError.html | 1256 +---- docs/classes/TimeoutError.html | 1203 +---- docs/classes/UseDpopNonceError.html | 1269 +---- docs/classes/User.html | 1557 +----- docs/enums/HttpMethod.html | 692 +-- docs/enums/ResponseType.html | 505 +- docs/functions/authGuardFn.html | 384 +- docs/functions/authHttpInterceptorFn.html | 424 +- docs/functions/isFederatedDomain.html | 396 +- .../isHttpInterceptorRouteConfig.html | 368 +- docs/functions/provideAuth0.html | 383 +- docs/hierarchy.html | 547 +- docs/index.html | 8 +- docs/interfaces/AppState.html | 652 +-- docs/interfaces/AuthConfig.html | 2927 ++-------- docs/interfaces/AuthorizationParams.html | 45 +- .../interfaces/EmailAuthenticationMethod.html | 891 +--- .../EmailEnrollmentChallengeResponse.html | 654 +-- .../EmailEnrollmentVerifyOptions.html | 645 +-- docs/interfaces/EnrollEmailParams.html | 602 +-- docs/interfaces/EnrollOtpParams.html | 544 +- docs/interfaces/EnrollPushParams.html | 544 +- docs/interfaces/EnrollSmsParams.html | 605 +-- docs/interfaces/EnrollVoiceParams.html | 605 +-- docs/interfaces/GetTokenSilentlyOptions.html | 822 +-- docs/interfaces/GetTokenWithPopupOptions.html | 584 +- docs/interfaces/HttpInterceptorConfig.html | 469 +- .../HttpInterceptorRouteConfig.html | 820 +-- docs/interfaces/IdToken.html | 2580 ++------- docs/interfaces/IsFederatedDomainOptions.html | 627 +-- docs/interfaces/LogoutOptions.html | 847 +-- docs/interfaces/ObservableMfaApiClient.html | 1207 +---- .../ObservableMyAccountApiClient.html | 1515 +----- .../ObservablePasskeyApiClient.html | 793 +-- docs/interfaces/PasskeyApiClient.html | 1495 +----- .../PasskeyAuthenticationMethod.html | 1271 +---- docs/interfaces/PasskeyCreationOptions.html | 804 +-- .../interfaces/PasskeyCredentialResponse.html | 793 +-- .../PasskeyEnrollmentChallengeResponse.html | 721 +-- .../PasskeyEnrollmentVerifyOptions.html | 654 +-- .../PasskeyLoginChallengeOptions.html | 525 +- .../PasskeyLoginChallengeResponse.html | 521 +- docs/interfaces/PasskeyRequestOptions.html | 645 +-- .../PasskeySignupChallengeResponse.html | 521 +- .../PasswordAuthenticationMethod.html | 765 +-- .../PasswordEnrollmentChallengeResponse.html | 708 +-- .../PasswordEnrollmentVerifyOptions.html | 649 +-- .../interfaces/PhoneAuthenticationMethod.html | 963 +--- .../PhoneEnrollmentChallengeResponse.html | 654 +-- .../PhoneEnrollmentVerifyOptions.html | 645 +-- docs/interfaces/PopupConfigOptions.html | 635 +-- docs/interfaces/PopupLoginOptions.html | 507 +- .../PushNotificationAuthenticationMethod.html | 846 +-- ...tificationEnrollmentChallengeResponse.html | 771 +-- ...shNotificationEnrollmentVerifyOptions.html | 599 +-- .../RecoveryCodeAuthenticationMethod.html | 822 +-- ...coveryCodeEnrollmentChallengeResponse.html | 714 +-- .../RecoveryCodeEnrollmentVerifyOptions.html | 597 +-- .../RedirectConnectAccountOptions.html | 896 +--- docs/interfaces/RedirectLoginOptions.html | 794 +-- docs/interfaces/TotpAuthenticationMethod.html | 838 +-- .../TotpEnrollmentChallengeResponse.html | 765 +-- .../TotpEnrollmentVerifyOptions.html | 645 +-- .../WebAuthnPlatformAuthenticationMethod.html | 971 +--- .../WebAuthnRoamingAuthenticationMethod.html | 971 +--- docs/modules.html | 4721 +---------------- docs/types/ApiRouteDefinition.html | 304 +- docs/types/ConnectAccountRedirectResult.html | 408 +- docs/types/ConnectedAccount.html | 303 +- docs/types/PasskeySignupChallengeOptions.html | 347 +- docs/types/TokenEndpointResponse.html | 720 +-- docs/variables/Auth0ClientService.html | 289 +- docs/variables/AuthConfigService.html | 321 +- projects/auth0-angular/package.json | 2 +- 109 files changed, 11842 insertions(+), 83995 deletions(-) diff --git a/.version b/.version index a5db00c8..311f78b6 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.12.0 \ No newline at end of file +v2.13.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index e6e86de7..3c510430 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.13.0](https://github.com/auth0/auth0-angular/tree/v2.13.0) (2026-09-28) +[Full Changelog](https://github.com/auth0/auth0-angular/compare/v2.12.0...v2.13.0) + +**Added** +- feat: add Experiment Center variant override support [\#1055](https://github.com/auth0/auth0-angular/pull/1055) ([siddhikotak](https://github.com/siddhikotak)) + ## [v2.12.0](https://github.com/auth0/auth0-angular/tree/v2.12.0) (2026-09-17) [Full Changelog](https://github.com/auth0/auth0-angular/compare/v2.11.0...v2.12.0) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index 83594f96..ff2f415f 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1,2 +1 @@ -window.hierarchyData = - 'eJyVlUtv2zAMgP+Lzurql2TJtyF7oEC6Dm23HYoeBIeOhSqSJ9kDhiL/fYiLBrKdTMopgPPRHylS9CuyxvQOVU8kobhIEpwT/oyRhUZB3UujHapeUU744UeLHaAKfTfd0K3NVuq77g3B6EXqDaoyQjEarEIVkroH24ga3PWC/9D2O4UwqpVwDlWod5urwwuujkGHP1upNhY0qp5ySp73GOWUeFl8hf7RvID+Jft2NMQlcy4sIqc9RkWSeCncrETdQkD4Bl1acpHSQ8lFSj3f2tRCPfTGii1M1WnG3tWjAdz1Aj6bwtuDPUYkoZMD1mBl/dlaY/8n8rmAY1IiyQpMigQTlmDCKaYpwzSnmBKKaUkx5QSXPMUsH4+CZIWX3KPcgRn6YHI+d1FyNBulhd/v20bcw+9BWtgExXM24vRpNr9ksVUu4AgbS+a2uw50nOpIRni4P1Mfh74F3ctaHC5dUHYCDxtpyuaVrYSuQamItp3AI4y5X+OtdE7q7T00Flw7LpvwtJyJiXCTE+6H2nTgYq0eHeErfd+N/iOU3KyMbuR2sHFdPRsUYef+J2BltIY6fD18Luwoeeo5fjj41Jnum9E1BEULOGxj09lpRMxmuXidMVJgVmaY8QTzhGGejTuVkWIqX0vXe5fO2IghOhsVUXyZzYrX1ii1Ax1u6pKO8PHZOl+1QinQ23BrF3DYxhM2tf0EK5u/MSqPjPBk8xE6nssXUcc28XRQyL7f/wPF4mhl'; +window.hierarchyData = "eJyVlUtv2zAMgP+Lzupq2Zb8uA3ZAwXSdWi77VD0ICh0LFSRPMkeMBT570NcNJDtZFJOAZyP/kiRol+RNaZ3qH6ihOA8oThj+TNGFhoFopdGO1S/oozlhx/Nd4Bq9N10Q7c2W6nvujcEoxepN6hOKcNosArVSOoebMMFuOsF/6HtdwphJBR3DtWod5urwwuujkGHP1upNhY0qp+yInneY5QViZfFV+gfzQvoX7JvR0NcMufCInLaY5Qn1EvhZsVFCwHhG3RpyXlKDiXnKfF8ayO4euiN5VuYqklavqtHA7jrBXw2hbcHe4woIZMD1mCl+Gytsf8T+VzAMSmRphWmOcW0pJglBLM0wywnmDGCWUlwkSS4qBgu8/EoaFp5yT3KHZihDybncxclx4pRmvv9vm34PfwepIVNUDxnI06fFfNLFlvlAo6wlXRuu+tAx6mOZNjDEn+mPg59C7qXgh8uXVB2Ao8wptm8shXXApSKaNsJPMKY+zXeSuek3t5DY8G147IJT8uZmAg3O+F+EKYDF2v16Ahf6ftu9B+u5GZldCO3g43r6tmgsL1I/E/AymgNInw9fC7CUTHP8cPBp85034wWEBQt4LCtnM5Ow2M2y8XrrKQVLosClxXFFclwlY07taTVVL6WrvcunbERQ3Q2KqL4opgVr61Ragc63NQlHeGrZut81XKlQG/DrV3AYVtFsqntJ1jZ/I1ReWSEJ5uP0PFcvnAR28TTQSH7fv8PRTRoMw==" \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 5a27e300..0028aa6b 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -1,30 +1,29 @@ :root { - --light-hl-0: #795e26; - --dark-hl-0: #dcdcaa; - --light-hl-1: #000000; - --dark-hl-1: #d4d4d4; - --light-hl-2: #a31515; - --dark-hl-2: #ce9178; - --light-hl-3: #af00db; - --dark-hl-3: #c586c0; - --light-hl-4: #001080; - --dark-hl-4: #9cdcfe; - --light-hl-5: #0000ff; - --dark-hl-5: #569cd6; - --light-hl-6: #0070c1; - --dark-hl-6: #4fc1ff; - --light-hl-7: #267f99; - --dark-hl-7: #4ec9b0; - --light-hl-8: #008000; - --dark-hl-8: #6a9955; - --light-hl-9: #000000; - --dark-hl-9: #c8c8c8; - --light-code-background: #ffffff; - --dark-code-background: #1e1e1e; + --light-hl-0: #795E26; + --dark-hl-0: #DCDCAA; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #AF00DB; + --dark-hl-3: #C586C0; + --light-hl-4: #001080; + --dark-hl-4: #9CDCFE; + --light-hl-5: #0000FF; + --dark-hl-5: #569CD6; + --light-hl-6: #0070C1; + --dark-hl-6: #4FC1FF; + --light-hl-7: #267F99; + --dark-hl-7: #4EC9B0; + --light-hl-8: #008000; + --dark-hl-8: #6A9955; + --light-hl-9: #000000; + --dark-hl-9: #C8C8C8; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; } -@media (prefers-color-scheme: light) { - :root { +@media (prefers-color-scheme: light) { :root { --hl-0: var(--light-hl-0); --hl-1: var(--light-hl-1); --hl-2: var(--light-hl-2); @@ -36,11 +35,9 @@ --hl-8: var(--light-hl-8); --hl-9: var(--light-hl-9); --code-background: var(--light-code-background); - } -} +} } -@media (prefers-color-scheme: dark) { - :root { +@media (prefers-color-scheme: dark) { :root { --hl-0: var(--dark-hl-0); --hl-1: var(--dark-hl-1); --hl-2: var(--dark-hl-2); @@ -52,69 +49,44 @@ --hl-8: var(--dark-hl-8); --hl-9: var(--dark-hl-9); --code-background: var(--dark-code-background); - } -} +} } :root[data-theme='light'] { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --code-background: var(--light-code-background); + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --code-background: var(--light-code-background); } :root[data-theme='dark'] { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --code-background: var(--dark-code-background); + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --code-background: var(--dark-code-background); } -.hl-0 { - color: var(--hl-0); -} -.hl-1 { - color: var(--hl-1); -} -.hl-2 { - color: var(--hl-2); -} -.hl-3 { - color: var(--hl-3); -} -.hl-4 { - color: var(--hl-4); -} -.hl-5 { - color: var(--hl-5); -} -.hl-6 { - color: var(--hl-6); -} -.hl-7 { - color: var(--hl-7); -} -.hl-8 { - color: var(--hl-8); -} -.hl-9 { - color: var(--hl-9); -} -pre, -code, -math[display='block'] { - background: var(--code-background); -} +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +pre, code, math[display='block'] { background: var(--code-background); } diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 0d533131..76d7247b 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1,2 +1 @@ -window.navigationData = - 'eJy1m11z3CYUhv+Lrp0mcZq09Z1nEzue8caetZNcdHqBpbMrJhKogLbZdvLfOyvJuwjBgQXlmve8zwHxJYT+/C9T8F1lF9lHpZolqJIX2VnWEFVmFxmwtpYvjyW/lKqusrPsG2VFdvH7j7ND9Apkw5mEx10DZrxeZjicZXlFpMwuMiWLF1S+gO8KBCNVpnlfPkklSK4+kS3dEMXFEdBFg3w5kYw5r8/1XC9bVb5aVBSYuiK54mJnMZxofI69eMHZmm7sfrrC5wZM0ZwoytkHIaw1noomnmGt26ryuiWisDO6Il+2+x5ywxSIHBr785mKfJ5LXrQV2K36Mp/DA4gtzR0WQ6HXQxHlctgXYfELzhjkyvEA9dK4J3cFKi/BYj0UxLleAwNBc0fWemmc/w1bQs3FbkHy0tKyo+JYwpZUtOgHWiuwUeSUxpFveU6qB8UF2YCjfhNJHGm5JouSVBWwDTjqNpFEkz4wwauqBubqy1PNDKx+3pUhSF0aT3aDknxvqVTabI1WyaGNZq/g75YKKNzEkSKa8wUEXe/cFK08kkGlpGyzgrUAWT7yb+Aa0i5lEvch5w04n9tEE8naXeY5b5m6bKgLZUriSPdEym+w880gVlkSEQel+1+DwvqGTZXEW8GGSgUC541UkTzetM2CsByqyjmcLaIE2l3jbsdReQLjkdbAW9eyMpHEkXBIuv9nCe8b3nziLHeNpIkkmmQ3j937N42xwaX7Dfqa5Ps97lA4tj5/+8588TFeeXSLQ7HP5LDgOX0OiolV8GsOF/Tfbot3TwSppRNl6OKAh1lzlDxCxgISU3h+A8e5z6o42Iea0Gr8VmoeJ2hQpzoBftwPHqp01+yd7e3tiZk3EfQJ+IJmSaXfgp3QIKOAyBQ6s84X6fgTVQrs+DqAsI6iFNSdary1OmhSQPetLL2koygF9VBLL+mgSQF94TQHL0pTxcGQrpDSAZ53kA+0AqYqdFg5tGngr1SVwy7MTzbFcWjj/A5Z9q1KbAdgBKx4qyDcX5NjkBvjREYzvLGcxIQ2y03RtbHdty+LNJZXUIAgCor3vCaUYY/aJY5D3/INbxXGGymwVtffWPsDcKvfVBaX+d2TBLElTxUs1wRH2qVYXbSIsFphAWGg4Q0yFGPKUQh/Oq6G6P7Eqox8PqoJhdqUcdCgRvQ23Umo0H0wok9KYCGgs8LGsF2aii329SAV+myd6iT4ift/b9TcyYQ0yexvARNf/3sAHpKWxv7sI6gddGES8pZvKDulQ1gDZkwhpPr2iKQk9gf9INFF3apMgj7QDWubk6ruCIlP4x8uipPmY1dAWgoRsxMeNns63qfjiZsrobAZComJTKTkDMI7ikudAD+1i+Ax8yaCdw5P0CypBHQLJCAyhe6LSvdqiYInsgRcN/d7aboqEtbK8hNXdD103/CuHxA4T0qnDojg8J+WHj5MwuPnTjBg8ITFxiW2gpxvQewWvAifYn1B6amc2L/CQn9KWmi/CoydMzF/fwqIi02ooAJyNVygG85V8FSQiLQkvJO1TYidyjxy1QSPEJc4rk57txNHBB4yaxroCPDEzJGIv8cj+rgEPjcFUdapb3hFs6bhjYpLpq8P8sVGF8QhvsLTPm12XxG15qIOHgchgWkprTipKducnBESF3mPoaHd9473sKaM7t2OfLVrunsbpsIgvfrjt9dvz50Xzs1aDa7+GvS+wbcxTLfxrwNu6vQ3gkgyFx5kL4hndV+V9sfyJuNQkOA9WsueV5kVyLZSExyiTc4AisHXQT2U+3rhopWK193d9SVltCbVXauadurr0CXUpHPsrwR+z0tiW/R0tk0ZTw9Zcnt68EqbRp+utE68Y4GN4vuxc9Icy7mJxFbxk7nm4qnDrOvmCYThnw/zq3mPGBXGM7pv7iRXdNtfYvxIWFHpNxJ7mkMWz12uSX9ZwzZfjwqTGNeCMOVAHMriCXf8aVESxqAy/Y8l8e76hwNHr7ZIknnGaT1OtotnyiEEnUzU/ypY8mLSU8zyeFK/xrCi4dQ9NVpFaXuj4afHyb9zWyLofscy+jXS+hPdG3Nr2U87HseRCDF0P4GjH/4U3oQ1Bnn++fFK22GvW5Z3XeilVjy2f/erYWLcVnLbTYSIMTXv+9hMJyLTMKghqAy5nqVTQ+9njWrUCL6l/UHfK5utXj6x+et/rqli+w=='; +window.navigationData = "eJy1m11z3CYUhv+Lrp0mcZq09Z1nEzue8caetZNcdHqBpbMrJhKogLbZdvLfOyvJuwjBgQXlmve8zwHxJYT+/C9T8F1lF9lHpZolqJIX2VnWEFVmFxmwtpYvjyW/lKqusrPsG2VFdvH7j7ND9Apkw5mEx10DZrxeZjicZXlFpMwuMiWLF1S+gO8KBCNVpnlfPkklSK4+kS3dEMXFEdBFg3w5kYw5r8/1XC9bVb5aVBSYuiK54mJnMZxofI69eMHZmm7sfrrC5wZM0ZwoytkHIaw1noomnmGt26ryuiWisDO6Il+2+x5ywxSIHBr785mKfJ5LXrQV2K36Mp/DA4gtzR0WQ6HXQxHlctgXYfELzhjkyvEA9dK4J3cFKi/BYj0UxLleAwNBc0fWemmc/w1bQs3FbkHy0tKyo+JYwpZUtOgHWiuwUeSUxpFveU6qB8UF2YCjfhNJHGm5JouSVBWwDTjqNpFEkz4wwauqBubqy1PNDKx+3pUhSF0aT3aDknxvqVTabI1WyaGNZq/g75YKKNzEkSKa8wUEXe/cFK08kkGlpGyzgrUAWT7yb+Aa0i5lEvch5w04n9tEE8naXeY5b5m6bKgLZUriSPdEym+w880gVlkSEQel+1+DwvqGTZXEW8GGSgUC541UkTzetM2CsByqyjmcLaIE2l3jbsdReQLjkdbAW9eyMpHEkXBIuv9nCe8b3nziLHeNpIkkmmQ3j937N42xwaX7Dfqa5Ps97lA4tj5/+8588TFeeXSLQ7HP5LDgOX0OiolV8GsOF/Tfbot3TwSppRNl6OKAh1lzlDxCxgISU3h+A8e5z6o42Iea0Gr8VmoeJ2hQpzoBftwPHqp01+yd7e3tiZk3EfQJ+IJmSaXfgp3QIKOAyBQ6s84X6fgTVQrs+DqAsI6iFNSdary1OmhSQPetLL2koygF9VBLL+mgSQF94TQHL0pTxcGQrpDSAZ53kA+0AqYqdFg5tGngr1SVwy7MTzbFcWjj/A5Z9q1KbAdgBKx4qyDcX5NjkBvjREYzvLGcxIQ2y03RtbHdty+LNJZXUIAgCor3vCaUYY/aJY5D3/INbxXGGymwVtffWPsDcKvfVBaX+d2TBLElTxUs1wRH2qVYXbSIsFphAWGg4Q0yFGPKUQh/Oq6G6P7Eqox8PqoJhdqUcdCgRvQ23Umo0H0wok9KYCGgs8LGsF2aii329SAV+myd6iT4ift/b9TcyYQ0yexvARNf/3sAHpKWxv7sI6gddGES8pZvKDulQ1gDZkwhpPr2iKQk9gf9INFF3apMgj7QDWubk6ruCIlP4x8uipPmY1dAWgoRsxMeNns63qfjiZsrobAZComJTKTkDMI7ikudAD+1i+Ax8yaCdw5P0CypBHQLJCAyhe6LSvdqiYInsgRcN/d7aboqEtbK8hNXdD103/CuHxA4T0qnDojg8J+WHj5MwuPnTjBg8ITFxiW2gpxvQewWvAifYn1B6amc2L/CQn9KWmi/CoydMzF/fwqIi02ooAJyNVygG85V8FSQiLQkvJO1TYidyjxy1QSPEJc4rk57txNHBB4yaxroCPDEzJGIv8cj+rgEPjcFUdapb3hFs6bhjYpLpq8P8sVGF8QhvsLTPm12XxG15qIOHgchgWkprTipKducnBESF3mPoaHd9473sKaM7t2OfLVrunsbpsIgvfrjt9dvz50Xzs1aDa7+GvS+wbcxTLfxrwNu6vQ3gkgyFx5kL4hndV+V9sfyJuNQkOA9WsueV5kVyLZSExyiTc4AisHXQT2U+3rhopWK193d9SVltCbVXauadurr0CXUpHPsrwR+z0tiW/R0tk0ZTw9Zcnt68EqbRp+utE68Y4GN4vuxc9Icy7mJxFbxk7nm4qnDrOvmCYThnw/zq3mPGBXGM7pv7iRXdNtfYvxIWFHpNxJ7mkMWz12uSX9ZwzZfjwqTGNeCMOVAHMriCXf8aVESxqAy/Y8l8e76hwNHr7ZIknnGaT1OtotnyiEEnUzU/ypY8mLSU8zyeFK/xrCi4dQ9NVpFaXuj4afHyb9zWyLofscy+jXS+hPdG3Nr2U87HseRCDF0P4GjH/4U3oQ1Bnn++fFK22GvW5Z3XeilVjy2f/erYWLcVnLbTYSIMTXv+9hMJyLTMKghqAy5nqVTQ+9njWrUCL6l/UHfK5utXj6x+et/rqli+w==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 49086a4f..91b2508b 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1,2 +1 @@ -window.searchData = - 'eJy1nF2PnLgShv8Lcy5bSQO2gbnLmeyXlN2Nds/Zc9GKVqTbPY3CAAJ6dkdR/vuR+azCBV3N9F5NFFxvlcuPC2Nof3XK/K/Kud99db4k2cG5DzdOFj9p5975sa6Ln3V9yg/OxjmXqXPv6Oz8VL0dL7w51U+ps3H2aVxVunLuHefbpldy1SD1Xqe61ssyd4e+EVDbOEVc6qzG4ZA+ftD1BQePTYt16j/q+EIa7k5tk3X6H+N6f7rgoOjarPSQV5cSVLRNVuqfL8qfr1X3Rhrffa7qMt7Xv8TPyWNc5+XgrBN8a7VYpFO63qC9z7OqLs97vuodNqH7ZIc8uve2Yuxb1jbQ/375b5lyI+iNPr+cy3RVDCi95/q0fUgTndXfx6ZXL3YcVpPbJJiW5WXYjnomxftSx7Vum/JDaIz2vdGKGKYpbts95NkxeSTDgA1ull5LlJ1cFO9Mah81nVHb61IB5nqr2N6qdd6mQ/bDOS4PpMvmys0GaVRjj04b2hzxcfZuXyfPMbjxzvmLs3hs+np/D6ckvZQy6HTftV/v+UMecxym+cItmvIzhcHcpn7Kal3udTE3kJM2NwOE0mWjMg18JpVJ34QfATRZ43+a4p/zwzmlkW0v3SyhQI6dxy66mfQd8/K3PKeTB70d87Js213haZqo33X5nOzpTHXXbpYqqMfOVR8g6MLWE4PPuCh+r+Na/+uyx7goqvpSdbrgTpdlXjJ8Ne1e4yg5/Cf/orOHNE6eKobD5FCb9vum/ascV6aRzupkH9f6wHFdxdDidc5NDU6yR5bbtG37GodPx/iyp7bReh8v7/b7/DyzZMSeXuKh6Wp/RVxVXzS99EbexoarfZ0rzZkOptmVbvDNOc8yva+7PP4vqU+/6UNS6j0jp51tl9i/kvpUjrbrI2pW9d/ren/SnGrXND8OzVf7fdSZLuNavy/y4mOZ58fLvnuTQ5EXRWfyCv9mFHRVNeXp9yTVWZ0yWHvUZgR0VTVlqhrtbhSJYeJjXpyLa0MxQBSd4WtiMQPyS54xbqUmADMWWdd6tddTnB1S3c+EhzhNP8f7L5f9t3b9LNiPdqsjSfPHpBmCh3NV50/NiHz39/4UZ4+MfDTWZhz2jXUzLHq0fn1UTDCGOF7Nw+CZX6YG57eoTmn+mJ95TvOF/TSGp+zx1+y9ruoyZxSB7DHPDkPj1T6rq2ZbtX62WYvleu45uLlyu4XyoMZfJjehrVi1jq4Ya9YlJ5wV6+jsivXqolPWahW4vWatuux4eaUKXbLWqUvOFlZZo5/La6yJCzSnSn0sdXW65GRsttJPhe7al9xV6Fb9Kq/fdXRf8nf9LJh6+qlHg+FtHRyeHN+YvOsegAdnzVbKMd4bf9215TdskLRusawP00eWOdW7weLik0sf6IzrUldFnlX6z/qluNybu2nzdU7ruIQ7z7PehnZsN2iMzEYx3q6Hnoar/HFqKP0Y1yeGYFvYi7bxwk62tYcNHZ5m9iwX3BqTBJmsdV59SYrZZe5CBMbuqmWu/dYAjOJk93F+QMmG/LGN0zT/Sx8+JBUJ5rz6XWeZJhfewNq9YPX4t/xca3a3Qesr+/4uy7OXp/xcrfDS5iAGCqw0wK4tzIDJlwxXhGWsn3rrW4XU3BV/Leokz1blqrHPB/tbhXUukzXRtGY3DOLnGO/OXBfLU7y8WcMKCc6mD83D1sJwoQaLcwbK/vq50uVz/DnVPx/jd0UyeT0N9OmWy47QntcpTlMNH+l54nfQkE7mTCdmAtFZmafptVEMVrcIwew+jU8SeUkO6FI0ZhdqKnCjwL5rOvo0fEuwJjY9aBwHjVuE96zL5PhybUCD1doQ6PnSb8xzZ43Vnj932u/SADJJns3fTS767L5zi5HehfvLYscXZ5rB4IE5+WfiHYWuKgYrAv2DQ9jFKPnEsUPEJeOV44/Lxz8z+DMBXyon10XMKizXhMyrefNBXlHv2GGdi0N8y9nf6v0jAJCV8mP7ppBZJ6et+VWy2QRfIX7XG17qu9WRuW2c5DEDrwyuiGSwfE0oYBD6594PpocLi0eq3YXER4Erx03pd0XSrGHf62OSJcZ+cGO2WMyOyLTBVfoPc1tLrfr08qK2D8Iev5ycfsvyHJeJyTT6NpPzUctEvl3VL6ujNoviCjzt9h+LfT/m+njO9s3gvQVXrxGcPJfMSlvtuE6SirEvMPpaas51WZT5c3JoCuiWcAEvU5KfNk6SHfTfzv1XswCtDNv3jvfGfxM5G+eY6PRgfr3Qets4+/zpqS1yh3x/bv75qWv2h25vDve7tvXbrbPZbTd+8EYq+enTZtcbNxea/+g1xv9pDF1ns3M3wnujAoEMXcvQRYaes9l5lEfPMvSQoe9sdj7l0bcMfWQonM1OUIbCMhTIUDqbnaQMpWUokaFyNjtFGSrLUCHDwNnsAsowsAwDZBg6m1248eQb3wuRYWgZhsgwcja7iPIYWYYRBsDw4G5JBGx43Ak97ly8LsEPBsg1WLg0ezZDLobINWi4Hmlsc+RikFwxG7WNkotZcuUc965Nk4txcg0kLsm+axPlYqRcA4pL8u/aVLkYK3eWK9cGy8VkuYYXl5w/rg2Xi+nyGrrIOeTZdHmYLq8pTuQ88my8vEl9avAKSWOiRGG8PH8uX55Nl4fp8gwwLjkXPRsvD+PlNXiRs9Gz+fIwX56ajdrGy8N4eQYYj5yNno2Xh/HyDDEeORs9my8P8+VFs1HbeHkYL98A4/nUdPRtvHyMl2+A8QRpbOPlY7z85v4nSWMbL39yCzTEeIo0Ju6CmC/fEOMFpLHNl4/58hu+yFnh23z5mC/fIOORZPs2YD4GzDfI+CTZvg2YjwHzDTK+S/bZBszHgPmGGZ+k07cJ8zFhwjDjkzVb2IQJTJgwzPj0msUmTGDChGHGJ+uusAkTmDDRrLLIuitswsRkoWWY8cm6K4i1FiZMGGZ8kjBhEyYwYcIw45OECZswgQkThhlBEiZswgQmTBhmBFn/hE2YwIQJw4wgCRM2YQITJg0zgiRM2oRJTJg0zAiSMGkTJjFh0jAj6JWxTZjEhMnZW6S0AZMYMClmK6+0AZOT1bycrbySWNBjwKSarbzSBkxiwGQwW3mlDZjEgMn5EiZtwCQGTDaAkdNZ2oBJDJhqACOns7IBUxgw1QBGTmdlA6YwYKoBjJzOygZMYcCUP3tvVzZhChOmDDOSfCJWNmEKE6aaB0ayFiibMDV5ZjTMSLIWKOKxEROmDDOSrAXKJkxhwpRhRpK1QNmEKUyYMsxIshYomzCFCQsMM5LEM7AJCzBhgWFG0k/LNmEBJiwwzEgSz8AmLMCEBYYZSeIZ2IQFmLDAMKPIu01gExZgwgI5t18T2IAFGLCg2ZUg6QxswILJxoRBRpF0BsTeBAYsMMgoks7ABizAgAUGGUXSGdiABRiw0CCjSDpDG7AQAxYaZBRJZ2gDFmLAQoOMIukMbcBCDFhokFEknaENWIgBCxvASDpDG7AQAxYaZgKSztAmLMSEhYaZgCQstAkLMWFhs/dFEhbahIWT7S/DTEASFhI7YJiw0DATkISFNmEhJiwyzAQkYZFNWIQJiwwzAUlYZBMWYcIiw0xAEhbZhEWYsMgwE5CERTZhESYsMswE9K6hTViECYsMMyFJWGQTFmHComangiQssgmLMGGRYSYkCYtswiJMWNTshJGERTZh0WSTNZpdVUTEPut0o9VAE9I7eFtqq3Wy17ptNlvpjbgtsd26ney3bg06IUlpe21qP9ly3TYrfhLU9trUfrLrum22XUlW22tT+8nO67YhjsS1vTa1b/+veevyrMtaH35q377sdk7cHSWTjSfwfHX+7N7OBP0Ln69O4Nx//fZtfBdz//UbeB1jrhmf0489Rym1BVqCL9Z/PTsqyRAoeTylIinNS64DeJU6Cob+KBiFTMH+p+ujjAdk/G1rqHyenHlR1p5Ic+zP6RmFXZA6d3utYNW/JgUdFlCQr9gK7rsXiyBAD+jxe2wLSZBCxSRuEKI6KmFHXbbgY3s6DOghzBg/sEbniGFTMCQmvuf6ZH28D4IDE8JbrTgJM4Bh8sf0qTvnA0wLQK8n2ULEaHoAM485T43SdKIKQIXk5QudpQMyD/mKrlXqDsgBcoANjzcth+NvgAoYOo/HPPgEEFRsEE3I1Fn4af8o7INx9JlZs37UBIoGAEyJViBiy44/5gTwg463lq7b/e303e7/Pb/7q7q/UftX8mYMPooMDKELuGISig80ANkGNVXwoOrPbAQBgXiukKA/iAPrC0BCyCur/UfjgFPAe8hLFvnxKwgLpCzkFRr7Q1UgB24eIQ/M7kePoPYBDb+DUfKWUeDXZmDSAD3F6+JwvBGICnDh8caPOPwCsAqiEjzQml8BgohAQN1U5d1z5s7DAMGBYi94nM2ebAFUQZUVvKox+6kxQA7EGvEm/fznwEAWBBuxx2f6swowdWGlZXcenB4A8giqgOBNDPpXFSC6CETHliSEAhBbxCNn7kgQ0GGQO8FjvD3LFkiAmsITmF+ESkCc4hW5iRrxOACfP3m4TTSbpz5CGIxswO+6Pc/A0qN74gt4QzE5bgEUMJBHvythkqk5ntkH7tygqx4PYutMBhAdKAB+t/aRiqnKG5sQcG12Pnjaw6/2QayAHr9bt0neTar7eh0EBQY64o3G8iE6YBKCARK8VE7PxQGPNiBOcUVf55bqAtzgBW+Z0B9hA0TATVnwSkMrMvwSFtRksEIIeFrNaXEAC8CXzxtKcAoc0AHj5vPGbXK486gFpHh9Qgf3gEyDii55t/18+P3D0zGOi8R+GFGgIoVXi/apI6UDgFfIy+Eo3Z2WRwvDjPJqyHD4HpiaYDb5vNnUneYOhgSwz1PIJ9udYEh5Au3H93H7bT6oYREsrEwtPJNB9eeNVl9TmiJDTOcQlIaIl+HhxBuQYxCX5E2gyWklIN0AScVLUoUfQVwwCV1emqbH6oCugZuY4k2+amaFLACKkreaGo/fATKgfiq2DHmHFoBIxVsX97/mAgiBAYuY6SaPIQEMAJ4CXtL782iACEBb8eLCxz+AaQe6GPCkln6QCMokGMuItw5uDoUAoYFeBrwJDI9yAEJg1gS8lUZ7wBYo1yBNfrdBJ3lSxKYNqP0how582jhFUug0ybRzv/v07dv/ATa/WzQ='; +window.searchData = "eJy1nF2PnLgShv8Lcy5bSQO2gbnLmeyXlN2Nds/Zc9GKVqTbPY3CAAJ6dkdR/vuR+azCBV3N9F5NFFxvlcuPC2Nof3XK/K/Kud99db4k2cG5DzdOFj9p5975sa6Ln3V9yg/OxjmXqXPv6Oz8VL0dL7w51U+ps3H2aVxVunLuHefbpldy1SD1Xqe61ssyd4e+EVDbOEVc6qzG4ZA+ftD1BQePTYt16j/q+EIa7k5tk3X6H+N6f7rgoOjarPSQV5cSVLRNVuqfL8qfr1X3Rhrffa7qMt7Xv8TPyWNc5+XgrBN8a7VYpFO63qC9z7OqLs97vuodNqH7ZIc8uve2Yuxb1jbQ/375b5lyI+iNPr+cy3RVDCi95/q0fUgTndXfx6ZXL3YcVpPbJJiW5WXYjnomxftSx7Vum/JDaIz2vdGKGKYpbts95NkxeSTDgA1ull5LlJ1cFO9Mah81nVHb61IB5nqr2N6qdd6mQ/bDOS4PpMvmys0GaVRjj04b2hzxcfZuXyfPMbjxzvmLs3hs+np/D6ckvZQy6HTftV/v+UMecxym+cItmvIzhcHcpn7Kal3udTE3kJM2NwOE0mWjMg18JpVJ34QfATRZ43+a4p/zwzmlkW0v3SyhQI6dxy66mfQd8/K3PKeTB70d87Js213haZqo33X5nOzpTHXXbpYqqMfOVR8g6MLWE4PPuCh+r+Na/+uyx7goqvpSdbrgTpdlXjJ8Ne1e4yg5/Cf/orOHNE6eKobD5FCb9vum/ascV6aRzupkH9f6wHFdxdDidc5NDU6yR5bbtG37GodPx/iyp7bReh8v7/b7/DyzZMSeXuKh6Wp/RVxVXzS99EbexoarfZ0rzZkOptmVbvDNOc8yva+7PP4vqU+/6UNS6j0jp51tl9i/kvpUjrbrI2pW9d/ren/SnGrXND8OzVf7fdSZLuNavy/y4mOZ58fLvnuTQ5EXRWfyCv9mFHRVNeXp9yTVWZ0yWHvUZgR0VTVlqhrtbhSJYeJjXpyLa0MxQBSd4WtiMQPyS54xbqUmADMWWdd6tddTnB1S3c+EhzhNP8f7L5f9t3b9LNiPdqsjSfPHpBmCh3NV50/NiHz39/4UZ4+MfDTWZhz2jXUzLHq0fn1UTDCGOF7Nw+CZX6YG57eoTmn+mJ95TvOF/TSGp+zx1+y9ruoyZxSB7DHPDkPj1T6rq2ZbtX62WYvleu45uLlyu4XyoMZfJjehrVi1jq4Ya9YlJ5wV6+jsivXqolPWahW4vWatuux4eaUKXbLWqUvOFlZZo5/La6yJCzSnSn0sdXW65GRsttJPhe7al9xV6Fb9Kq/fdXRf8nf9LJh6+qlHg+FtHRyeHN+YvOsegAdnzVbKMd4bf9215TdskLRusawP00eWOdW7weLik0sf6IzrUldFnlX6z/qluNybu2nzdU7ruIQ7z7PehnZsN2iMzEYx3q6Hnoar/HFqKP0Y1yeGYFvYi7bxwk62tYcNHZ5m9iwX3BqTBJmsdV59SYrZZe5CBMbuqmWu/dYAjOJk93F+QMmG/LGN0zT/Sx8+JBUJ5rz6XWeZJhfewNq9YPX4t/xca3a3Qesr+/4uy7OXp/xcrfDS5iAGCqw0wK4tzIDJlwxXhGWsn3rrW4XU3BV/Leokz1blqrHPB/tbhXUukzXRtGY3DOLnGO/OXBfLU7y8WcMKCc6mD83D1sJwoQaLcwbK/vq50uVz/DnVPx/jd0UyeT0N9OmWy47QntcpTlMNH+l54nfQkE7mTCdmAtFZmafptVEMVrcIwew+jU8SeUkO6FI0ZhdqKnCjwL5rOvo0fEuwJjY9aBwHjVuE96zL5PhybUCD1doQ6PnSb8xzZ43Vnj932u/SADJJns3fTS767L5zi5HehfvLYscXZ5rB4IE5+WfiHYWuKgYrAv2DQ9jFKPnEsUPEJeOV44/Lxz8z+DMBXyon10XMKizXhMyrefNBXlHv2GGdi0N8y9nf6v0jAJCV8mP7ppBZJ6et+VWy2QRfIX7XG17qu9WRuW2c5DEDrwyuiGSwfE0oYBD6594PpocLi0eq3YXER4Erx03pd0XSrGHf62OSJcZ+cGO2WMyOyLTBVfoPc1tLrfr08qK2D8Iev5ycfsvyHJeJyTT6NpPzUctEvl3VL6ujNoviCjzt9h+LfT/m+njO9s3gvQVXrxGcPJfMSlvtuE6SirEvMPpaas51WZT5c3JoCuiWcAEvU5KfNk6SHfTfzv1XswCtDNv3jvfGfxM5G+eY6PRgfr3Qets4+/zpqS1yh3x/bv75qWv2h25vDve7tvXbrbPZbTd+8EYq+enTZtcbNxea/+g1xv9pDF1ns3M3wnujAoEMXcvQRYaes9l5lEfPMvSQoe9sdj7l0bcMfWQonM1OUIbCMhTIUDqbnaQMpWUokaFyNjtFGSrLUCHDwNnsAsowsAwDZBg6m1248eQb3wuRYWgZhsgwcja7iPIYWYYRBsDw4G5JBGx43Ak97ly8LsEPBsg1WLg0ezZDLobINWi4Hmlsc+RikFwxG7WNkotZcuUc965Nk4txcg0kLsm+axPlYqRcA4pL8u/aVLkYK3eWK9cGy8VkuYYXl5w/rg2Xi+nyGrrIOeTZdHmYLq8pTuQ88my8vEl9avAKSWOiRGG8PH8uX55Nl4fp8gwwLjkXPRsvD+PlNXiRs9Gz+fIwX56ajdrGy8N4eQYYj5yNno2Xh/HyDDEeORs9my8P8+VFs1HbeHkYL98A4/nUdPRtvHyMl2+A8QRpbOPlY7z85v4nSWMbL39yCzTEeIo0Ju6CmC/fEOMFpLHNl4/58hu+yFnh23z5mC/fIOORZPs2YD4GzDfI+CTZvg2YjwHzDTK+S/bZBszHgPmGGZ+k07cJ8zFhwjDjkzVb2IQJTJgwzPj0msUmTGDChGHGJ+uusAkTmDDRrLLIuitswsRkoWWY8cm6K4i1FiZMGGZ8kjBhEyYwYcIw45OECZswgQkThhlBEiZswgQmTBhmBFn/hE2YwIQJw4wgCRM2YQITJg0zgiRM2oRJTJg0zAiSMGkTJjFh0jAj6JWxTZjEhMnZW6S0AZMYMClmK6+0AZOT1bycrbySWNBjwKSarbzSBkxiwGQwW3mlDZjEgMn5EiZtwCQGTDaAkdNZ2oBJDJhqACOns7IBUxgw1QBGTmdlA6YwYKoBjJzOygZMYcCUP3tvVzZhChOmDDOSfCJWNmEKE6aaB0ayFiibMDV5ZjTMSLIWKOKxEROmDDOSrAXKJkxhwpRhRpK1QNmEKUyYMsxIshYomzCFCQsMM5LEM7AJCzBhgWFG0k/LNmEBJiwwzEgSz8AmLMCEBYYZSeIZ2IQFmLDAMKPIu01gExZgwgI5t18T2IAFGLCg2ZUg6QxswILJxoRBRpF0BsTeBAYsMMgoks7ABizAgAUGGUXSGdiABRiw0CCjSDpDG7AQAxYaZBRJZ2gDFmLAQoOMIukMbcBCDFhokFEknaENWIgBCxvASDpDG7AQAxYaZgKSztAmLMSEhYaZgCQstAkLMWFhs/dFEhbahIWT7S/DTEASFhI7YJiw0DATkISFNmEhJiwyzAQkYZFNWIQJiwwzAUlYZBMWYcIiw0xAEhbZhEWYsMgwE5CERTZhESYsMswE9K6hTViECYsMMyFJWGQTFmHComangiQssgmLMGGRYSYkCYtswiJMWNTshJGERTZh0WSTNZpdVUTEPut0o9VAE9I7eFtqq3Wy17ptNlvpjbgtsd26ney3bg06IUlpe21qP9ly3TYrfhLU9trUfrLrum22XUlW22tT+8nO67YhjsS1vTa1b/+veevyrMtaH35q377sdk7cHSWTjSfwfHX+7N7OBP0Ln69O4Nx//fZtfBdz//UbeB1jrhmf0489Rym1BVqCL9Z/PTsqyRAoeTylIinNS64DeJU6Cob+KBiFTMH+p+ujjAdk/G1rqHyenHlR1p5Ic+zP6RmFXZA6d3utYNW/JgUdFlCQr9gK7rsXiyBAD+jxe2wLSZBCxSRuEKI6KmFHXbbgY3s6DOghzBg/sEbniGFTMCQmvuf6ZH28D4IDE8JbrTgJM4Bh8sf0qTvnA0wLQK8n2ULEaHoAM485T43SdKIKQIXk5QudpQMyD/mKrlXqDsgBcoANjzcth+NvgAoYOo/HPPgEEFRsEE3I1Fn4af8o7INx9JlZs37UBIoGAEyJViBiy44/5gTwg463lq7b/e303e7/Pb/7q7q/UftX8mYMPooMDKELuGISig80ANkGNVXwoOrPbAQBgXiukKA/iAPrC0BCyCur/UfjgFPAe8hLFvnxKwgLpCzkFRr7Q1UgB24eIQ/M7kePoPYBDb+DUfKWUeDXZmDSAD3F6+JwvBGICnDh8caPOPwCsAqiEjzQml8BgohAQN1U5d1z5s7DAMGBYi94nM2ebAFUQZUVvKox+6kxQA7EGvEm/fznwEAWBBuxx2f6swowdWGlZXcenB4A8giqgOBNDPpXFSC6CETHliSEAhBbxCNn7kgQ0GGQO8FjvD3LFkiAmsITmF+ESkCc4hW5iRrxOACfP3m4TTSbpz5CGIxswO+6Pc/A0qN74gt4QzE5bgEUMJBHvythkqk5ntkH7tygqx4PYutMBhAdKAB+t/aRiqnKG5sQcG12Pnjaw6/2QayAHr9bt0neTar7eh0EBQY64o3G8iE6YBKCARK8VE7PxQGPNiBOcUVf55bqAtzgBW+Z0B9hA0TATVnwSkMrMvwSFtRksEIIeFrNaXEAC8CXzxtKcAoc0AHj5vPGbXK486gFpHh9Qgf3gEyDii55t/18+P3D0zGOi8R+GFGgIoVXi/apI6UDgFfIy+Eo3Z2WRwvDjPJqyHD4HpiaYDb5vNnUneYOhgSwz1PIJ9udYEh5Au3H93H7bT6oYREsrEwtPJNB9eeNVl9TmiJDTOcQlIaIl+HhxBuQYxCX5E2gyWklIN0AScVLUoUfQVwwCV1emqbH6oCugZuY4k2+amaFLACKkreaGo/fATKgfiq2DHmHFoBIxVsX97/mAgiBAYuY6SaPIQEMAJ4CXtL782iACEBb8eLCxz+AaQe6GPCkln6QCMokGMuItw5uDoUAoYFeBrwJDI9yAEJg1gS8lUZ7wBYo1yBNfrdBJ3lSxKYNqP0how582jhFUug0ybRzv/v07dv/ATa/WzQ="; \ No newline at end of file diff --git a/docs/classes/AbstractNavigator.html b/docs/classes/AbstractNavigator.html index 33cde8f8..46ecf40f 100644 --- a/docs/classes/AbstractNavigator.html +++ b/docs/classes/AbstractNavigator.html @@ -1,592 +1,89 @@ - - - - - - AbstractNavigator | @auth0/auth0-angular - - - - - - - - - - - - -
-
- @auth0/auth0-angular - - - - -
    -
    -
    Preparing search index...
    -
    -     - -
    -
    -
    -
    -
    - -

    Class AbstractNavigator

    -
    - -
    -
    -
    - - -
    Index
    -     -
    -
    - -
    - - constructor -
    -
    -
    - -
    - - navigateByUrl -
    -
    -
    -
    -
    -
    -
    - - - - -
    -
    - - -
    -
    -
    -
    - - - - -
    -
    - -
      -
    • - -
      -
      -

      - Navigates to the specified url. The router will be used - if one is available, otherwise it falls back to - window.history.replaceState. -

      -
      -
      -

      Parameters

      -
        -
      • - url: - string -
        -

        The url to navigate to

        -
        -
        • -
      -
      -

      - Returns void -

      - -
      -
      • -
    -
    -
    -
    -
    -
    -
    -
    -
    - - -

    Settings

    -     -
    -
    - Member Visibility -
      -
    • - -
      • -
    • - -
      • -
    • - -
      • -
    -
    -
    - -
    -
    -
    -
    -
    - - -

    On This Page

    -     -
    -
    - - Constructors - - -
    -
    - - Methods - - -
    -
    -
    -
    -
    - -
    -
    -
    - -
    - - +AbstractNavigator | @auth0/auth0-angular
    +
    @auth0/auth0-angular + +
      +
      +
      Preparing search index...
      +
      +
      +
      + +

      Class AbstractNavigator

      +
      +
      +
      +
      Index
       +
      +
      + +
      constructor +
      +
      + +
      navigateByUrl +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
        +
      • + +
        +

        Navigates to the specified url. The router will be used if one is available, otherwise it falls back +to window.history.replaceState.

        +
        +
        +

        Parameters

        +
          +
        • url: string +

          The url to navigate to

          +
        +

        Returns void

      +
      +
      +
      +
      +

      Settings

       +
      +
      Member Visibility +
        +
        • +
        • +
      +
      +
      +

      On This Page

       +
      +
      Constructors +
      +
      Methods +
      +
      +
      +
      diff --git a/docs/classes/Auth0ClientFactory.html b/docs/classes/Auth0ClientFactory.html index 68931beb..00cfc07c 100644 --- a/docs/classes/Auth0ClientFactory.html +++ b/docs/classes/Auth0ClientFactory.html @@ -1,553 +1,77 @@ - - - - - - Auth0ClientFactory | @auth0/auth0-angular - - - - - - - - - - - - -
      -
      - @auth0/auth0-angular - - - - -
        -
        -
        Preparing search index...
        -
        -         - -
        -
        -
        -
        -
        - -

        Class Auth0ClientFactory

        -
        - -
        -
        -
        - - -
        Index
        -         -
        -
        - -
        - - constructor -
        -
        -
        - -
        - - createClient -
        -
        -
        -
        -
        -
        -
        - - - - -
        -
        - - -
        -
        -
        -
        - - - - -
        -
        - - -
        -
        -
        -
        -
        -
        -
        -
        - - -

        Settings

        -         -
        -
        - Member Visibility -
          -
        • - -
          • -
        • - -
          • -
        • - -
          • -
        -
        -
        - -
        -
        -
        -
        -
        - - -

        On This Page

        -         -
        -
        - - Constructors - - -
        -
        - - Methods - - -
        -
        -
        -
        -
        - -
        -
        -
        - -
        - - +Auth0ClientFactory | @auth0/auth0-angular
        +
        @auth0/auth0-angular + +
          +
          +
          Preparing search index...
          +
          +
          +
          + +

          Class Auth0ClientFactory

          +
          +
          +
          +
          Index
           +
          +
          + +
          constructor +
          +
          + +
          createClient +
          +
          + +
          +
          + +
          +
          + +
          +
          + +
          +
          +
          +
          +
          +

          Settings

           +
          +
          Member Visibility +
            +
            • +
            • +
          +
          +
          +

          On This Page

           +
          +
          Constructors +
          +
          Methods +
          +
          +
          +
          diff --git a/docs/classes/AuthClientConfig.html b/docs/classes/AuthClientConfig.html index d766eb60..c7cccfc3 100644 --- a/docs/classes/AuthClientConfig.html +++ b/docs/classes/AuthClientConfig.html @@ -1,684 +1,110 @@ - - - - - - AuthClientConfig | @auth0/auth0-angular - - - - - - - - - - - - -
          -
          - @auth0/auth0-angular - - - - -
            -
            -
            Preparing search index...
            -
            -             - -
            -
            -
            -
            -
            - -

            Class AuthClientConfig

            -
            -
            -
            -

            - Gets and sets configuration for the internal Auth0 client. This - can be used to provide configuration outside of using - AuthModule.forRoot, i.e. from a factory provided by - APP_INITIALIZER. -

            -
            -
            -
            - - 
            // app.module.ts
            // ---------------------------
            import { AuthModule, AuthClientConfig } from '@auth0/auth0-angular';

            // Provide an initializer function that returns a Promise
            function configInitializer(
              http: HttpClient,
              config: AuthClientConfig
            ) {
              return () =>
                http
                  .get('/config')
                  .toPromise()
                  .then((loadedConfig: any) => config.set(loadedConfig));   // Set the config that was loaded asynchronously here
            }

            // Provide APP_INITIALIZER with this function. Note that there is no config passed to AuthModule.forRoot
            imports: [
              // other imports..

              HttpClientModule,
              AuthModule.forRoot(),   //<- don't pass any config here
            ],
            providers: [
              {
                provide: APP_INITIALIZER,
                useFactory: configInitializer,    // <- pass your initializer function here
                deps: [HttpClient, AuthClientConfig],
                multi: true,
              },
            ],
+AuthClientConfig | @auth0/auth0-angular
            
+
            @auth0/auth0-angular
+
+
              
+
              
+
              Preparing search index...
              
+
              
+
              
+
              
+
+
              Class AuthClientConfig
              
+
              
+
              Gets and sets configuration for the internal Auth0 client. This can be
+used to provide configuration outside of using AuthModule.forRoot, i.e. from
+a factory provided by APP_INITIALIZER.
              
+
              
+
              
+
              
+
              // app.module.ts
              // ---------------------------
              import { AuthModule, AuthClientConfig } from '@auth0/auth0-angular';

              // Provide an initializer function that returns a Promise
              function configInitializer(
                http: HttpClient,
                config: AuthClientConfig
              ) {
                return () =>
                  http
                    .get('/config')
                    .toPromise()
                    .then((loadedConfig: any) => config.set(loadedConfig));   // Set the config that was loaded asynchronously here
              }

              // Provide APP_INITIALIZER with this function. Note that there is no config passed to AuthModule.forRoot
              imports: [
                // other imports..

                HttpClientModule,
                AuthModule.forRoot(),   //<- don't pass any config here
              ],
              providers: [
                {
                  provide: APP_INITIALIZER,
                  useFactory: configInitializer,    // <- pass your initializer function here
                  deps: [HttpClient, AuthClientConfig],
                  multi: true,
                },
              ],
 
              
-            
              
-          
              
-        
              
-        
-        
              
-          
              
-            
              
-              
-                
-                
              Index
              
-                            
-              
              
-                
              
-                  
-                  
              
-                    
-                        constructor
-                  
              
-                
              
-                
              
-                  
-                  
              
-                    
-                        get
-                    
-                        set
-                  
              
-                
              
-              
              
-            
              
-          
              
-        
              
-        
              
-          
-            
-            
-          
-          
              
-            
              
-              
-              
-            
              
-          
              
-        
              
-        
              
-          
-            
-            
-          
-          
              
-            
              
-              
-              
-            
              
-            
              
-              
-              
-            
              
-          
              
-        
              
-      
              
-      
              
-        
              
-          
              
-            
              
-              
-                
-                
              Settings
              
-                            
-              
              
-                
              
-                  Member Visibility
-                  
                
-                    
              • 
-                      
-                    
                • 
-                    
              • 
-                      
-                    
                • 
-                    
              • 
-                      
-                    
                • 
-                  
              
-                
              
-                
              
-                  
-                
              
-              
              
-            
              
-          
              
-          
              
-            
-              
-              
              On This Page
              
-                          
-            
              
-              
              
-                
-                  Constructors
-                
-                
-              
              
-              
              
-                
-                  Methods
-                
-                
-              
              
-            
              
-          
              
-        
              
-        
              
-          
-        
              
-      
              
-    
              
-    
              
-    
              
-  
-
+
+
              +
              +
              +
              +
              Index
               +
              +
              + +
              constructor +
              +
              + +
              get +set +
              +
              + +
              +
              + +
              +
              + +
              +
              + +
              +
              + +
              +
              +
              +
              +
              +

              Settings

               +
              +
              Member Visibility +
                +
                • +
                • +
              +
              +
              +

              On This Page

               +
              +
              Constructors +
              +
              Methods +
              +
              +
              +
              diff --git a/docs/classes/AuthGuard.html b/docs/classes/AuthGuard.html index 6c0793f3..fdcbfa63 100644 --- a/docs/classes/AuthGuard.html +++ b/docs/classes/AuthGuard.html @@ -1,796 +1,114 @@ - - - - - - AuthGuard | @auth0/auth0-angular - - - - - - - - - - - - -
              -
              - @auth0/auth0-angular - - - - -
                -
                -
                Preparing search index...
                -
                -                 - -
                -
                -
                -
                -
                - -

                Class AuthGuard

                -
                - -
                -
                -
                - - -
                Index
                -                 -
                -
                - -
                - - constructor -
                -
                -
                - -
                - - canActivate - - canActivateChild - - canLoad -
                -
                -
                -
                -
                -
                -
                - - - - -
                -
                - - -
                -
                -
                -
                - - - - -
                -
                - -
                  -
                • - -
                  -
                  -

                  Parameters

                  -
                    -
                  • - next: - ActivatedRouteSnapshot -
                    • -
                  • - state: - RouterStateSnapshot -
                    • -
                  -
                  -

                  - Returns Observable<boolean> -

                  - -
                  -
                  • -
                -
                -
                - -
                  -
                • - -
                  -
                  -

                  Parameters

                  -
                    -
                  • - childRoute: - ActivatedRouteSnapshot -
                    • -
                  • - state: - RouterStateSnapshot -
                    • -
                  -
                  -

                  - Returns Observable<boolean> -

                  - -
                  -
                  • -
                -
                -
                - -
                  -
                • - -
                  -
                  -

                  Parameters

                  -
                    -
                  • - route: - Route -
                    • -
                  • - segments: - UrlSegment[] -
                    • -
                  -
                  -

                  - Returns Observable<boolean> -

                  - -
                  -
                  • -
                -
                -
                -
                -
                -
                -
                -
                -
                - - -

                Settings

                -                 -
                -
                - Member Visibility -
                  -
                • - -
                  • -
                • - -
                  • -
                • - -
                  • -
                -
                -
                - -
                -
                -
                -
                -
                - - -

                On This Page

                -                 -
                -
                - - Constructors - - -
                -
                - - Methods - - -
                -
                -
                -
                -
                - -
                -
                -
                -
                -
                - - +AuthGuard | @auth0/auth0-angular
                +
                @auth0/auth0-angular + +
                  +
                  +
                  Preparing search index...
                  +
                  +
                  +
                  + +

                  Class AuthGuard

                  +
                  +
                  +
                  +
                  Index
                   +
                  +
                  + +
                  constructor +
                  +
                  + +
                  canActivate +canActivateChild +canLoad +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                    +
                  • + +
                    +
                    +

                    Parameters

                    +
                      +
                    • next: ActivatedRouteSnapshot
                      • +
                    • state: RouterStateSnapshot
                    +

                    Returns Observable<boolean>

                  +
                  + +
                    +
                  • + +
                    +
                    +

                    Parameters

                    +
                      +
                    • childRoute: ActivatedRouteSnapshot
                      • +
                    • state: RouterStateSnapshot
                    +

                    Returns Observable<boolean>

                  +
                  + +
                  +
                  +
                  +
                  +
                  +

                  Settings

                   +
                  +
                  Member Visibility +
                    +
                    • +
                    • +
                  +
                  +
                  +

                  On This Page

                   +
                  +
                  Constructors +
                  +
                  Methods +
                  +
                  +
                  +
                  diff --git a/docs/classes/AuthHttpInterceptor.html b/docs/classes/AuthHttpInterceptor.html index a3aedec2..a0bc7224 100644 --- a/docs/classes/AuthHttpInterceptor.html +++ b/docs/classes/AuthHttpInterceptor.html @@ -1,680 +1,100 @@ - - - - - - AuthHttpInterceptor | @auth0/auth0-angular - - - - - - - - - - - - -
                  -
                  - @auth0/auth0-angular - - - - -
                    -
                    -
                    Preparing search index...
                    -
                    -                     - -
                    -
                    -
                    -
                    -
                    - -

                    Class AuthHttpInterceptor

                    -
                    -
                    -

                    Implements

                    -
                      -
                    • HttpInterceptor
                      • -
                    -
                    - -
                    -
                    -
                    - - -
                    Index
                    -                     -
                    -
                    - -
                    - - constructor -
                    -
                    -
                    - -
                    - - intercept -
                    -
                    -
                    -
                    -
                    -
                    -
                    - - - - -
                    -
                    - - -
                    -
                    -
                    -
                    - - - - -
                    -
                    - -
                      -
                    • - -
                      -
                      -

                      Identifies and handles a given HTTP request.

                      -
                      -
                      -

                      Parameters

                      -
                        -
                      • - req: - HttpRequest<any> -
                        -

                        The outgoing request object to handle.

                        -
                        -
                        • -
                      • - next: - HttpHandler -
                        -

                        - The next interceptor in the chain, or the backend - if no interceptors remain in the chain. -

                        -
                        -
                        • -
                      -
                      -

                      - Returns Observable<HttpEvent<any>> -

                      -

                      An observable of the event stream.

                      - -
                      -
                      • -
                    -
                    -
                    -
                    -
                    -
                    -
                    -
                    -
                    - - -

                    Settings

                    -                     -
                    -
                    - Member Visibility -
                      -
                    • - -
                      • -
                    • - -
                      • -
                    • - -
                      • -
                    -
                    -
                    - -
                    -
                    -
                    -
                    -
                    - - -

                    On This Page

                    -                     -
                    -
                    - - Constructors - - -
                    -
                    - - Methods - - -
                    -
                    -
                    -
                    -
                    - -
                    -
                    -
                    -
                    -
                    - - +AuthHttpInterceptor | @auth0/auth0-angular
                    +
                    @auth0/auth0-angular + +
                      +
                      +
                      Preparing search index...
                      +
                      +
                      +
                      + +

                      Class AuthHttpInterceptor

                      +
                      +

                      Implements

                      +
                        +
                      • HttpInterceptor
                      +
                      +
                      +
                      +
                      Index
                       +
                      +
                      + +
                      constructor +
                      +
                      + +
                      intercept +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                        +
                      • + +
                        +

                        Identifies and handles a given HTTP request.

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • req: HttpRequest<any> +

                          The outgoing request object to handle.

                          +
                          • +
                        • next: HttpHandler +

                          The next interceptor in the chain, or the backend +if no interceptors remain in the chain.

                          +
                        +

                        Returns Observable<HttpEvent<any>>

                        An observable of the event stream.

                        +
                      +
                      +
                      +
                      +
                      +

                      Settings

                       +
                      +
                      Member Visibility +
                        +
                        • +
                        • +
                      +
                      +
                      +

                      On This Page

                       +
                      +
                      Constructors +
                      +
                      Methods +
                      +
                      +
                      +
                      diff --git a/docs/classes/AuthModule.html b/docs/classes/AuthModule.html index 69d969b7..6a6546ca 100644 --- a/docs/classes/AuthModule.html +++ b/docs/classes/AuthModule.html @@ -1,567 +1,82 @@ - - - - - - AuthModule | @auth0/auth0-angular - - - - - - - - - - - - -
                      -
                      - @auth0/auth0-angular - - - - -
                        -
                        -
                        Preparing search index...
                        -
                        -                         - -
                        -
                        -
                        -
                        -
                        - -

                        Class AuthModule

                        -
                        - -
                        -
                        -
                        - - -
                        Index
                        -                         -
                        -
                        - -
                        - - constructor -
                        -
                        -
                        - -
                        - - forRoot -
                        -
                        -
                        -
                        -
                        -
                        -
                        - - - - -
                        -
                        - - -
                        -
                        -
                        -
                        - - - - -
                        -
                        - -
                          -
                        • - -
                          -
                          -

                          - Initialize the authentication module system. - Configuration can either be specified here, or by - calling AuthClientConfig.set (perhaps from an - APP_INITIALIZER factory function). -

                          -
                          -
                          -

                          Parameters

                          -
                            -
                          • - Optionalconfig: - AuthConfig -
                            -

                            The optional configuration for the SDK.

                            -
                            -
                            • -
                          -
                          -

                          - Returns - ModuleWithProviders<AuthModule> -

                          - -
                          -
                          • -
                        -
                        -
                        -
                        -
                        -
                        -
                        -
                        -
                        - - -

                        Settings

                        -                         -
                        -
                        - Member Visibility -
                          -
                        • - -
                          • -
                        • - -
                          • -
                        • - -
                          • -
                        -
                        -
                        - -
                        -
                        -
                        -
                        -
                        - - -

                        On This Page

                        -                         -
                        -
                        - - Constructors - - -
                        -
                        - - Methods - - -
                        -
                        -
                        -
                        -
                        - -
                        -
                        -
                        -
                        -
                        - - +AuthModule | @auth0/auth0-angular
                        +
                        @auth0/auth0-angular + +
                          +
                          +
                          Preparing search index...
                          +
                          +
                          +
                          + +

                          Class AuthModule

                          +
                          +
                          +
                          +
                          Index
                           +
                          +
                          + +
                          constructor +
                          +
                          + +
                          forRoot +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          +
                          +
                          +
                          +

                          Settings

                           +
                          +
                          Member Visibility +
                            +
                            • +
                            • +
                          +
                          +
                          +

                          On This Page

                           +
                          +
                          Constructors +
                          +
                          Methods +
                          +
                          +
                          +
                          diff --git a/docs/classes/AuthService.html b/docs/classes/AuthService.html index 7ef400f5..90a3a0f3 100644 --- a/docs/classes/AuthService.html +++ b/docs/classes/AuthService.html @@ -1,3033 +1,525 @@ - - - - - - AuthService | @auth0/auth0-angular - - - - - - - - - - - - -
                          -
                          - @auth0/auth0-angular - - - - -
                            -
                            -
                            Preparing search index...
                            -
                            -                             - -
                            -
                            -
                            -
                            -
                            - -

                            Class AuthService<TAppState>

                            -
                            -
                            -

                            Type Parameters

                            - -
                            -
                            -

                            Implements

                            -
                              -
                            • OnDestroy
                              • -
                            -
                            - -
                            -
                            -
                            - - -
                            Index
                            -                             -
                            -
                            - -
                            - - constructor -
                            -
                            -
                            - -
                            - - appState$ - - error$ - - idTokenClaims$ - - isAuthenticated$ - - isLoading$ - - mfa - - myAccount - - passkey - - user$ -
                            -
                            -
                            - -
                            - - connectAccountWithRedirect - - createFetcher - - generateDpopProof - - getAccessTokenSilently - - getAccessTokenWithPopup - - getDpopNonce - - handleRedirectCallback - - loginWithCustomTokenExchange - - loginWithPopup - - loginWithRedirect - - logout - - ngOnDestroy - - setDpopNonce -
                            -
                            -
                            -
                            -
                            -
                            -
                            - - - - -
                            -
                            - - -
                            -
                            -
                            -
                            - - - - -
                            -
                            - -
                            - appState$: - Observable<TAppState> = ... -
                            -
                            -

                            - Emits the value (if any) that was passed to the - loginWithRedirect method call but only - after handleRedirectCallback is - first called -

                            -
                            - -
                            -
                            - -
                            - error$: - Observable<Error> = ... -
                            -
                            -

                            - Emits errors that occur during login, or when checking for an - active session on startup. -

                            -
                            - -
                            -
                            - -
                            - idTokenClaims$: - Observable<IdToken - | - null - | - undefined> = ... -
                            -
                            -

                            - Emits ID token claims when authenticated, or null if not - authenticated. -

                            -
                            - -
                            -
                            - -
                            - isAuthenticated$: - Observable<boolean> = ... -
                            -
                            -

                            - Emits boolean values indicating the authentication state of - the user. If true, it means a user has - authenticated. This depends on the value of - isLoading$, so there is no need to manually check - the loading state of the SDK. -

                            -
                            - -
                            -
                            - -
                            - isLoading$: - Observable<boolean> = ... -
                            -
                            -

                            - Emits boolean values indicating the loading state of the SDK. -

                            -
                            - -
                            -
                            - -
                            - mfa: - ObservableMfaApiClient = ... -
                            -
                            -

                            - Provides MFA (Multi-Factor Authentication) operations as - Observables. -

                            -

                            - These methods are available after - getAccessTokenSilently throws an - MfaRequiredError. Use the - mfa_token from the error to call these methods. -

                            -
                            - -
                            -
                            - -
                            - myAccount: - ObservableMyAccountApiClient = ... -
                            -
                            -

                            Provides MyAccount API operations as Observables.

                            -

                            - Allows the authenticated user to list, enroll, update, and - delete their authentication methods. Requires an access token - with the appropriate - read/create/update/delete:me:authentication-methods - scopes. -

                            -
                            - -
                            -
                            - -
                            - passkey: - ObservablePasskeyApiClient = ... -
                            -
                            -

                            - Provides Passkey (WebAuthn) authentication as Observables. -

                            -

                            - Both methods handle the full WebAuthn challenge-response flow - internally. After a successful call, this updates the - authentication state to ensure consistency with the standard - authentication flows. -

                            -
                            - -
                            -
                            - -
                            - user$: - Observable<User - | - null - | - undefined> = ... -
                            -
                            -

                            - Emits details about the authenticated user, or null if not - authenticated. -

                            -
                            - -
                            -
                            -
                            -
                            - - - - -
                            -
                            - -
                              -
                            • - -
                              -
                              - 
                              connectAccountWithRedirect({
                                connection: 'google-oauth2',
                                scopes: ['openid', 'profile', 'email', 'https://www.googleapis.com/auth/drive.readonly'],
                                authorization_params: {
                                  // additional authorization params to forward to the authorization server
                                }
                              });
+AuthService | @auth0/auth0-angular
                              
+
                              @auth0/auth0-angular
+
+
                                
+
                                
+
                                Preparing search index...
                                
+
                                
+
                                
+
                                
+
+
                                Class AuthService<TAppState>
                                
+
                                
+
                                Type Parameters
                                
+
                                
+
                                
+
                                Implements
                                
+
                                  
+
                                • OnDestroy
                                
+
                                
+
                                
+
                                
+
                                Index
                                
+
                                
+
                                
+
+
                                constructor
+
                                
+
                                
+
+
                                appState$
+error$
+idTokenClaims$
+isAuthenticated$
+isLoading$
+mfa
+myAccount
+passkey
+user$
+
                                
+
                                
+
+
                                connectAccountWithRedirect
+createFetcher
+generateDpopProof
+getAccessTokenSilently
+getAccessTokenWithPopup
+getDpopNonce
+handleRedirectCallback
+loginWithCustomTokenExchange
+loginWithPopup
+loginWithRedirect
+logout
+ngOnDestroy
+setDpopNonce
+
                                
+
                                
+
+
                                
+
                                
+
+
                                
+
                                
+
+
                                
+
                                
+
+
                                appState$: Observable<TAppState> = ...
                                
+
                                Emits the value (if any) that was passed to the loginWithRedirect method call
+but only after handleRedirectCallback is first called
                                
+
                                
+
                                
+
+
                                error$: Observable<Error> = ...
                                
+
                                Emits errors that occur during login, or when checking for an active session on startup.
                                
+
                                
+
                                
+
+
                                idTokenClaims$: Observable<IdToken | null | undefined> = ...
                                
+
                                Emits ID token claims when authenticated, or null if not authenticated.
                                
+
                                
+
                                
+
+
                                isAuthenticated$: Observable<boolean> = ...
                                
+
                                Emits boolean values indicating the authentication state of the user. If true, it means a user has authenticated.
+This depends on the value of isLoading$, so there is no need to manually check the loading state of the SDK.
                                
+
                                
+
                                
+
+
                                isLoading$: Observable<boolean> = ...
                                
+
                                Emits boolean values indicating the loading state of the SDK.
                                
+
                                
+
                                
+
+
                                mfa: ObservableMfaApiClient = ...
                                
+
                                Provides MFA (Multi-Factor Authentication) operations as Observables.
                                
+
                                These methods are available after getAccessTokenSilently throws an MfaRequiredError.
+Use the mfa_token from the error to call these methods.
                                
+
                                
+
                                
+
+
                                myAccount: ObservableMyAccountApiClient = ...
                                
+
                                Provides MyAccount API operations as Observables.
                                
+
                                Allows the authenticated user to list, enroll, update, and delete their
+authentication methods. Requires an access token with the appropriate
+read/create/update/delete:me:authentication-methods scopes.
                                
+
                                
+
                                
+
+
                                passkey: ObservablePasskeyApiClient = ...
                                
+
                                Provides Passkey (WebAuthn) authentication as Observables.
                                
+
                                Both methods handle the full WebAuthn challenge-response flow internally.
+After a successful call, this updates the authentication state to ensure
+consistency with the standard authentication flows.
                                
+
                                
+
                                
+
+
                                user$: Observable<User | null | undefined> = ...
                                
+
                                Emits details about the authenticated user, or null if not authenticated.
                                
+
                                
+
                                
+
+
                                
+
                                
+
+
                                  
+
                                • 
+
+
                                  
+
                                  connectAccountWithRedirect({
                                    connection: 'google-oauth2',
                                    scopes: ['openid', 'profile', 'email', 'https://www.googleapis.com/auth/drive.readonly'],
                                    authorization_params: {
                                      // additional authorization params to forward to the authorization server
                                    }
                                  });
 
                                  
 
-                      
                                  
-                        Redirects to the /connect URL using the
-                        parameters provided as arguments. This then redirects to
-                        the connection's login page where the user can
-                        authenticate and authorize the account to be connected.
-                      
                                  
-                      
                                  
-                        If connecting the account is successful,
-                        handleRedirectCallback will be called with
-                        the details of the connected account.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
-                    
                                  
-                    
                                  
-                      Returns Observable<void>
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
                                
+
                                
+
+
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  generateDpopProof(params).subscribe(proof => ...)
+
                                  Creates a custom fetcher instance that can be used to make authenticated
+HTTP requests. The fetcher automatically handles token refresh and can
+be configured with custom request/response handling.
                                  
+
                                  
+
                                  
+
                                  Type Parameters
                                  
+
                                  
+
                                  
+
                                  Parameters
                                  
+
                                  
+
                                  Returns Fetcher<TOutput>
                                  A Fetcher instance configured with the Auth0 client.
                                  
+
                                
+
                                
+
+
                                  
+
                                • 
+
+
                                  
+
                                  generateDpopProof(params).subscribe(proof => ...)
 
                                  
 
-                      
                                  
-                        Generates a DPoP (Demonstrating Proof-of-Possession)
-                        proof JWT. This proof is used to bind access tokens to a
-                        specific client, providing an additional layer of
-                        security for token usage.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
                                    
-                        
                                  • 
-                          params:
-                            {
-                            accessToken:
-                            string;
-                            method:
-                            string;
-                            nonce?:
-                            string;
-                            url:
-                            string
-                            }
-                          
                                    
-                            
                                    Configuration for generating the DPoP proof
                                    
-                          
                                    
-                          
                                      
-                            
                                    • 
-                              
                                      
-                                accessToken: string
-                              
                                      
-                              
                                      
-                                
                                      The access token to bind to the proof
                                      
-                              
                                      
-                            
                                      • 
-                            
                                    • 
-                              
                                      
-                                method: string
-                              
                                      
-                              
                                      
-                                
                                      The HTTP method (e.g., 'GET', 'POST')
                                      
-                              
                                      
-                            
                                      • 
-                            
                                    • 
-                              
                                      
-                                Optionalnonce?: string
-                              
                                      
-                              
                                      
-                                
                                      
-                                  Optional DPoP nonce from the authorization
-                                  server
-                                
                                      
-                              
                                      
-                            
                                      • 
-                            
                                    • 
-                              
                                      
-                                url: string
-                              
                                      
-                              
                                      
-                                
                                      The URL of the resource server endpoint
                                      
-                              
                                      
-                            
                                      • 
-                          
                                    
-                        
                                    • 
-                      
                                  
-                    
                                  
-                    
                                  
-                      Returns Observable<string>
-                    
                                  
-                    
                                  
-                      An Observable that emits the generated DPoP proof as a JWT
-                      string.
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  
-                        Fetches a new access token and returns the response from
-                        the /oauth/token endpoint, omitting the refresh token.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
                                    
-                        
                                  • 
-                          options:
-                            GetTokenSilentlyOptions
-                            &
-                            {
-                            detailedResponse:
-                            true
-                            }
-                          
                                    
-                            
                                    The options for configuring the token fetch.
                                    
-                          
                                    
-                        
                                    • 
-                      
                                  
-                    
                                  
-                    
                                  
-                      Returns Observable<GetTokenSilentlyVerboseResponse
-                      |
-                      undefined>
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  Fetches a new access token and returns it.
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
-                    
                                  
-                    
                                  
-                      Returns Observable<string
-                      |
-                      undefined>
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  getTokenWithPopup(options).subscribe(token => ...)
+
                                  Generates a DPoP (Demonstrating Proof-of-Possession) proof JWT.
+This proof is used to bind access tokens to a specific client, providing
+an additional layer of security for token usage.
                                  
+
                                  
+
                                  
+
                                  Parameters
                                  
+
                                    
+
                                  • params: { accessToken: string; method: string; nonce?: string; url: string }
+
                                    Configuration for generating the DPoP proof
                                    
+
                                    
+
                                      
+
                                    • 
+
                                      accessToken: string
                                      
+
                                      The access token to bind to the proof
                                      
+
                                      • 
+
                                    • 
+
                                      method: string
                                      
+
                                      The HTTP method (e.g., 'GET', 'POST')
                                      
+
                                      • 
+
                                    • 
+
                                      Optionalnonce?: string
                                      
+
                                      Optional DPoP nonce from the authorization server
                                      
+
                                      • 
+
                                    • 
+
                                      url: string
                                      
+
                                      The URL of the resource server endpoint
                                      
+
                                  
+
                                  Returns Observable<string>
                                  An Observable that emits the generated DPoP proof as a JWT string.
                                  
+
                                
+
                                
+
+
                                
+
                                
+
+
                                  
+
                                • 
+
+
                                  
+
                                  getTokenWithPopup(options).subscribe(token => ...)
 
                                  
 
-                      
                                  Get an access token interactively.
                                  
-                      
                                  
-                        Opens a popup with the /authorize URL using
-                        the parameters provided as arguments. Random and secure
-                        state and nonce parameters
-                        will be auto-generated. If the response is successful,
-                        results will be valid according to their expiration
-                        times.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
-                    
                                  
-                    
                                  
-                      Returns Observable<string
-                      |
-                      undefined>
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  getDpopNonce(id).subscribe(nonce => ...)
+
                                  Get an access token interactively.
                                  
+
                                  Opens a popup with the /authorize URL using the parameters
+provided as arguments. Random and secure state and nonce
+parameters will be auto-generated. If the response is successful,
+results will be valid according to their expiration times.
                                  
+
                                  
+
                                  
+
                                  Parameters
                                  
+
                                  
+
                                  Returns Observable<string | undefined>
                                
+
                                
+
+
                                  
+
                                • 
+
+
                                  
+
                                  getDpopNonce(id).subscribe(nonce => ...)
 
                                  
 
-                      
                                  
-                        Gets the DPoP nonce for the specified domain or the
-                        default domain. The nonce is used in DPoP proof
-                        generation for token binding.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
                                    
-                        
                                  • 
-                          Optionalid:
-                            string
-                          
                                    
-                            
                                    
-                              Optional identifier for the domain. If not
-                              provided, uses the default domain.
-                            
                                    
-                          
                                    
-                        
                                    • 
-                      
                                  
-                    
                                  
-                    
                                  
-                      Returns Observable<string
-                      |
-                      undefined>
-                    
                                  
-                    
                                  
-                      An Observable that emits the DPoP nonce string or
-                      undefined if not available.
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  handleRedirectCallback(url).subscribe(result => ...)
+
                                  Gets the DPoP nonce for the specified domain or the default domain.
+The nonce is used in DPoP proof generation for token binding.
                                  
+
                                  
+
                                  
+
                                  Parameters
                                  
+
                                    
+
                                  • Optionalid: string
+
                                    Optional identifier for the domain. If not provided, uses the default domain.
                                    
+
                                  
+
                                  Returns Observable<string | undefined>
                                  An Observable that emits the DPoP nonce string or undefined if not available.
                                  
+
                                
+
                                
+
+
                                  
+
                                • 
+
+
                                  
+
                                  handleRedirectCallback(url).subscribe(result => ...)
 
                                  
 
-                      
                                  
-                        After the browser redirects back to the callback page,
-                        call handleRedirectCallback to handle
-                        success and error responses from Auth0. If the response
-                        is successful, results will be valid according to their
-                        expiration times.
-                      
                                  
-                      
                                  
-                        Calling this method also refreshes the authentication
-                        and user states.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
                                    
-                        
                                  • 
-                          Optionalurl:
-                            string
-                          
                                    
-                            
                                    
-                              The URL to that should be used to retrieve the
-                              state and code values.
-                              Defaults to window.location.href if
-                              not given.
-                            
                                    
-                          
                                    
-                        
                                    • 
-                      
                                  
-                    
                                  
-                    
                                  
-                      Returns Observable<
                                      RedirectLoginResult<TAppState>
                                      |
-                      ConnectAccountRedirectResult<TAppState>,
                                  >
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  loginWithCustomTokenExchange(options).subscribe(tokenResponse => ...)
+
                                  After the browser redirects back to the callback page,
+call handleRedirectCallback to handle success and error
+responses from Auth0. If the response is successful, results
+will be valid according to their expiration times.
                                  
+
                                  Calling this method also refreshes the authentication and user states.
                                  
+
                                  
+
                                  
+
                                  Parameters
                                  
+
                                    
+
                                  • Optionalurl: string
+
                                    The URL to that should be used to retrieve the state and code values. Defaults to window.location.href if not given.
                                    
+
                                  
+
                                  Returns Observable<
                                      RedirectLoginResult<TAppState>
                                      | ConnectAccountRedirectResult<TAppState>,
                                  >
                                
+
                                
+
+
                                  
+
                                • 
+
+
                                  
+
                                  loginWithCustomTokenExchange(options).subscribe(tokenResponse => ...)
 
                                  
 
-                      
                                  
-                        Exchanges an external subject token for Auth0 tokens and
-                        establishes an authenticated session.
-                      
                                  
-                      
                                  
-                        This method implements the token exchange grant as
-                        specified in RFC 8693. It performs a token exchange by
-                        sending a request to the
-                        /oauth/token endpoint with the external
-                        token and returns Auth0 tokens (access token, ID token,
-                        etc.).
-                      
                                  
-                      
                                  The request includes the following parameters:
                                  
-                      
                                    
-                        
                                  • 
-                          grant_type: Hard-coded to
-                          "urn:ietf:params:oauth:grant-type:token-exchange"
-                        
                                    • 
-                        
                                  • 
-                          subject_token: The external token to be
-                          exchanged
-                        
                                    • 
-                        
                                  • 
-                          subject_token_type: A namespaced URI
-                          identifying the token type (must be under your
-                          organization's control)
-                        
                                    • 
-                        
                                  • 
-                          audience: The target audience (falls back
-                          to the SDK's default audience if not provided)
-                        
                                    • 
-                        
                                  • 
-                          scope: Space-separated list of scopes
-                          (merged with the SDK's default scopes)
-                        
                                    • 
-                      
                                  
-                      
                                  
-                        After a successful token exchange, this method updates
-                        the authentication state to ensure consistency with the
-                        standard authentication flows.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
-                    
                                  
-                    
                                  
-                      Returns Observable<TokenEndpointResponse>
-                    
                                  
-                    
                                  
-                      An Observable that emits the token endpoint response
-                      containing Auth0 tokens
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  await loginWithPopup(options);
+
                                  Exchanges an external subject token for Auth0 tokens and establishes an authenticated session.
                                  
+
                                  This method implements the token exchange grant as specified in RFC 8693.
+It performs a token exchange by sending a request to the /oauth/token endpoint
+with the external token and returns Auth0 tokens (access token, ID token, etc.).
                                  
+
                                  The request includes the following parameters:
                                  
+
                                    
+
                                  • grant_type: Hard-coded to "urn:ietf:params:oauth:grant-type:token-exchange"
                                    • 
+
                                  • subject_token: The external token to be exchanged
                                    • 
+
                                  • subject_token_type: A namespaced URI identifying the token type (must be under your organization's control)
                                    • 
+
                                  • audience: The target audience (falls back to the SDK's default audience if not provided)
                                    • 
+
                                  • scope: Space-separated list of scopes (merged with the SDK's default scopes)
                                    • 
+
                                  
+
                                  After a successful token exchange, this method updates the authentication state
+to ensure consistency with the standard authentication flows.
                                  
+
                                  
+
                                  
+
                                  Parameters
                                  
+
                                  
+
                                  Returns Observable<TokenEndpointResponse>
                                  An Observable that emits the token endpoint response containing Auth0 tokens
                                  
+
                                
+
                                
+
+
                                  
+
                                • 
+
+
                                  
+
                                  await loginWithPopup(options);
 
                                  
 
-                      
                                  
-                        Opens a popup with the /authorize URL using
-                        the parameters provided as arguments. Random and secure
-                        state and nonce parameters
-                        will be auto-generated. If the response is successful,
-                        results will be valid according to their expiration
-                        times.
-                      
                                  
-                      
                                  
-                        IMPORTANT: This method has to be called from an event
-                        handler that was started by the user like a button
-                        click, for example, otherwise the popup will be blocked
-                        in most browsers.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
-                    
                                  
-                    
                                  
-                      Returns Observable<void>
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  loginWithRedirect(options);
+
                                  Opens a popup with the /authorize URL using the parameters
+provided as arguments. Random and secure state and nonce
+parameters will be auto-generated. If the response is successful,
+results will be valid according to their expiration times.
                                  
+
                                  IMPORTANT: This method has to be called from an event handler
+that was started by the user like a button click, for example,
+otherwise the popup will be blocked in most browsers.
                                  
+
                                  
+
                                  
+
                                  Parameters
                                  
+
                                  
+
                                  Returns Observable<void>
                                
+
                                
+
+
-            
                                
-            
                                
-              
-              
                                
+
                                
+
+
                                  
+
                                • 
+
+
                                  
+
                                  logout();
 
                                  
 
-                      
                                  
-                        Clears the application session and performs a redirect
-                        to /v2/logout, using the parameters
-                        provided as arguments, to clear the Auth0 session. If
-                        the federated option is specified it also
-                        clears the Identity Provider session. If the
-                        openUrl option is set to false, it only
-                        clears the application session. It is invalid to set
-                        both the federated to true and
-                        openUrl to false, and an error
-                        will be thrown if you do.
-                        Read more about how Logout works at Auth0.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
                                    
-                        
                                  • 
-                          Optionaloptions:
-                            LogoutOptions
-                          
                                    
-                            
                                    The logout options
                                    
-                          
                                    
-                        
                                    • 
-                      
                                  
-                    
                                  
-                    
                                  
-                      Returns Observable<void>
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  setDpopNonce(nonce, id).subscribe(() => ...)
+
                                  Clears the application session and performs a redirect to /v2/logout, using
+the parameters provided as arguments, to clear the Auth0 session.
+If the federated option is specified it also clears the Identity Provider session.
+If the openUrl option is set to false, it only clears the application session.
+It is invalid to set both the federated to true and openUrl to false,
+and an error will be thrown if you do.
+Read more about how Logout works at Auth0.
                                  
+
                                  
+
                                  
+
                                  Parameters
                                  
+
                                  
+
                                  Returns Observable<void>
                                
+
                                
+
+
                                
+
                                
+
+
                                  
+
                                • 
+
+
                                  
+
                                  setDpopNonce(nonce, id).subscribe(() => ...)
 
                                  
 
-                      
                                  
-                        Sets the DPoP nonce for the specified domain or the
-                        default domain. This is typically used after receiving a
-                        new nonce from the authorization server.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
                                    
-                        
                                  • 
-                          nonce:
-                            string
-                          
                                    
-                            
                                    The DPoP nonce value to set.
                                    
-                          
                                    
-                        
                                    • 
-                        
                                  • 
-                          Optionalid:
-                            string
-                          
                                    
-                            
                                    
-                              Optional identifier for the domain. If not
-                              provided, uses the default domain.
-                            
                                    
-                          
                                    
-                        
                                    • 
-                      
                                  
-                    
                                  
-                    
                                  
-                      Returns Observable<void>
-                    
                                  
-                    
                                  An Observable that completes when the nonce is set.
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-          
                                
-        
                                
-      
                                
-      
                                
-        
                                
-          
                                
-            
                                
-              
-                
-                
                                Settings
                                
-                                              
-              
                                
-                
                                
-                  Member Visibility
-                  
                                  
-                    
                                • 
-                      
-                    
                                  • 
-                    
                                • 
-                      
-                    
                                  • 
-                    
                                • 
-                      
-                    
                                  • 
-                  
                                
-                
                                
-                
                                
-                  
-                
                                
-              
                                
-            
                                
-          
                                
-          
                                
-            
-              
-              
                                On This Page
                                
-                                            
-            
                                
-              
                                
-                
-                  Constructors
-                
-                
-              
                                
-              
                                
-                
-                  Properties
-                
-                
-              
                                
-              
                                
-                
-                  Methods
-                
-                
-              
                                
-            
                                
-          
                                
-        
                                
-        
                                
-          
-        
                                
-      
                                
-    
                                
-    
                                
-    
                                
-  
-
+
                                Sets the DPoP nonce for the specified domain or the default domain.
+This is typically used after receiving a new nonce from the authorization server.
                                
+
                                +
                                +

                                Parameters

                                +
                                  +
                                • nonce: string +

                                  The DPoP nonce value to set.

                                  +
                                  • +
                                • Optionalid: string +

                                  Optional identifier for the domain. If not provided, uses the default domain.

                                  +
                                +

                                Returns Observable<void>

                                An Observable that completes when the nonce is set.

                                +
                              +
                              +
                              +
                              +
                              +

                              Settings

                               +
                              +
                              Member Visibility +
                                +
                                • +
                                • +
                              +
                              +
                              +

                              On This Page

                               +
                              +
                              Constructors +
                              +
                              Properties +
                              +
                              Methods +
                              +
                              +
                              +
                              diff --git a/docs/classes/AuthState.html b/docs/classes/AuthState.html index 87168d06..7145a79d 100644 --- a/docs/classes/AuthState.html +++ b/docs/classes/AuthState.html @@ -1,1172 +1,188 @@ - - - - - - AuthState | @auth0/auth0-angular - - - - - - - - - - - - -
                              -
                              - @auth0/auth0-angular - - - - -
                                -
                                -
                                Preparing search index...
                                -
                                -                                 - -
                                -
                                -
                                -
                                -
                                - -

                                Class AuthState

                                -
                                -
                                -
                                -

                                Tracks the Authentication State for the SDK

                                -
                                -
                                - -
                                -
                                -
                                - - -
                                Index
                                -                                 -
                                -
                                - -
                                - - constructor -
                                -
                                -
                                - -
                                - - error$ - - idTokenClaims$ - - isAuthenticated$ - - isLoading$ - - user$ -
                                -
                                -
                                - -
                                - - refresh - - setAccessToken - - setError - - setIsLoading -
                                -
                                -
                                -
                                -
                                -
                                -
                                - - - - -
                                -
                                - - -
                                -
                                -
                                -
                                - - - - -
                                -
                                - -
                                - error$: - Observable<Error> = ... -
                                -
                                -

                                - Emits errors that occur during login, or when checking for an - active session on startup. -

                                -
                                - -
                                -
                                - -
                                - idTokenClaims$: - Observable<IdToken - | - null - | - undefined> = ... -
                                -
                                -

                                - Emits ID token claims when authenticated, or null if not - authenticated. -

                                -
                                - -
                                -
                                - -
                                - isAuthenticated$: - Observable<boolean> = ... -
                                -
                                -

                                - Emits boolean values indicating the authentication state of - the user. If true, it means a user has - authenticated. This depends on the value of - isLoading$, so there is no need to manually check - the loading state of the SDK. -

                                -
                                - -
                                -
                                - -
                                - isLoading$: - Observable<boolean> = ... -
                                -
                                -

                                - Emits boolean values indicating the loading state of the SDK. -

                                -
                                - -
                                -
                                - -
                                - user$: - Observable<User - | - null - | - undefined> = ... -
                                -
                                -

                                - Emits details about the authenticated user, or null if not - authenticated. -

                                -
                                - -
                                -
                                -
                                -
                                - - - - -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -

                                  - Refresh the state to ensure the - isAuthenticated, user$ and - idTokenClaims$ reflect the most up-to-date - values from Auth0Client. -

                                  -
                                  -

                                  - Returns void -

                                  - -
                                  -
                                  • -
                                -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -

                                  - Update the access token, doing so will also refresh the - state. -

                                  -
                                  -
                                  -

                                  Parameters

                                  -
                                    -
                                  • - accessToken: - string -
                                    -

                                    The new Access Token

                                    -
                                    -
                                    • -
                                  -
                                  -

                                  - Returns void -

                                  - -
                                  -
                                  • -
                                -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -

                                  - Emits the error in the error$ observable. -

                                  -
                                  -
                                  -

                                  Parameters

                                  -
                                    -
                                  • - error: - any -
                                    -

                                    The new error

                                    -
                                    -
                                    • -
                                  -
                                  -

                                  - Returns void -

                                  - -
                                  -
                                  • -
                                -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -

                                  Update the isLoading state using the provided value

                                  -
                                  -
                                  -

                                  Parameters

                                  -
                                    -
                                  • - isLoading: - boolean -
                                    -

                                    The new value for isLoading

                                    -
                                    -
                                    • -
                                  -
                                  -

                                  - Returns void -

                                  - -
                                  -
                                  • -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                - - -

                                Settings

                                -                                 -
                                -
                                - Member Visibility -
                                  -
                                • - -
                                  • -
                                • - -
                                  • -
                                • - -
                                  • -
                                -
                                -
                                - -
                                -
                                -
                                -
                                -
                                - - -

                                On This Page

                                -                                 -
                                -
                                - - Constructors - - -
                                -
                                - - Properties - - -
                                -
                                - - Methods - - -
                                -
                                -
                                -
                                -
                                - -
                                -
                                -
                                -
                                -
                                - - +AuthState | @auth0/auth0-angular
                                +
                                @auth0/auth0-angular + +
                                  +
                                  +
                                  Preparing search index...
                                  +
                                  +
                                  +
                                  + +

                                  Class AuthState

                                  +
                                  +

                                  Tracks the Authentication State for the SDK

                                  +
                                  +
                                  +
                                  +
                                  +
                                  Index
                                   +
                                  +
                                  + +
                                  constructor +
                                  +
                                  + +
                                  error$ +idTokenClaims$ +isAuthenticated$ +isLoading$ +user$ +
                                  +
                                  + +
                                  refresh +setAccessToken +setError +setIsLoading +
                                  +
                                  + +
                                  +
                                  + +
                                  +
                                  + +
                                  +
                                  + +
                                  error$: Observable<Error> = ...
                                  +

                                  Emits errors that occur during login, or when checking for an active session on startup.

                                  +
                                  +
                                  + +
                                  idTokenClaims$: Observable<IdToken | null | undefined> = ...
                                  +

                                  Emits ID token claims when authenticated, or null if not authenticated.

                                  +
                                  +
                                  + +
                                  isAuthenticated$: Observable<boolean> = ...
                                  +

                                  Emits boolean values indicating the authentication state of the user. If true, it means a user has authenticated. +This depends on the value of isLoading$, so there is no need to manually check the loading state of the SDK.

                                  +
                                  +
                                  + +
                                  isLoading$: Observable<boolean> = ...
                                  +

                                  Emits boolean values indicating the loading state of the SDK.

                                  +
                                  +
                                  + +
                                  user$: Observable<User | null | undefined> = ...
                                  +

                                  Emits details about the authenticated user, or null if not authenticated.

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

                                    Update the access token, doing so will also refresh the state.

                                    +
                                    +
                                    +

                                    Parameters

                                    +
                                      +
                                    • accessToken: string +

                                      The new Access Token

                                      +
                                    +

                                    Returns void

                                  +
                                  + +
                                  +
                                  + +
                                    +
                                  • + +
                                    +

                                    Update the isLoading state using the provided value

                                    +
                                    +
                                    +

                                    Parameters

                                    +
                                      +
                                    • isLoading: boolean +

                                      The new value for isLoading

                                      +
                                    +

                                    Returns void

                                  +
                                  +
                                  +
                                  +
                                  +

                                  Settings

                                   +
                                  +
                                  Member Visibility +
                                    +
                                    • +
                                    • +
                                  +
                                  +
                                  +

                                  On This Page

                                   +
                                  +
                                  Constructors +
                                  +
                                  Properties +
                                  +
                                  Methods +
                                  +
                                  +
                                  +
                                  diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index 9f8f727b..1f129d46 100644 --- a/docs/classes/AuthenticationError.html +++ b/docs/classes/AuthenticationError.html @@ -1,1180 +1,171 @@ - - - - - - AuthenticationError | @auth0/auth0-angular - - - - - - - - - - - - -
                                  -
                                  - @auth0/auth0-angular - - - - -
                                    -
                                    -
                                    Preparing search index...
                                    -
                                    -                                     - -
                                    -
                                    -
                                    -
                                    -
                                    - -

                                    Class AuthenticationError

                                    -
                                    -
                                    -
                                    -

                                    - Thrown when handling the redirect callback fails, will be one of - Auth0's Authentication API's Standard Error Responses: - https://auth0.com/docs/api/authentication?javascript#standard-error-responses -

                                    -
                                    -
                                    -
                                    -

                                    - Hierarchy (View Summary) -

                                    - -
                                    - -
                                    -
                                    -
                                    - - -
                                    Index
                                    -                                     -
                                    -
                                    - -
                                    - - constructor -
                                    -
                                    -
                                    - -
                                    - - appState - - error - - error_description - - message - - name - - originalStack? - - stack? - - state - - zoneAwareStack? -
                                    -
                                    -
                                    - -
                                    - - fromPayload -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    - - - - -
                                    -
                                    - -
                                      -
                                    • - -
                                      -
                                      -

                                      Parameters

                                      -
                                        -
                                      • - error: - string -
                                        • -
                                      • - error_description: - string -
                                        • -
                                      • - state: - string -
                                        • -
                                      • - OptionalappState: - any -
                                        • -
                                      -
                                      -

                                      - Returns - AuthenticationError -

                                      - -
                                      -
                                      • -
                                    -
                                    -
                                    -
                                    -
                                    - - - - -
                                    -
                                    - -
                                    - appState: - any -
                                    - -
                                    -
                                    - -
                                    - error: - string -
                                    - -
                                    -
                                    - -
                                    - error_description: - string -
                                    - -
                                    -
                                    - -
                                    - message: - string -
                                    - -
                                    -
                                    - -
                                    - name: - string -
                                    - -
                                    -
                                    - -
                                    - originalStack?: - string -
                                    -
                                    -

                                    Original stack trace with no modifications

                                    -
                                    - -
                                    -
                                    - -
                                    - stack?: - string -
                                    - -
                                    -
                                    - -
                                    - state: - string -
                                    - -
                                    -
                                    - -
                                    - zoneAwareStack?: - string -
                                    -
                                    -

                                    - Stack trace where extra frames have been removed and zone - names added. -

                                    -
                                    - -
                                    -
                                    -
                                    -
                                    - - - - -
                                    -
                                    - -
                                      -
                                    • - -
                                      -
                                      -

                                      Parameters

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

                                      - Returns - GenericError -

                                      - -
                                      -
                                      • -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    - - -

                                    Settings

                                    -                                     -
                                    -
                                    - Member Visibility -
                                      -
                                    • - -
                                      • -
                                    • - -
                                      • -
                                    • - -
                                      • -
                                    -
                                    -
                                    - -
                                    -
                                    -
                                    -
                                    -
                                    - - -

                                    On This Page

                                    -                                     -
                                    -
                                    - - Constructors - - -
                                    -
                                    - - Properties - - -
                                    -
                                    - - Methods - - -
                                    -
                                    -
                                    -
                                    -
                                    - -
                                    -
                                    -
                                    -
                                    -
                                    - - +AuthenticationError | @auth0/auth0-angular
                                    +
                                    @auth0/auth0-angular + +
                                      +
                                      +
                                      Preparing search index...
                                      +
                                      +
                                      +
                                      + +

                                      Class AuthenticationError

                                      +
                                      +

                                      Thrown when handling the redirect callback fails, will be one of Auth0's +Authentication API's Standard Error Responses: https://auth0.com/docs/api/authentication?javascript#standard-error-responses

                                      +
                                      +
                                      +

                                      Hierarchy (View Summary)

                                      +
                                      +
                                      +
                                      +
                                      +
                                      Index
                                       +
                                      +
                                      + +
                                      constructor +
                                      +
                                      + +
                                      appState +error +error_description +message +name +originalStack? +stack? +state +zoneAwareStack? +
                                      +
                                      + +
                                      fromPayload +
                                      +
                                      + +
                                      +
                                      + +
                                        +
                                      • + +
                                        +
                                        +

                                        Parameters

                                        +
                                          +
                                        • error: string
                                          • +
                                        • error_description: string
                                          • +
                                        • state: string
                                          • +
                                        • OptionalappState: any
                                        +

                                        Returns AuthenticationError

                                      +
                                      + +
                                      +
                                      + +
                                      appState: any
                                      +
                                      + +
                                      error: string
                                      +
                                      + +
                                      error_description: string
                                      +
                                      + +
                                      message: string
                                      +
                                      + +
                                      name: string
                                      +
                                      + +
                                      originalStack?: string
                                      +

                                      Original stack trace with no modifications

                                      +
                                      +
                                      + +
                                      stack?: string
                                      +
                                      + +
                                      state: string
                                      +
                                      + +
                                      zoneAwareStack?: string
                                      +

                                      Stack trace where extra frames have been removed and zone names added.

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

                                        Parameters

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

                                        Returns GenericError

                                      +
                                      +
                                      +
                                      +
                                      +

                                      Settings

                                       +
                                      +
                                      Member Visibility +
                                        +
                                        • +
                                        • +
                                      +
                                      +
                                      +

                                      On This Page

                                       +
                                      +
                                      Constructors +
                                      +
                                      Properties +
                                      +
                                      Methods +
                                      +
                                      +
                                      +
                                      diff --git a/docs/classes/ConnectError.html b/docs/classes/ConnectError.html index 81e1c9e4..de23b239 100644 --- a/docs/classes/ConnectError.html +++ b/docs/classes/ConnectError.html @@ -1,1233 +1,178 @@ - - - - - - ConnectError | @auth0/auth0-angular - - - - - - - - - - - - -
                                      -
                                      - @auth0/auth0-angular - - - - -
                                        -
                                        -
                                        Preparing search index...
                                        -
                                        -                                         - -
                                        -
                                        -
                                        -
                                        -
                                        - -

                                        Class ConnectError

                                        -
                                        -
                                        -
                                        -

                                        - Thrown when handling the redirect callback for the connect flow - fails, will be one of Auth0's Authentication API's Standard Error - Responses: - https://auth0.com/docs/api/authentication?javascript#standard-error-responses -

                                        -
                                        -
                                        -
                                        -

                                        - Hierarchy (View Summary) -

                                        - -
                                        - -
                                        -
                                        -
                                        - - -
                                        Index
                                        -                                         -
                                        -
                                        - -
                                        - - constructor -
                                        -
                                        -
                                        - -
                                        - - appState - - connection - - error - - error_description - - message - - name - - originalStack? - - stack? - - state - - zoneAwareStack? -
                                        -
                                        -
                                        - -
                                        - - fromPayload -
                                        -
                                        -
                                        -
                                        -
                                        -
                                        -
                                        - - - - -
                                        -
                                        - -
                                          -
                                        • - -
                                          -
                                          -

                                          Parameters

                                          -
                                            -
                                          • - error: - string -
                                            • -
                                          • - error_description: - string -
                                            • -
                                          • - connection: - string -
                                            • -
                                          • - state: - string -
                                            • -
                                          • - OptionalappState: - any -
                                            • -
                                          -
                                          -

                                          - Returns - ConnectError -

                                          - -
                                          -
                                          • -
                                        -
                                        -
                                        -
                                        -
                                        - - - - -
                                        -
                                        - -
                                        - appState: - any -
                                        - -
                                        -
                                        - -
                                        - connection: - string -
                                        - -
                                        -
                                        - -
                                        - error: - string -
                                        - -
                                        -
                                        - -
                                        - error_description: - string -
                                        - -
                                        -
                                        - -
                                        - message: - string -
                                        - -
                                        -
                                        - -
                                        - name: - string -
                                        - -
                                        -
                                        - -
                                        - originalStack?: - string -
                                        -
                                        -

                                        Original stack trace with no modifications

                                        -
                                        - -
                                        -
                                        - -
                                        - stack?: - string -
                                        - -
                                        -
                                        - -
                                        - state: - string -
                                        - -
                                        -
                                        - -
                                        - zoneAwareStack?: - string -
                                        -
                                        -

                                        - Stack trace where extra frames have been removed and zone - names added. -

                                        -
                                        - -
                                        -
                                        -
                                        -
                                        - - - - -
                                        -
                                        - -
                                          -
                                        • - -
                                          -
                                          -

                                          Parameters

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

                                          - Returns - GenericError -

                                          - -
                                          -
                                          • -
                                        -
                                        -
                                        -
                                        -
                                        -
                                        -
                                        -
                                        -
                                        - - -

                                        Settings

                                        -                                         -
                                        -
                                        - Member Visibility -
                                          -
                                        • - -
                                          • -
                                        • - -
                                          • -
                                        • - -
                                          • -
                                        -
                                        -
                                        - -
                                        -
                                        -
                                        -
                                        -
                                        - - -

                                        On This Page

                                        -                                         -
                                        -
                                        - - Constructors - - -
                                        -
                                        - - Properties - - -
                                        -
                                        - - Methods - - -
                                        -
                                        -
                                        -
                                        -
                                        - -
                                        -
                                        -
                                        -
                                        -
                                        - - +ConnectError | @auth0/auth0-angular
                                        +
                                        @auth0/auth0-angular + +
                                          +
                                          +
                                          Preparing search index...
                                          +
                                          +
                                          +
                                          + +

                                          Class ConnectError

                                          +
                                          +

                                          Thrown when handling the redirect callback for the connect flow fails, will be one of Auth0's +Authentication API's Standard Error Responses: https://auth0.com/docs/api/authentication?javascript#standard-error-responses

                                          +
                                          +
                                          +

                                          Hierarchy (View Summary)

                                          +
                                          +
                                          +
                                          +
                                          +
                                          Index
                                           +
                                          +
                                          + +
                                          constructor +
                                          +
                                          + +
                                          appState +connection +error +error_description +message +name +originalStack? +stack? +state +zoneAwareStack? +
                                          +
                                          + +
                                          fromPayload +
                                          +
                                          + +
                                          +
                                          + +
                                            +
                                          • + +
                                            +
                                            +

                                            Parameters

                                            +
                                              +
                                            • error: string
                                              • +
                                            • error_description: string
                                              • +
                                            • connection: string
                                              • +
                                            • state: string
                                              • +
                                            • OptionalappState: any
                                            +

                                            Returns ConnectError

                                          +
                                          + +
                                          +
                                          + +
                                          appState: any
                                          +
                                          + +
                                          connection: string
                                          +
                                          + +
                                          error: string
                                          +
                                          + +
                                          error_description: string
                                          +
                                          + +
                                          message: string
                                          +
                                          + +
                                          name: string
                                          +
                                          + +
                                          originalStack?: string
                                          +

                                          Original stack trace with no modifications

                                          +
                                          +
                                          + +
                                          stack?: string
                                          +
                                          + +
                                          state: string
                                          +
                                          + +
                                          zoneAwareStack?: string
                                          +

                                          Stack trace where extra frames have been removed and zone names added.

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

                                            Parameters

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

                                            Returns GenericError

                                          +
                                          +
                                          +
                                          +
                                          +

                                          Settings

                                           +
                                          +
                                          Member Visibility +
                                            +
                                            • +
                                            • +
                                          +
                                          +
                                          +

                                          On This Page

                                           +
                                          +
                                          Constructors +
                                          +
                                          Properties +
                                          +
                                          Methods +
                                          +
                                          +
                                          +
                                          diff --git a/docs/classes/Fetcher.html b/docs/classes/Fetcher.html index 25d91779..95a4f7ad 100644 --- a/docs/classes/Fetcher.html +++ b/docs/classes/Fetcher.html @@ -1,2179 +1,293 @@ - - - - - - Fetcher | @auth0/auth0-angular - - - - - - - - - - - - -
                                          -
                                          - @auth0/auth0-angular - - - - -
                                            -
                                            -
                                            Preparing search index...
                                            -
                                            -                                             - -
                                            -
                                            -
                                            -
                                            -
                                            - -

                                            Class Fetcher<TOutput>

                                            -
                                            -
                                            -

                                            Type Parameters

                                            - -
                                            - -
                                            -
                                            -
                                            - - -
                                            Index
                                            -                                             -
                                            -
                                            - -
                                            - - constructor -
                                            -
                                            -
                                            - -
                                            - - config - - hooks -
                                            -
                                            -
                                            - -
                                            - - buildBaseRequest - - buildUrl - - extractUrl - - fetchWithAuth - - getAccessToken - - getHeader - - handleResponse - - hasUseDpopNonceError - - internalFetchWithAuth - - isAbsoluteUrl - - prepareRequest - - setAuthorizationHeader - - setDpopProofHeader -
                                            -
                                            -
                                            -
                                            -
                                            -
                                            -
                                            - - - - -
                                            -
                                            - - -
                                            -
                                            -
                                            -
                                            - - - - -
                                            -
                                            - -
                                            - config: - Omit<FetcherConfig<TOutput>, - "fetch"> - & - Required<
                                                Pick<FetcherConfig<TOutput>, - "fetch">,
                                            > -
                                            - -
                                            -
                                            - -
                                            - hooks: - FetcherHooks -
                                            - -
                                            -
                                            -
                                            -
                                            - - - - -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - info: - RequestInfo - | - URL -
                                                • -
                                              • - init: - RequestInit - | - undefined -
                                                • -
                                              -
                                              -

                                              - Returns Request -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - baseUrl: - string - | - undefined -
                                                • -
                                              • - url: - string - | - undefined -
                                                • -
                                              -
                                              -

                                              - Returns string -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - info: - RequestInfo - | - URL -
                                                • -
                                              -
                                              -

                                              - Returns string -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - info: - RequestInfo - | - URL -
                                                • -
                                              • - Optionalinit: - RequestInit -
                                                • -
                                              • - OptionalauthParams: - AuthParams -
                                                • -
                                              -
                                              -

                                              - Returns Promise<TOutput> -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - OptionalauthParams: - AuthParams -
                                                • -
                                              -
                                              -

                                              - Returns Promise<string - | - GetTokenSilentlyVerboseResponse - | - undefined> -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - headers: - ResponseHeaders -
                                                • -
                                              • - name: - string -
                                                • -
                                              -
                                              -

                                              - Returns string -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - response: - TOutput -
                                                • -
                                              • - callbacks: - FetchWithAuthCallbacks<TOutput> -
                                                • -
                                              -
                                              -

                                              - Returns Promise<TOutput> -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              - -
                                              -

                                              - Returns boolean -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - info: - RequestInfo - | - URL -
                                                • -
                                              • - init: - RequestInit - | - undefined -
                                                • -
                                              • - callbacks: - FetchWithAuthCallbacks<TOutput> -
                                                • -
                                              • - OptionalauthParams: - AuthParams -
                                                • -
                                              -
                                              -

                                              - Returns Promise<TOutput> -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - url: - string -
                                                • -
                                              -
                                              -

                                              - Returns boolean -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - request: - Request -
                                                • -
                                              • - OptionalauthParams: - AuthParams -
                                                • -
                                              -
                                              -

                                              - Returns Promise<void> -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - request: - Request -
                                                • -
                                              • - accessToken: - string -
                                                • -
                                              • - OptionaltokenType: - string -
                                                • -
                                              -
                                              -

                                              - Returns void -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - request: - Request -
                                                • -
                                              • - accessToken: - string -
                                                • -
                                              -
                                              -

                                              - Returns Promise<void> -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            -
                                            -
                                            -
                                            -
                                            -
                                            -
                                            - - -

                                            Settings

                                            -                                             -
                                            -
                                            - Member Visibility -
                                              -
                                            • - -
                                              • -
                                            • - -
                                              • -
                                            • - -
                                              • -
                                            -
                                            -
                                            - -
                                            -
                                            -
                                            -
                                            -
                                            - - -

                                            On This Page

                                            -                                             -
                                            -
                                            - - Constructors - - -
                                            -
                                            - - Properties - - -
                                            -
                                            - - Methods - - -
                                            -
                                            -
                                            -
                                            -
                                            - -
                                            -
                                            -
                                            -
                                            -
                                            - - +Fetcher | @auth0/auth0-angular
                                            +
                                            @auth0/auth0-angular + +
                                              +
                                              +
                                              Preparing search index...
                                              +
                                              +
                                              +
                                              + +

                                              Class Fetcher<TOutput>

                                              +
                                              +

                                              Type Parameters

                                              +
                                              +
                                              +
                                              +
                                              +
                                              Index
                                               +
                                              +
                                              + +
                                              constructor +
                                              +
                                              + +
                                              config +hooks +
                                              +
                                              + +
                                              buildBaseRequest +buildUrl +extractUrl +fetchWithAuth +getAccessToken +getHeader +handleResponse +hasUseDpopNonceError +internalFetchWithAuth +isAbsoluteUrl +prepareRequest +setAuthorizationHeader +setDpopProofHeader +
                                              +
                                              + +
                                              +
                                              + +
                                              +
                                              + +
                                              +
                                              + +
                                              config: Omit<FetcherConfig<TOutput>, "fetch"> & Required<
                                                  Pick<FetcherConfig<TOutput>, "fetch">,
                                              >
                                              +
                                              + +
                                              hooks: FetcherHooks
                                              +
                                              + +
                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • info: RequestInfo | URL
                                                  • +
                                                • init: RequestInit | undefined
                                                +

                                                Returns Request

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • baseUrl: string | undefined
                                                  • +
                                                • url: string | undefined
                                                +

                                                Returns string

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • info: RequestInfo | URL
                                                +

                                                Returns string

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • info: RequestInfo | URL
                                                  • +
                                                • Optionalinit: RequestInit
                                                  • +
                                                • OptionalauthParams: AuthParams
                                                +

                                                Returns Promise<TOutput>

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • OptionalauthParams: AuthParams
                                                +

                                                Returns Promise<string | GetTokenSilentlyVerboseResponse | undefined>

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • headers: ResponseHeaders
                                                  • +
                                                • name: string
                                                +

                                                Returns string

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                +

                                                Returns Promise<TOutput>

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                +

                                                Returns boolean

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • info: RequestInfo | URL
                                                  • +
                                                • init: RequestInit | undefined
                                                  • +
                                                • callbacks: FetchWithAuthCallbacks<TOutput>
                                                  • +
                                                • OptionalauthParams: AuthParams
                                                +

                                                Returns Promise<TOutput>

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • url: string
                                                +

                                                Returns boolean

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • request: Request
                                                  • +
                                                • OptionalauthParams: AuthParams
                                                +

                                                Returns Promise<void>

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • request: Request
                                                  • +
                                                • accessToken: string
                                                  • +
                                                • OptionaltokenType: string
                                                +

                                                Returns void

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • request: Request
                                                  • +
                                                • accessToken: string
                                                +

                                                Returns Promise<void>

                                              +
                                              +
                                              +
                                              +
                                              +

                                              Settings

                                               +
                                              +
                                              Member Visibility +
                                                +
                                                • +
                                                • +
                                              +
                                              +
                                              +

                                              On This Page

                                               +
                                              +
                                              Constructors +
                                              +
                                              Properties +
                                              +
                                              Methods +
                                              +
                                              +
                                              +
                                              diff --git a/docs/classes/GenericError.html b/docs/classes/GenericError.html index c702d5b6..2dbaefa9 100644 --- a/docs/classes/GenericError.html +++ b/docs/classes/GenericError.html @@ -1,1073 +1,165 @@ - - - - - - GenericError | @auth0/auth0-angular - - - - - - - - - - - - -
                                              -
                                              - @auth0/auth0-angular - - - - -
                                                -
                                                -
                                                Preparing search index...
                                                -
                                                -                                                 - -
                                                -
                                                -
                                                -
                                                -
                                                - -

                                                Class GenericError

                                                -
                                                -
                                                -
                                                -

                                                Thrown when network requests to the Auth server fail.

                                                -
                                                -
                                                -
                                                -

                                                - Hierarchy (View Summary) -

                                                - -
                                                - -
                                                -
                                                -
                                                - - -
                                                Index
                                                -                                                 -
                                                -
                                                - -
                                                - - constructor -
                                                -
                                                -
                                                - -
                                                - - error - - error_description - - message - - name - - originalStack? - - stack? - - zoneAwareStack? -
                                                -
                                                -
                                                - -
                                                - - fromPayload -
                                                -
                                                -
                                                -
                                                -
                                                -
                                                -
                                                - - - - -
                                                -
                                                - -
                                                  -
                                                • - -
                                                  -
                                                  -

                                                  Parameters

                                                  -
                                                    -
                                                  • - error: - string -
                                                    • -
                                                  • - error_description: - string -
                                                    • -
                                                  -
                                                  -

                                                  - Returns - GenericError -

                                                  - -
                                                  -
                                                  • -
                                                -
                                                -
                                                -
                                                -
                                                - - - - -
                                                -
                                                - -
                                                - error: - string -
                                                - -
                                                -
                                                - -
                                                - error_description: - string -
                                                - -
                                                -
                                                - -
                                                - message: - string -
                                                - -
                                                -
                                                - -
                                                - name: - string -
                                                - -
                                                -
                                                - -
                                                - originalStack?: - string -
                                                -
                                                -

                                                Original stack trace with no modifications

                                                -
                                                - -
                                                -
                                                - -
                                                - stack?: - string -
                                                - -
                                                -
                                                - -
                                                - zoneAwareStack?: - string -
                                                -
                                                -

                                                - Stack trace where extra frames have been removed and zone - names added. -

                                                -
                                                - -
                                                -
                                                -
                                                -
                                                - - - - -
                                                -
                                                - -
                                                  -
                                                • - -
                                                  -
                                                  -

                                                  Parameters

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

                                                  - Returns - GenericError -

                                                  - -
                                                  -
                                                  • -
                                                -
                                                -
                                                -
                                                -
                                                -
                                                -
                                                -
                                                -
                                                - - -

                                                Settings

                                                -                                                 -
                                                -
                                                - Member Visibility -
                                                  -
                                                • - -
                                                  • -
                                                • - -
                                                  • -
                                                • - -
                                                  • -
                                                -
                                                -
                                                - -
                                                -
                                                -
                                                -
                                                -
                                                - - -

                                                On This Page

                                                -                                                 -
                                                -
                                                - - Constructors - - -
                                                -
                                                - - Properties - - -
                                                -
                                                - - Methods - - -
                                                -
                                                -
                                                -
                                                -
                                                - -
                                                -
                                                -
                                                -
                                                -
                                                - - +GenericError | @auth0/auth0-angular
                                                +
                                                @auth0/auth0-angular + +
                                                  +
                                                  +
                                                  Preparing search index...
                                                  +
                                                  +
                                                  +
                                                  + +

                                                  Class GenericError

                                                  +
                                                  +

                                                  Thrown when network requests to the Auth server fail.

                                                  +
                                                  +
                                                  +

                                                  Hierarchy (View Summary)

                                                  +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  Index
                                                   +
                                                  +
                                                  + +
                                                  constructor +
                                                  +
                                                  + +
                                                  error +error_description +message +name +originalStack? +stack? +zoneAwareStack? +
                                                  +
                                                  + +
                                                  fromPayload +
                                                  +
                                                  + +
                                                  +
                                                  + +
                                                    +
                                                  • + +
                                                    +
                                                    +

                                                    Parameters

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

                                                    Returns GenericError

                                                  +
                                                  + +
                                                  +
                                                  + +
                                                  error: string
                                                  +
                                                  + +
                                                  error_description: string
                                                  +
                                                  + +
                                                  message: string
                                                  +
                                                  + +
                                                  name: string
                                                  +
                                                  + +
                                                  originalStack?: string
                                                  +

                                                  Original stack trace with no modifications

                                                  +
                                                  +
                                                  + +
                                                  stack?: string
                                                  +
                                                  + +
                                                  zoneAwareStack?: string
                                                  +

                                                  Stack trace where extra frames have been removed and zone names added.

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

                                                    Parameters

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

                                                    Returns GenericError

                                                  +
                                                  +
                                                  +
                                                  +
                                                  +

                                                  Settings

                                                   +
                                                  +
                                                  Member Visibility +
                                                    +
                                                    • +
                                                    • +
                                                  +
                                                  +
                                                  +

                                                  On This Page

                                                   +
                                                  +
                                                  Constructors +
                                                  +
                                                  Properties +
                                                  +
                                                  Methods +
                                                  +
                                                  +
                                                  +
                                                  diff --git a/docs/classes/InvalidConfigurationError.html b/docs/classes/InvalidConfigurationError.html index d1763071..508992e2 100644 --- a/docs/classes/InvalidConfigurationError.html +++ b/docs/classes/InvalidConfigurationError.html @@ -1,1118 +1,163 @@ - - - - - - InvalidConfigurationError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                  -
                                                  - @auth0/auth0-angular - - - - -
                                                    -
                                                    -
                                                    Preparing search index...
                                                    -
                                                    -                                                     - -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - -

                                                    Class InvalidConfigurationError

                                                    -
                                                    -
                                                    -
                                                    -

                                                    - Thrown at construction time for an invalid option combination - (e.g. refreshTokenMode: 'online' without - useDpop: true). The suggestion names the - fix. -

                                                    -
                                                    -
                                                    -
                                                    -

                                                    - Hierarchy (View Summary) -

                                                    - -
                                                    - -
                                                    -
                                                    -
                                                    - - -
                                                    Index
                                                    -                                                     -
                                                    -
                                                    - -
                                                    - - constructor -
                                                    -
                                                    -
                                                    - -
                                                    - - error - - error_description - - message - - name - - originalStack? - - stack? - - suggestion - - zoneAwareStack? -
                                                    -
                                                    -
                                                    - -
                                                    - - fromPayload -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - - - - -
                                                    -
                                                    - -
                                                      -
                                                    • - -
                                                      -
                                                      -

                                                      Parameters

                                                      -
                                                        -
                                                      • - message: - string -
                                                        • -
                                                      • - suggestion: - string -
                                                        • -
                                                      -
                                                      -

                                                      - Returns - InvalidConfigurationError -

                                                      - -
                                                      -
                                                      • -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - - - - -
                                                    -
                                                    - -
                                                    - error: - string -
                                                    - -
                                                    -
                                                    - -
                                                    - error_description: - string -
                                                    - -
                                                    -
                                                    - -
                                                    - message: - string -
                                                    - -
                                                    -
                                                    - -
                                                    - name: - string -
                                                    - -
                                                    -
                                                    - -
                                                    - originalStack?: - string -
                                                    -
                                                    -

                                                    Original stack trace with no modifications

                                                    -
                                                    - -
                                                    -
                                                    - -
                                                    - stack?: - string -
                                                    - -
                                                    -
                                                    - -
                                                    - suggestion: - string -
                                                    - -
                                                    -
                                                    - -
                                                    - zoneAwareStack?: - string -
                                                    -
                                                    -

                                                    - Stack trace where extra frames have been removed and zone - names added. -

                                                    -
                                                    - -
                                                    -
                                                    -
                                                    -
                                                    - - - - -
                                                    -
                                                    - -
                                                      -
                                                    • - -
                                                      -
                                                      -

                                                      Parameters

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

                                                      - Returns - GenericError -

                                                      - -
                                                      -
                                                      • -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - - -

                                                    Settings

                                                    -                                                     -
                                                    -
                                                    - Member Visibility -
                                                      -
                                                    • - -
                                                      • -
                                                    • - -
                                                      • -
                                                    • - -
                                                      • -
                                                    -
                                                    -
                                                    - -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - - -

                                                    On This Page

                                                    -                                                     -
                                                    -
                                                    - - Constructors - - -
                                                    -
                                                    - - Properties - - -
                                                    -
                                                    - - Methods - - -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - - +InvalidConfigurationError | @auth0/auth0-angular
                                                    +
                                                    @auth0/auth0-angular + +
                                                      +
                                                      +
                                                      Preparing search index...
                                                      +
                                                      +
                                                      +
                                                      + +

                                                      Class InvalidConfigurationError

                                                      +
                                                      +

                                                      Thrown at construction time for an invalid option combination (e.g. +refreshTokenMode: 'online' without useDpop: true). The suggestion names the fix.

                                                      +
                                                      +
                                                      +

                                                      Hierarchy (View Summary)

                                                      +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      Index
                                                       +
                                                      +
                                                      + +
                                                      constructor +
                                                      +
                                                      + +
                                                      error +error_description +message +name +originalStack? +stack? +suggestion +zoneAwareStack? +
                                                      +
                                                      + +
                                                      fromPayload +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                      error: string
                                                      +
                                                      + +
                                                      error_description: string
                                                      +
                                                      + +
                                                      message: string
                                                      +
                                                      + +
                                                      name: string
                                                      +
                                                      + +
                                                      originalStack?: string
                                                      +

                                                      Original stack trace with no modifications

                                                      +
                                                      +
                                                      + +
                                                      stack?: string
                                                      +
                                                      + +
                                                      suggestion: string
                                                      +
                                                      + +
                                                      zoneAwareStack?: string
                                                      +

                                                      Stack trace where extra frames have been removed and zone names added.

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

                                                        Parameters

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

                                                        Returns GenericError

                                                      +
                                                      +
                                                      +
                                                      +
                                                      +

                                                      Settings

                                                       +
                                                      +
                                                      Member Visibility +
                                                        +
                                                        • +
                                                        • +
                                                      +
                                                      +
                                                      +

                                                      On This Page

                                                       +
                                                      +
                                                      Constructors +
                                                      +
                                                      Properties +
                                                      +
                                                      Methods +
                                                      +
                                                      +
                                                      +
                                                      diff --git a/docs/classes/MfaChallengeError.html b/docs/classes/MfaChallengeError.html index 7c2b14ae..0f82c564 100644 --- a/docs/classes/MfaChallengeError.html +++ b/docs/classes/MfaChallengeError.html @@ -1,1080 +1,162 @@ - - - - - - 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'
                                                          }
                                                        }
+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
                                                          
-                                                                        
-              
                                                          
-                
                                                          
-                  
-                  
                                                          
-                    
-                        constructor
-                  
                                                          
-                
                                                          
-                
                                                          
-                  
-                  
                                                          
-                    
-                        error
-                    
-                        error_description
-                    
-                        message
-                    
-                        name
-                    
-                        originalStack?
-                    
-                        stack?
-                    
-                        zoneAwareStack?
-                  
                                                          
-                
                                                          
-                
                                                          
-                  
-                  
                                                          
-                    
-                        fromPayload
-                  
                                                          
-                
                                                          
-              
                                                          
-            
                                                          
-          
                                                          
-        
                                                          
-        
                                                          
-          
-            
-            
-          
-          
                                                          
-            
                                                          
-              
-              
                                                            
-                
                                                          • 
-                  
-                  
                                                            
-                    
                                                            
-                      
                                                            Parameters
                                                            
-                      
                                                              
-                        
                                                            • 
-                          error:
-                            string
-                        
                                                              • 
-                        
                                                            • 
-                          error_description:
-                            string
-                        
                                                              • 
-                      
                                                            
-                    
                                                            
-                    
                                                            
-                      Returns
-                      MfaChallengeError
-                    
                                                            
-                    
-                  
                                                            
-                
                                                            • 
-              
                                                          
-            
                                                          
-          
                                                          
-        
                                                          
-        
                                                          
-          
-            
-            
-          
-          
                                                          
-            
                                                          
-              
-              
                                                          
-                error:
-                string
-              
                                                          
-              
-            
                                                          
-            
                                                          
-              
-              
                                                          
-                error_description:
-                string
-              
                                                          
-              
-            
                                                          
-            
                                                          
-              
-              
                                                          
-                message:
-                string
-              
                                                          
-              
-            
                                                          
-            
                                                          
-              
-              
                                                          
-                name:
-                string
-              
                                                          
-              
-            
                                                          
-            
                                                          
-              
-              
                                                          
-                originalStack?:
-                string
-              
                                                          
-              
                                                          
-                
                                                          Original stack trace with no modifications
                                                          
-              
                                                          
-              
-            
                                                          
-            
                                                          
-              
-              
                                                          
-                stack?:
-                string
-              
                                                          
-              
-            
                                                          
-            
                                                          
-              
-              
                                                          
-                zoneAwareStack?:
-                string
-              
                                                          
-              
                                                          
-                
                                                          
-                  Stack trace where extra frames have been removed and zone
-                  names added.
-                
                                                          
-              
                                                          
-              
-            
                                                          
-          
                                                          
-        
                                                          
-        
                                                          
-          
-            
-            
-          
-          
                                                          
-            
                                                          
-              
-              
                                                            
-                
                                                          • 
-                  
-                  
                                                            
-                    
                                                            
-                      
                                                            Parameters
                                                            
-                      
                                                              
-                        
                                                            • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                              • 
-                      
                                                            
-                    
                                                            
-                    
                                                            
-                      Returns
-                      MfaError
-                    
                                                            
-                    
-                  
                                                            
-                
                                                            • 
-              
                                                          
-            
                                                          
-          
                                                          
-        
                                                          
-      
                                                          
-      
                                                          
-        
                                                          
-          
                                                          
-            
                                                          
-              
-                
-                
                                                          Settings
                                                          
-                                                                        
-              
                                                          
-                
                                                          
-                  Member Visibility
-                  
                                                            
-                    
                                                          • 
-                      
-                    
                                                            • 
-                    
                                                          • 
-                      
-                    
                                                            • 
-                    
                                                          • 
-                      
-                    
                                                            • 
-                  
                                                          
-                
                                                          
-                
                                                          
-                  
-                
                                                          
-              
                                                          
-            
                                                          
-          
                                                          
-          
                                                          
-            
-              
-              
                                                          On This Page
                                                          
-                                                                      
-            
                                                          
-              
                                                          
-                
-                  Constructors
-                
-                
-              
                                                          
-              
                                                          
-                
-                  Properties
-                
-                
-              
                                                          
-              
                                                          
-                
-                  Methods
-                
-                
-              
                                                          
-            
                                                          
-          
                                                          
-        
                                                          
-        
                                                          
-          
-        
                                                          
-      
                                                          
-    
                                                          
-    
                                                          
-    
                                                          
-  
-
+
+
                                                          +
                                                          +

                                                          Hierarchy (View Summary)

                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          Index
                                                           +
                                                          +
                                                          + +
                                                          constructor +
                                                          +
                                                          + +
                                                          error +error_description +message +name +originalStack? +stack? +zoneAwareStack? +
                                                          +
                                                          + +
                                                          fromPayload +
                                                          +
                                                          + +
                                                          +
                                                          + +
                                                            +
                                                          • + +
                                                            +
                                                            +

                                                            Parameters

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

                                                            Returns MfaChallengeError

                                                          +
                                                          + +
                                                          +
                                                          + +
                                                          error: string
                                                          +
                                                          + +
                                                          error_description: string
                                                          +
                                                          + +
                                                          message: string
                                                          +
                                                          + +
                                                          name: string
                                                          +
                                                          + +
                                                          originalStack?: string
                                                          +

                                                          Original stack trace with no modifications

                                                          +
                                                          +
                                                          + +
                                                          stack?: string
                                                          +
                                                          + +
                                                          zoneAwareStack?: string
                                                          +

                                                          Stack trace where extra frames have been removed and zone names added.

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

                                                            Parameters

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

                                                            Returns MfaError

                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Settings

                                                           +
                                                          +
                                                          Member Visibility +
                                                            +
                                                            • +
                                                            • +
                                                          +
                                                          +
                                                          +

                                                          On This Page

                                                           +
                                                          +
                                                          Constructors +
                                                          +
                                                          Properties +
                                                          +
                                                          Methods +
                                                          +
                                                          +
                                                          +
                                                          diff --git a/docs/classes/MfaEnrollmentError.html b/docs/classes/MfaEnrollmentError.html index a8622010..bde9b799 100644 --- a/docs/classes/MfaEnrollmentError.html +++ b/docs/classes/MfaEnrollmentError.html @@ -1,1080 +1,162 @@ - - - - - - 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'
                                                              }
                                                            }
+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
                                                              
-                                                                            
-              
                                                              
-                
                                                              
-                  
-                  
                                                              
-                    
-                        constructor
-                  
                                                              
-                
                                                              
-                
                                                              
-                  
-                  
                                                              
-                    
-                        error
-                    
-                        error_description
-                    
-                        message
-                    
-                        name
-                    
-                        originalStack?
-                    
-                        stack?
-                    
-                        zoneAwareStack?
-                  
                                                              
-                
                                                              
-                
                                                              
-                  
-                  
                                                              
-                    
-                        fromPayload
-                  
                                                              
-                
                                                              
-              
                                                              
-            
                                                              
-          
                                                              
-        
                                                              
-        
                                                              
-          
-            
-            
-          
-          
                                                              
-            
                                                              
-              
-              
                                                                
-                
                                                              • 
-                  
-                  
                                                                
-                    
                                                                
-                      
                                                                Parameters
                                                                
-                      
                                                                  
-                        
                                                                • 
-                          error:
-                            string
-                        
                                                                  • 
-                        
                                                                • 
-                          error_description:
-                            string
-                        
                                                                  • 
-                      
                                                                
-                    
                                                                
-                    
                                                                
-                      Returns
-                      MfaEnrollmentError
-                    
                                                                
-                    
-                  
                                                                
-                
                                                                • 
-              
                                                              
-            
                                                              
-          
                                                              
-        
                                                              
-        
                                                              
-          
-            
-            
-          
-          
                                                              
-            
                                                              
-              
-              
                                                              
-                error:
-                string
-              
                                                              
-              
-            
                                                              
-            
                                                              
-              
-              
                                                              
-                error_description:
-                string
-              
                                                              
-              
-            
                                                              
-            
                                                              
-              
-              
                                                              
-                message:
-                string
-              
                                                              
-              
-            
                                                              
-            
                                                              
-              
-              
                                                              
-                name:
-                string
-              
                                                              
-              
-            
                                                              
-            
                                                              
-              
-              
                                                              
-                originalStack?:
-                string
-              
                                                              
-              
                                                              
-                
                                                              Original stack trace with no modifications
                                                              
-              
                                                              
-              
-            
                                                              
-            
                                                              
-              
-              
                                                              
-                stack?:
-                string
-              
                                                              
-              
-            
                                                              
-            
                                                              
-              
-              
                                                              
-                zoneAwareStack?:
-                string
-              
                                                              
-              
                                                              
-                
                                                              
-                  Stack trace where extra frames have been removed and zone
-                  names added.
-                
                                                              
-              
                                                              
-              
-            
                                                              
-          
                                                              
-        
                                                              
-        
                                                              
-          
-            
-            
-          
-          
                                                              
-            
                                                              
-              
-              
                                                                
-                
                                                              • 
-                  
-                  
                                                                
-                    
                                                                
-                      
                                                                Parameters
                                                                
-                      
                                                                  
-                        
                                                                • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                  • 
-                      
                                                                
-                    
                                                                
-                    
                                                                
-                      Returns
-                      MfaError
-                    
                                                                
-                    
-                  
                                                                
-                
                                                                • 
-              
                                                              
-            
                                                              
-          
                                                              
-        
                                                              
-      
                                                              
-      
                                                              
-        
                                                              
-          
                                                              
-            
                                                              
-              
-                
-                
                                                              Settings
                                                              
-                                                                            
-              
                                                              
-                
                                                              
-                  Member Visibility
-                  
                                                                
-                    
                                                              • 
-                      
-                    
                                                                • 
-                    
                                                              • 
-                      
-                    
                                                                • 
-                    
                                                              • 
-                      
-                    
                                                                • 
-                  
                                                              
-                
                                                              
-                
                                                              
-                  
-                
                                                              
-              
                                                              
-            
                                                              
-          
                                                              
-          
                                                              
-            
-              
-              
                                                              On This Page
                                                              
-                                                                          
-            
                                                              
-              
                                                              
-                
-                  Constructors
-                
-                
-              
                                                              
-              
                                                              
-                
-                  Properties
-                
-                
-              
                                                              
-              
                                                              
-                
-                  Methods
-                
-                
-              
                                                              
-            
                                                              
-          
                                                              
-        
                                                              
-        
                                                              
-          
-        
                                                              
-      
                                                              
-    
                                                              
-    
                                                              
-    
                                                              
-  
-
+
+
                                                              +
                                                              +

                                                              Hierarchy (View Summary)

                                                              +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              Index
                                                               +
                                                              +
                                                              + +
                                                              constructor +
                                                              +
                                                              + +
                                                              error +error_description +message +name +originalStack? +stack? +zoneAwareStack? +
                                                              +
                                                              + +
                                                              fromPayload +
                                                              +
                                                              + +
                                                              +
                                                              + +
                                                                +
                                                              • + +
                                                                +
                                                                +

                                                                Parameters

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

                                                                Returns MfaEnrollmentError

                                                              +
                                                              + +
                                                              +
                                                              + +
                                                              error: string
                                                              +
                                                              + +
                                                              error_description: string
                                                              +
                                                              + +
                                                              message: string
                                                              +
                                                              + +
                                                              name: string
                                                              +
                                                              + +
                                                              originalStack?: string
                                                              +

                                                              Original stack trace with no modifications

                                                              +
                                                              +
                                                              + +
                                                              stack?: string
                                                              +
                                                              + +
                                                              zoneAwareStack?: string
                                                              +

                                                              Stack trace where extra frames have been removed and zone names added.

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

                                                                Parameters

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

                                                                Returns MfaError

                                                              +
                                                              +
                                                              +
                                                              +
                                                              +

                                                              Settings

                                                               +
                                                              +
                                                              Member Visibility +
                                                                +
                                                                • +
                                                                • +
                                                              +
                                                              +
                                                              +

                                                              On This Page

                                                               +
                                                              +
                                                              Constructors +
                                                              +
                                                              Properties +
                                                              +
                                                              Methods +
                                                              +
                                                              +
                                                              +
                                                              diff --git a/docs/classes/MfaEnrollmentFactorsError.html b/docs/classes/MfaEnrollmentFactorsError.html index 25dbbb84..a9f0e452 100644 --- a/docs/classes/MfaEnrollmentFactorsError.html +++ b/docs/classes/MfaEnrollmentFactorsError.html @@ -1,1084 +1,162 @@ - - - - - - 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...'
                                                                  }
                                                                }
+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
                                                                  
-                                                                                
-              
                                                                  
-                
                                                                  
-                  
-                  
                                                                  
-                    
-                        constructor
-                  
                                                                  
-                
                                                                  
-                
                                                                  
-                  
-                  
                                                                  
-                    
-                        error
-                    
-                        error_description
-                    
-                        message
-                    
-                        name
-                    
-                        originalStack?
-                    
-                        stack?
-                    
-                        zoneAwareStack?
-                  
                                                                  
-                
                                                                  
-                
                                                                  
-                  
-                  
                                                                  
-                    
-                        fromPayload
-                  
                                                                  
-                
                                                                  
-              
                                                                  
-            
                                                                  
-          
                                                                  
-        
                                                                  
-        
                                                                  
-          
-            
-            
-          
-          
                                                                  
-            
                                                                  
-              
-              
                                                                    
-                
                                                                  • 
-                  
-                  
                                                                    
-                    
                                                                    
-                      
                                                                    Parameters
                                                                    
-                      
                                                                      
-                        
                                                                    • 
-                          error:
-                            string
-                        
                                                                      • 
-                        
                                                                    • 
-                          error_description:
-                            string
-                        
                                                                      • 
-                      
                                                                    
-                    
                                                                    
-                    
                                                                    
-                      Returns
-                      MfaEnrollmentFactorsError
-                    
                                                                    
-                    
-                  
                                                                    
-                
                                                                    • 
-              
                                                                  
-            
                                                                  
-          
                                                                  
-        
                                                                  
-        
                                                                  
-          
-            
-            
-          
-          
                                                                  
-            
                                                                  
-              
-              
                                                                  
-                error:
-                string
-              
                                                                  
-              
-            
                                                                  
-            
                                                                  
-              
-              
                                                                  
-                error_description:
-                string
-              
                                                                  
-              
-            
                                                                  
-            
                                                                  
-              
-              
                                                                  
-                message:
-                string
-              
                                                                  
-              
-            
                                                                  
-            
                                                                  
-              
-              
                                                                  
-                name:
-                string
-              
                                                                  
-              
-            
                                                                  
-            
                                                                  
-              
-              
                                                                  
-                originalStack?:
-                string
-              
                                                                  
-              
                                                                  
-                
                                                                  Original stack trace with no modifications
                                                                  
-              
                                                                  
-              
-            
                                                                  
-            
                                                                  
-              
-              
                                                                  
-                stack?:
-                string
-              
                                                                  
-              
-            
                                                                  
-            
                                                                  
-              
-              
                                                                  
-                zoneAwareStack?:
-                string
-              
                                                                  
-              
                                                                  
-                
                                                                  
-                  Stack trace where extra frames have been removed and zone
-                  names added.
-                
                                                                  
-              
                                                                  
-              
-            
                                                                  
-          
                                                                  
-        
                                                                  
-        
                                                                  
-          
-            
-            
-          
-          
                                                                  
-            
                                                                  
-              
-              
                                                                    
-                
                                                                  • 
-                  
-                  
                                                                    
-                    
                                                                    
-                      
                                                                    Parameters
                                                                    
-                      
                                                                      
-                        
                                                                    • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                      • 
-                      
                                                                    
-                    
                                                                    
-                    
                                                                    
-                      Returns
-                      MfaError
-                    
                                                                    
-                    
-                  
                                                                    
-                
                                                                    • 
-              
                                                                  
-            
                                                                  
-          
                                                                  
-        
                                                                  
-      
                                                                  
-      
                                                                  
-        
                                                                  
-          
                                                                  
-            
                                                                  
-              
-                
-                
                                                                  Settings
                                                                  
-                                                                                
-              
                                                                  
-                
                                                                  
-                  Member Visibility
-                  
                                                                    
-                    
                                                                  • 
-                      
-                    
                                                                    • 
-                    
                                                                  • 
-                      
-                    
                                                                    • 
-                    
                                                                  • 
-                      
-                    
                                                                    • 
-                  
                                                                  
-                
                                                                  
-                
                                                                  
-                  
-                
                                                                  
-              
                                                                  
-            
                                                                  
-          
                                                                  
-          
                                                                  
-            
-              
-              
                                                                  On This Page
                                                                  
-                                                                              
-            
                                                                  
-              
                                                                  
-                
-                  Constructors
-                
-                
-              
                                                                  
-              
                                                                  
-                
-                  Properties
-                
-                
-              
                                                                  
-              
                                                                  
-                
-                  Methods
-                
-                
-              
                                                                  
-            
                                                                  
-          
                                                                  
-        
                                                                  
-        
                                                                  
-          
-        
                                                                  
-      
                                                                  
-    
                                                                  
-    
                                                                  
-    
                                                                  
-  
-
+
+
                                                                  +
                                                                  +

                                                                  Hierarchy (View Summary)

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  Index
                                                                   +
                                                                  +
                                                                  + +
                                                                  constructor +
                                                                  +
                                                                  + +
                                                                  error +error_description +message +name +originalStack? +stack? +zoneAwareStack? +
                                                                  +
                                                                  + +
                                                                  fromPayload +
                                                                  +
                                                                  + +
                                                                  +
                                                                  + +
                                                                  +
                                                                  + +
                                                                  +
                                                                  + +
                                                                  error: string
                                                                  +
                                                                  + +
                                                                  error_description: string
                                                                  +
                                                                  + +
                                                                  message: string
                                                                  +
                                                                  + +
                                                                  name: string
                                                                  +
                                                                  + +
                                                                  originalStack?: string
                                                                  +

                                                                  Original stack trace with no modifications

                                                                  +
                                                                  +
                                                                  + +
                                                                  stack?: string
                                                                  +
                                                                  + +
                                                                  zoneAwareStack?: string
                                                                  +

                                                                  Stack trace where extra frames have been removed and zone names added.

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

                                                                    Parameters

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

                                                                    Returns MfaError

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Settings

                                                                   +
                                                                  +
                                                                  Member Visibility +
                                                                    +
                                                                    • +
                                                                    • +
                                                                  +
                                                                  +
                                                                  +

                                                                  On This Page

                                                                   +
                                                                  +
                                                                  Constructors +
                                                                  +
                                                                  Properties +
                                                                  +
                                                                  Methods +
                                                                  +
                                                                  +
                                                                  +
                                                                  diff --git a/docs/classes/MfaError.html b/docs/classes/MfaError.html index fab085de..c445ca9a 100644 --- a/docs/classes/MfaError.html +++ b/docs/classes/MfaError.html @@ -1,1094 +1,163 @@ - - - - - - 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
                                                                    -                                                                     -
                                                                    -
                                                                    - -
                                                                    - - constructor -
                                                                    -
                                                                    -
                                                                    - -
                                                                    - - error - - error_description - - message - - name - - originalStack? - - stack? - - zoneAwareStack? -
                                                                    -
                                                                    -
                                                                    - -
                                                                    - - fromPayload -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    - - - - -
                                                                    -
                                                                    - -
                                                                      -
                                                                    • - -
                                                                      -
                                                                      -

                                                                      Parameters

                                                                      -
                                                                        -
                                                                      • - error: - string -
                                                                        • -
                                                                      • - error_description: - string -
                                                                        • -
                                                                      -
                                                                      -

                                                                      - Returns - MfaError -

                                                                      - -
                                                                      -
                                                                      • -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    - - - - -
                                                                    -
                                                                    - -
                                                                    - error: - string -
                                                                    - -
                                                                    -
                                                                    - -
                                                                    - error_description: - string -
                                                                    - -
                                                                    -
                                                                    - -
                                                                    - message: - string -
                                                                    - -
                                                                    -
                                                                    - -
                                                                    - name: - string -
                                                                    - -
                                                                    -
                                                                    - -
                                                                    - originalStack?: - string -
                                                                    -
                                                                    -

                                                                    Original stack trace with no modifications

                                                                    -
                                                                    - -
                                                                    -
                                                                    - -
                                                                    - stack?: - string -
                                                                    - -
                                                                    -
                                                                    - -
                                                                    - zoneAwareStack?: - string -
                                                                    -
                                                                    -

                                                                    - Stack trace where extra frames have been removed and zone - names added. -

                                                                    -
                                                                    - -
                                                                    -
                                                                    -
                                                                    -
                                                                    - - - - -
                                                                    -
                                                                    - -
                                                                      -
                                                                    • - -
                                                                      -
                                                                      -

                                                                      Parameters

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

                                                                      - Returns - MfaError -

                                                                      - -
                                                                      -
                                                                      • -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    - - -

                                                                    Settings

                                                                    -                                                                     -
                                                                    -
                                                                    - Member Visibility -
                                                                      -
                                                                    • - -
                                                                      • -
                                                                    • - -
                                                                      • -
                                                                    • - -
                                                                      • -
                                                                    -
                                                                    -
                                                                    - -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    - - -

                                                                    On This Page

                                                                    -                                                                     -
                                                                    -
                                                                    - - Constructors - - -
                                                                    -
                                                                    - - Properties - - -
                                                                    -
                                                                    - - Methods - - -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    - -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    - - +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
                                                                       +
                                                                      +
                                                                      + +
                                                                      constructor +
                                                                      +
                                                                      + +
                                                                      error +error_description +message +name +originalStack? +stack? +zoneAwareStack? +
                                                                      +
                                                                      + +
                                                                      fromPayload +
                                                                      +
                                                                      + +
                                                                      +
                                                                      + +
                                                                        +
                                                                      • + +
                                                                        +
                                                                        +

                                                                        Parameters

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

                                                                        Returns MfaError

                                                                      +
                                                                      + +
                                                                      +
                                                                      + +
                                                                      error: string
                                                                      +
                                                                      + +
                                                                      error_description: string
                                                                      +
                                                                      + +
                                                                      message: string
                                                                      +
                                                                      + +
                                                                      name: string
                                                                      +
                                                                      + +
                                                                      originalStack?: string
                                                                      +

                                                                      Original stack trace with no modifications

                                                                      +
                                                                      +
                                                                      + +
                                                                      stack?: string
                                                                      +
                                                                      + +
                                                                      zoneAwareStack?: string
                                                                      +

                                                                      Stack trace where extra frames have been removed and zone names added.

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

                                                                        Parameters

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

                                                                        Returns MfaError

                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Settings

                                                                       +
                                                                      +
                                                                      Member Visibility +
                                                                        +
                                                                        • +
                                                                        • +
                                                                      +
                                                                      +
                                                                      +

                                                                      On This Page

                                                                       +
                                                                      +
                                                                      Constructors +
                                                                      +
                                                                      Properties +
                                                                      +
                                                                      Methods +
                                                                      +
                                                                      +
                                                                      +
                                                                      diff --git a/docs/classes/MfaListAuthenticatorsError.html b/docs/classes/MfaListAuthenticatorsError.html index cd63650d..73da54e5 100644 --- a/docs/classes/MfaListAuthenticatorsError.html +++ b/docs/classes/MfaListAuthenticatorsError.html @@ -1,1084 +1,162 @@ - - - - - - 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'
                                                                          }
                                                                        }
+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
                                                                          
-                                                                                        
-              
                                                                          
-                
                                                                          
-                  
-                  
                                                                          
-                    
-                        constructor
-                  
                                                                          
-                
                                                                          
-                
                                                                          
-                  
-                  
                                                                          
-                    
-                        error
-                    
-                        error_description
-                    
-                        message
-                    
-                        name
-                    
-                        originalStack?
-                    
-                        stack?
-                    
-                        zoneAwareStack?
-                  
                                                                          
-                
                                                                          
-                
                                                                          
-                  
-                  
                                                                          
-                    
-                        fromPayload
-                  
                                                                          
-                
                                                                          
-              
                                                                          
-            
                                                                          
-          
                                                                          
-        
                                                                          
-        
                                                                          
-          
-            
-            
-          
-          
                                                                          
-            
                                                                          
-              
-              
                                                                            
-                
                                                                          • 
-                  
-                  
                                                                            
-                    
                                                                            
-                      
                                                                            Parameters
                                                                            
-                      
                                                                              
-                        
                                                                            • 
-                          error:
-                            string
-                        
                                                                              • 
-                        
                                                                            • 
-                          error_description:
-                            string
-                        
                                                                              • 
-                      
                                                                            
-                    
                                                                            
-                    
                                                                            
-                      Returns
-                      MfaListAuthenticatorsError
-                    
                                                                            
-                    
-                  
                                                                            
-                
                                                                            • 
-              
                                                                          
-            
                                                                          
-          
                                                                          
-        
                                                                          
-        
                                                                          
-          
-            
-            
-          
-          
                                                                          
-            
                                                                          
-              
-              
                                                                          
-                error:
-                string
-              
                                                                          
-              
-            
                                                                          
-            
                                                                          
-              
-              
                                                                          
-                error_description:
-                string
-              
                                                                          
-              
-            
                                                                          
-            
                                                                          
-              
-              
                                                                          
-                message:
-                string
-              
                                                                          
-              
-            
                                                                          
-            
                                                                          
-              
-              
                                                                          
-                name:
-                string
-              
                                                                          
-              
-            
                                                                          
-            
                                                                          
-              
-              
                                                                          
-                originalStack?:
-                string
-              
                                                                          
-              
                                                                          
-                
                                                                          Original stack trace with no modifications
                                                                          
-              
                                                                          
-              
-            
                                                                          
-            
                                                                          
-              
-              
                                                                          
-                stack?:
-                string
-              
                                                                          
-              
-            
                                                                          
-            
                                                                          
-              
-              
                                                                          
-                zoneAwareStack?:
-                string
-              
                                                                          
-              
                                                                          
-                
                                                                          
-                  Stack trace where extra frames have been removed and zone
-                  names added.
-                
                                                                          
-              
                                                                          
-              
-            
                                                                          
-          
                                                                          
-        
                                                                          
-        
                                                                          
-          
-            
-            
-          
-          
                                                                          
-            
                                                                          
-              
-              
                                                                            
-                
                                                                          • 
-                  
-                  
                                                                            
-                    
                                                                            
-                      
                                                                            Parameters
                                                                            
-                      
                                                                              
-                        
                                                                            • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                              • 
-                      
                                                                            
-                    
                                                                            
-                    
                                                                            
-                      Returns
-                      MfaError
-                    
                                                                            
-                    
-                  
                                                                            
-                
                                                                            • 
-              
                                                                          
-            
                                                                          
-          
                                                                          
-        
                                                                          
-      
                                                                          
-      
                                                                          
-        
                                                                          
-          
                                                                          
-            
                                                                          
-              
-                
-                
                                                                          Settings
                                                                          
-                                                                                        
-              
                                                                          
-                
                                                                          
-                  Member Visibility
-                  
                                                                            
-                    
                                                                          • 
-                      
-                    
                                                                            • 
-                    
                                                                          • 
-                      
-                    
                                                                            • 
-                    
                                                                          • 
-                      
-                    
                                                                            • 
-                  
                                                                          
-                
                                                                          
-                
                                                                          
-                  
-                
                                                                          
-              
                                                                          
-            
                                                                          
-          
                                                                          
-          
                                                                          
-            
-              
-              
                                                                          On This Page
                                                                          
-                                                                                      
-            
                                                                          
-              
                                                                          
-                
-                  Constructors
-                
-                
-              
                                                                          
-              
                                                                          
-                
-                  Properties
-                
-                
-              
                                                                          
-              
                                                                          
-                
-                  Methods
-                
-                
-              
                                                                          
-            
                                                                          
-          
                                                                          
-        
                                                                          
-        
                                                                          
-          
-        
                                                                          
-      
                                                                          
-    
                                                                          
-    
                                                                          
-    
                                                                          
-  
-
+
+
                                                                          +
                                                                          +

                                                                          Hierarchy (View Summary)

                                                                          +
                                                                            +
                                                                          • MfaError +
                                                                              +
                                                                            • MfaListAuthenticatorsError
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          Index
                                                                           +
                                                                          +
                                                                          + +
                                                                          constructor +
                                                                          +
                                                                          + +
                                                                          error +error_description +message +name +originalStack? +stack? +zoneAwareStack? +
                                                                          +
                                                                          + +
                                                                          fromPayload +
                                                                          +
                                                                          + +
                                                                          +
                                                                          + +
                                                                          +
                                                                          + +
                                                                          +
                                                                          + +
                                                                          error: string
                                                                          +
                                                                          + +
                                                                          error_description: string
                                                                          +
                                                                          + +
                                                                          message: string
                                                                          +
                                                                          + +
                                                                          name: string
                                                                          +
                                                                          + +
                                                                          originalStack?: string
                                                                          +

                                                                          Original stack trace with no modifications

                                                                          +
                                                                          +
                                                                          + +
                                                                          stack?: string
                                                                          +
                                                                          + +
                                                                          zoneAwareStack?: string
                                                                          +

                                                                          Stack trace where extra frames have been removed and zone names added.

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

                                                                            Parameters

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

                                                                            Returns MfaError

                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          +

                                                                          Settings

                                                                           +
                                                                          +
                                                                          Member Visibility +
                                                                            +
                                                                            • +
                                                                            • +
                                                                          +
                                                                          +
                                                                          +

                                                                          On This Page

                                                                           +
                                                                          +
                                                                          Constructors +
                                                                          +
                                                                          Properties +
                                                                          +
                                                                          Methods +
                                                                          +
                                                                          +
                                                                          +
                                                                          diff --git a/docs/classes/MfaRequiredError.html b/docs/classes/MfaRequiredError.html index 6d7ca63d..2a7fcc04 100644 --- a/docs/classes/MfaRequiredError.html +++ b/docs/classes/MfaRequiredError.html @@ -1,1184 +1,170 @@ - - - - - - MfaRequiredError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                          -
                                                                          - @auth0/auth0-angular - - - - -
                                                                            -
                                                                            -
                                                                            Preparing search index...
                                                                            -
                                                                            -                                                                             - -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            - -

                                                                            Class MfaRequiredError

                                                                            -
                                                                            -
                                                                            -
                                                                            -

                                                                            - Error thrown when the token exchange results in a - mfa_required error -

                                                                            -
                                                                            -
                                                                            -
                                                                            -

                                                                            - Hierarchy (View Summary) -

                                                                            - -
                                                                            - -
                                                                            -
                                                                            -
                                                                            - - -
                                                                            Index
                                                                            -                                                                             -
                                                                            -
                                                                            - -
                                                                            - - constructor -
                                                                            -
                                                                            -
                                                                            - -
                                                                            - - error - - error_description - - message - - mfa_requirements - - mfa_token - - name - - originalStack? - - stack? - - zoneAwareStack? -
                                                                            -
                                                                            -
                                                                            - -
                                                                            - - fromPayload -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            - - - - -
                                                                            -
                                                                            - -
                                                                              -
                                                                            • - -
                                                                              -
                                                                              -

                                                                              Parameters

                                                                              -
                                                                                -
                                                                              • - error: - string -
                                                                                • -
                                                                              • - error_description: - string -
                                                                                • -
                                                                              • - mfa_token: - string -
                                                                                • -
                                                                              • - mfa_requirements: - MfaRequirements -
                                                                                • -
                                                                              -
                                                                              -

                                                                              - Returns - MfaRequiredError -

                                                                              - -
                                                                              -
                                                                              • -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            - - - - -
                                                                            -
                                                                            - -
                                                                            - error: - string -
                                                                            - -
                                                                            -
                                                                            - -
                                                                            - error_description: - string -
                                                                            - -
                                                                            -
                                                                            - -
                                                                            - message: - string -
                                                                            - -
                                                                            -
                                                                            - -
                                                                            - mfa_requirements: - MfaRequirements -
                                                                            - -
                                                                            -
                                                                            - -
                                                                            - mfa_token: - string -
                                                                            - -
                                                                            -
                                                                            - -
                                                                            - name: - string -
                                                                            - -
                                                                            -
                                                                            - -
                                                                            - originalStack?: - string -
                                                                            -
                                                                            -

                                                                            Original stack trace with no modifications

                                                                            -
                                                                            - -
                                                                            -
                                                                            - -
                                                                            - stack?: - string -
                                                                            - -
                                                                            -
                                                                            - -
                                                                            - zoneAwareStack?: - string -
                                                                            -
                                                                            -

                                                                            - Stack trace where extra frames have been removed and zone - names added. -

                                                                            -
                                                                            - -
                                                                            -
                                                                            -
                                                                            -
                                                                            - - - - -
                                                                            -
                                                                            - -
                                                                              -
                                                                            • - -
                                                                              -
                                                                              -

                                                                              Parameters

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

                                                                              - Returns - GenericError -

                                                                              - -
                                                                              -
                                                                              • -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            - - -

                                                                            Settings

                                                                            -                                                                             -
                                                                            -
                                                                            - Member Visibility -
                                                                              -
                                                                            • - -
                                                                              • -
                                                                            • - -
                                                                              • -
                                                                            • - -
                                                                              • -
                                                                            -
                                                                            -
                                                                            - -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            - - -

                                                                            On This Page

                                                                            -                                                                             -
                                                                            -
                                                                            - - Constructors - - -
                                                                            -
                                                                            - - Properties - - -
                                                                            -
                                                                            - - Methods - - -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            - -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            - - +MfaRequiredError | @auth0/auth0-angular
                                                                            +
                                                                            @auth0/auth0-angular + +
                                                                              +
                                                                              +
                                                                              Preparing search index...
                                                                              +
                                                                              +
                                                                              +
                                                                              + +

                                                                              Class MfaRequiredError

                                                                              +
                                                                              +

                                                                              Error thrown when the token exchange results in a mfa_required error

                                                                              +
                                                                              +
                                                                              +

                                                                              Hierarchy (View Summary)

                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              Index
                                                                               +
                                                                              +
                                                                              + +
                                                                              constructor +
                                                                              +
                                                                              + +
                                                                              error +error_description +message +mfa_requirements +mfa_token +name +originalStack? +stack? +zoneAwareStack? +
                                                                              +
                                                                              + +
                                                                              fromPayload +
                                                                              +
                                                                              + +
                                                                              +
                                                                              + +
                                                                                +
                                                                              • + +
                                                                                +
                                                                                +

                                                                                Parameters

                                                                                +
                                                                                  +
                                                                                • error: string
                                                                                  • +
                                                                                • error_description: string
                                                                                  • +
                                                                                • mfa_token: string
                                                                                  • +
                                                                                • mfa_requirements: MfaRequirements
                                                                                +

                                                                                Returns MfaRequiredError

                                                                              +
                                                                              + +
                                                                              +
                                                                              + +
                                                                              error: string
                                                                              +
                                                                              + +
                                                                              error_description: string
                                                                              +
                                                                              + +
                                                                              message: string
                                                                              +
                                                                              + +
                                                                              mfa_requirements: MfaRequirements
                                                                              +
                                                                              + +
                                                                              mfa_token: string
                                                                              +
                                                                              + +
                                                                              name: string
                                                                              +
                                                                              + +
                                                                              originalStack?: string
                                                                              +

                                                                              Original stack trace with no modifications

                                                                              +
                                                                              +
                                                                              + +
                                                                              stack?: string
                                                                              +
                                                                              + +
                                                                              zoneAwareStack?: string
                                                                              +

                                                                              Stack trace where extra frames have been removed and zone names added.

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

                                                                                Parameters

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

                                                                                Returns GenericError

                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              +

                                                                              Settings

                                                                               +
                                                                              +
                                                                              Member Visibility +
                                                                                +
                                                                                • +
                                                                                • +
                                                                              +
                                                                              +
                                                                              +

                                                                              On This Page

                                                                               +
                                                                              +
                                                                              Constructors +
                                                                              +
                                                                              Properties +
                                                                              +
                                                                              Methods +
                                                                              +
                                                                              +
                                                                              +
                                                                              diff --git a/docs/classes/MfaVerifyError.html b/docs/classes/MfaVerifyError.html index 47f17840..ff14ce80 100644 --- a/docs/classes/MfaVerifyError.html +++ b/docs/classes/MfaVerifyError.html @@ -1,1076 +1,162 @@ - - - - - - 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
                                                                                  }
                                                                                }
+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
                                                                                  
-                                                                                                
-              
                                                                                  
-                
                                                                                  
-                  
-                  
                                                                                  
-                    
-                        constructor
-                  
                                                                                  
-                
                                                                                  
-                
                                                                                  
-                  
-                  
                                                                                  
-                    
-                        error
-                    
-                        error_description
-                    
-                        message
-                    
-                        name
-                    
-                        originalStack?
-                    
-                        stack?
-                    
-                        zoneAwareStack?
-                  
                                                                                  
-                
                                                                                  
-                
                                                                                  
-                  
-                  
                                                                                  
-                    
-                        fromPayload
-                  
                                                                                  
-                
                                                                                  
-              
                                                                                  
-            
                                                                                  
-          
                                                                                  
-        
                                                                                  
-        
                                                                                  
-          
-            
-            
-          
-          
                                                                                  
-            
                                                                                  
-              
-              
                                                                                    
-                
                                                                                  • 
-                  
-                  
                                                                                    
-                    
                                                                                    
-                      
                                                                                    Parameters
                                                                                    
-                      
                                                                                      
-                        
                                                                                    • 
-                          error:
-                            string
-                        
                                                                                      • 
-                        
                                                                                    • 
-                          error_description:
-                            string
-                        
                                                                                      • 
-                      
                                                                                    
-                    
                                                                                    
-                    
                                                                                    
-                      Returns
-                      MfaVerifyError
-                    
                                                                                    
-                    
-                  
                                                                                    
-                
                                                                                    • 
-              
                                                                                  
-            
                                                                                  
-          
                                                                                  
-        
                                                                                  
-        
                                                                                  
-          
-            
-            
-          
-          
                                                                                  
-            
                                                                                  
-              
-              
                                                                                  
-                error:
-                string
-              
                                                                                  
-              
-            
                                                                                  
-            
                                                                                  
-              
-              
                                                                                  
-                error_description:
-                string
-              
                                                                                  
-              
-            
                                                                                  
-            
                                                                                  
-              
-              
                                                                                  
-                message:
-                string
-              
                                                                                  
-              
-            
                                                                                  
-            
                                                                                  
-              
-              
                                                                                  
-                name:
-                string
-              
                                                                                  
-              
-            
                                                                                  
-            
                                                                                  
-              
-              
                                                                                  
-                originalStack?:
-                string
-              
                                                                                  
-              
                                                                                  
-                
                                                                                  Original stack trace with no modifications
                                                                                  
-              
                                                                                  
-              
-            
                                                                                  
-            
                                                                                  
-              
-              
                                                                                  
-                stack?:
-                string
-              
                                                                                  
-              
-            
                                                                                  
-            
                                                                                  
-              
-              
                                                                                  
-                zoneAwareStack?:
-                string
-              
                                                                                  
-              
                                                                                  
-                
                                                                                  
-                  Stack trace where extra frames have been removed and zone
-                  names added.
-                
                                                                                  
-              
                                                                                  
-              
-            
                                                                                  
-          
                                                                                  
-        
                                                                                  
-        
                                                                                  
-          
-            
-            
-          
-          
                                                                                  
-            
                                                                                  
-              
-              
                                                                                    
-                
                                                                                  • 
-                  
-                  
                                                                                    
-                    
                                                                                    
-                      
                                                                                    Parameters
                                                                                    
-                      
                                                                                      
-                        
                                                                                    • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                                      • 
-                      
                                                                                    
-                    
                                                                                    
-                    
                                                                                    
-                      Returns
-                      MfaError
-                    
                                                                                    
-                    
-                  
                                                                                    
-                
                                                                                    • 
-              
                                                                                  
-            
                                                                                  
-          
                                                                                  
-        
                                                                                  
-      
                                                                                  
-      
                                                                                  
-        
                                                                                  
-          
                                                                                  
-            
                                                                                  
-              
-                
-                
                                                                                  Settings
                                                                                  
-                                                                                                
-              
                                                                                  
-                
                                                                                  
-                  Member Visibility
-                  
                                                                                    
-                    
                                                                                  • 
-                      
-                    
                                                                                    • 
-                    
                                                                                  • 
-                      
-                    
                                                                                    • 
-                    
                                                                                  • 
-                      
-                    
                                                                                    • 
-                  
                                                                                  
-                
                                                                                  
-                
                                                                                  
-                  
-                
                                                                                  
-              
                                                                                  
-            
                                                                                  
-          
                                                                                  
-          
                                                                                  
-            
-              
-              
                                                                                  On This Page
                                                                                  
-                                                                                              
-            
                                                                                  
-              
                                                                                  
-                
-                  Constructors
-                
-                
-              
                                                                                  
-              
                                                                                  
-                
-                  Properties
-                
-                
-              
                                                                                  
-              
                                                                                  
-                
-                  Methods
-                
-                
-              
                                                                                  
-            
                                                                                  
-          
                                                                                  
-        
                                                                                  
-        
                                                                                  
-          
-        
                                                                                  
-      
                                                                                  
-    
                                                                                  
-    
                                                                                  
-    
                                                                                  
-  
-
+
+
                                                                                  +
                                                                                  +

                                                                                  Hierarchy (View Summary)

                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  Index
                                                                                   +
                                                                                  +
                                                                                  + +
                                                                                  constructor +
                                                                                  +
                                                                                  + +
                                                                                  error +error_description +message +name +originalStack? +stack? +zoneAwareStack? +
                                                                                  +
                                                                                  + +
                                                                                  fromPayload +
                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  + +
                                                                                    +
                                                                                  • + +
                                                                                    +
                                                                                    +

                                                                                    Parameters

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

                                                                                    Returns MfaVerifyError

                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  + +
                                                                                  error: string
                                                                                  +
                                                                                  + +
                                                                                  error_description: string
                                                                                  +
                                                                                  + +
                                                                                  message: string
                                                                                  +
                                                                                  + +
                                                                                  name: string
                                                                                  +
                                                                                  + +
                                                                                  originalStack?: string
                                                                                  +

                                                                                  Original stack trace with no modifications

                                                                                  +
                                                                                  +
                                                                                  + +
                                                                                  stack?: string
                                                                                  +
                                                                                  + +
                                                                                  zoneAwareStack?: string
                                                                                  +

                                                                                  Stack trace where extra frames have been removed and zone names added.

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

                                                                                    Parameters

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

                                                                                    Returns MfaError

                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +

                                                                                  Settings

                                                                                   +
                                                                                  +
                                                                                  Member Visibility +
                                                                                    +
                                                                                    • +
                                                                                    • +
                                                                                  +
                                                                                  +
                                                                                  +

                                                                                  On This Page

                                                                                   +
                                                                                  +
                                                                                  Constructors +
                                                                                  +
                                                                                  Properties +
                                                                                  +
                                                                                  Methods +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  diff --git a/docs/classes/MissingRefreshTokenError.html b/docs/classes/MissingRefreshTokenError.html index 5f3fe7bb..e62d054f 100644 --- a/docs/classes/MissingRefreshTokenError.html +++ b/docs/classes/MissingRefreshTokenError.html @@ -1,1150 +1,168 @@ - - - - - - MissingRefreshTokenError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                  -
                                                                                  - @auth0/auth0-angular - - - - -
                                                                                    -
                                                                                    -
                                                                                    Preparing search index...
                                                                                    -
                                                                                    -                                                                                     - -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    - -

                                                                                    Class MissingRefreshTokenError

                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -

                                                                                    Error thrown when there is no refresh token to use

                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -

                                                                                    - Hierarchy (View Summary) -

                                                                                    - -
                                                                                    - -
                                                                                    -
                                                                                    -
                                                                                    - - -
                                                                                    Index
                                                                                    -                                                                                     -
                                                                                    -
                                                                                    - -
                                                                                    - - constructor -
                                                                                    -
                                                                                    -
                                                                                    - -
                                                                                    - - audience - - error - - error_description - - message - - name - - originalStack? - - scope - - stack? - - zoneAwareStack? -
                                                                                    -
                                                                                    -
                                                                                    - -
                                                                                    - - fromPayload -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    - - - - -
                                                                                    -
                                                                                    - -
                                                                                      -
                                                                                    • - -
                                                                                      -
                                                                                      -

                                                                                      Parameters

                                                                                      -
                                                                                        -
                                                                                      • - audience: - string -
                                                                                        • -
                                                                                      • - scope: - string -
                                                                                        • -
                                                                                      -
                                                                                      -

                                                                                      - Returns - MissingRefreshTokenError -

                                                                                      - -
                                                                                      -
                                                                                      • -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    - - - - -
                                                                                    -
                                                                                    - -
                                                                                    - audience: - string -
                                                                                    - -
                                                                                    -
                                                                                    - -
                                                                                    - error: - string -
                                                                                    - -
                                                                                    -
                                                                                    - -
                                                                                    - error_description: - string -
                                                                                    - -
                                                                                    -
                                                                                    - -
                                                                                    - message: - string -
                                                                                    - -
                                                                                    -
                                                                                    - -
                                                                                    - name: - string -
                                                                                    - -
                                                                                    -
                                                                                    - -
                                                                                    - originalStack?: - string -
                                                                                    -
                                                                                    -

                                                                                    Original stack trace with no modifications

                                                                                    -
                                                                                    - -
                                                                                    -
                                                                                    - -
                                                                                    - scope: - string -
                                                                                    - -
                                                                                    -
                                                                                    - -
                                                                                    - stack?: - string -
                                                                                    - -
                                                                                    -
                                                                                    - -
                                                                                    - zoneAwareStack?: - string -
                                                                                    -
                                                                                    -

                                                                                    - Stack trace where extra frames have been removed and zone - names added. -

                                                                                    -
                                                                                    - -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    - - - - -
                                                                                    -
                                                                                    - -
                                                                                      -
                                                                                    • - -
                                                                                      -
                                                                                      -

                                                                                      Parameters

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

                                                                                      - Returns - GenericError -

                                                                                      - -
                                                                                      -
                                                                                      • -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    - - -

                                                                                    Settings

                                                                                    -                                                                                     -
                                                                                    -
                                                                                    - Member Visibility -
                                                                                      -
                                                                                    • - -
                                                                                      • -
                                                                                    • - -
                                                                                      • -
                                                                                    • - -
                                                                                      • -
                                                                                    -
                                                                                    -
                                                                                    - -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    - - -

                                                                                    On This Page

                                                                                    -                                                                                     -
                                                                                    -
                                                                                    - - Constructors - - -
                                                                                    -
                                                                                    - - Properties - - -
                                                                                    -
                                                                                    - - Methods - - -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    - -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    - - +MissingRefreshTokenError | @auth0/auth0-angular
                                                                                    +
                                                                                    @auth0/auth0-angular + +
                                                                                      +
                                                                                      +
                                                                                      Preparing search index...
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + +

                                                                                      Class MissingRefreshTokenError

                                                                                      +
                                                                                      +

                                                                                      Error thrown when there is no refresh token to use

                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      Hierarchy (View Summary)

                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      Index
                                                                                       +
                                                                                      +
                                                                                      + +
                                                                                      constructor +
                                                                                      +
                                                                                      + +
                                                                                      audience +error +error_description +message +name +originalStack? +scope +stack? +zoneAwareStack? +
                                                                                      +
                                                                                      + +
                                                                                      fromPayload +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + +
                                                                                      audience: string
                                                                                      +
                                                                                      + +
                                                                                      error: string
                                                                                      +
                                                                                      + +
                                                                                      error_description: string
                                                                                      +
                                                                                      + +
                                                                                      message: string
                                                                                      +
                                                                                      + +
                                                                                      name: string
                                                                                      +
                                                                                      + +
                                                                                      originalStack?: string
                                                                                      +

                                                                                      Original stack trace with no modifications

                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      scope: string
                                                                                      +
                                                                                      + +
                                                                                      stack?: string
                                                                                      +
                                                                                      + +
                                                                                      zoneAwareStack?: string
                                                                                      +

                                                                                      Stack trace where extra frames have been removed and zone names added.

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

                                                                                        Parameters

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

                                                                                        Returns GenericError

                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      Settings

                                                                                       +
                                                                                      +
                                                                                      Member Visibility +
                                                                                        +
                                                                                        • +
                                                                                        • +
                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      On This Page

                                                                                       +
                                                                                      +
                                                                                      Constructors +
                                                                                      +
                                                                                      Properties +
                                                                                      +
                                                                                      Methods +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      diff --git a/docs/classes/MissingScopesError.html b/docs/classes/MissingScopesError.html index 95186019..43e53268 100644 --- a/docs/classes/MissingScopesError.html +++ b/docs/classes/MissingScopesError.html @@ -1,1147 +1,168 @@ - - - - - - MissingScopesError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                      -
                                                                                      - @auth0/auth0-angular - - - - -
                                                                                        -
                                                                                        -
                                                                                        Preparing search index...
                                                                                        -
                                                                                        -                                                                                         - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Class MissingScopesError

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        - Error thrown when there are missing scopes after refreshing a - token -

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        - Hierarchy (View Summary) -

                                                                                        - -
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        Index
                                                                                        -                                                                                         -
                                                                                        -
                                                                                        - -
                                                                                        - - constructor -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        - - audience - - error - - error_description - - message - - name - - originalStack? - - scope - - stack? - - zoneAwareStack? -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        - - fromPayload -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - -
                                                                                          -
                                                                                        • - -
                                                                                          -
                                                                                          -

                                                                                          Parameters

                                                                                          -
                                                                                            -
                                                                                          • - audience: - string -
                                                                                            • -
                                                                                          • - scope: - string -
                                                                                            • -
                                                                                          -
                                                                                          -

                                                                                          - Returns - MissingScopesError -

                                                                                          - -
                                                                                          -
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - -
                                                                                        - audience: - string -
                                                                                        - -
                                                                                        -
                                                                                        - -
                                                                                        - error: - string -
                                                                                        - -
                                                                                        -
                                                                                        - -
                                                                                        - error_description: - string -
                                                                                        - -
                                                                                        -
                                                                                        - -
                                                                                        - message: - string -
                                                                                        - -
                                                                                        -
                                                                                        - -
                                                                                        - name: - string -
                                                                                        - -
                                                                                        -
                                                                                        - -
                                                                                        - originalStack?: - string -
                                                                                        -
                                                                                        -

                                                                                        Original stack trace with no modifications

                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - -
                                                                                        - scope: - string -
                                                                                        - -
                                                                                        -
                                                                                        - -
                                                                                        - stack?: - string -
                                                                                        - -
                                                                                        -
                                                                                        - -
                                                                                        - zoneAwareStack?: - string -
                                                                                        -
                                                                                        -

                                                                                        - Stack trace where extra frames have been removed and zone - names added. -

                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - -
                                                                                          -
                                                                                        • - -
                                                                                          -
                                                                                          -

                                                                                          Parameters

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

                                                                                          - Returns - GenericError -

                                                                                          - -
                                                                                          -
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -

                                                                                        Settings

                                                                                        -                                                                                         -
                                                                                        -
                                                                                        - Member Visibility -
                                                                                          -
                                                                                        • - -
                                                                                          • -
                                                                                        • - -
                                                                                          • -
                                                                                        • - -
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -

                                                                                        On This Page

                                                                                        -                                                                                         -
                                                                                        -
                                                                                        - - Constructors - - -
                                                                                        -
                                                                                        - - Properties - - -
                                                                                        -
                                                                                        - - Methods - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - +MissingScopesError | @auth0/auth0-angular
                                                                                        +
                                                                                        @auth0/auth0-angular + +
                                                                                          +
                                                                                          +
                                                                                          Preparing search index...
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          + +

                                                                                          Class MissingScopesError

                                                                                          +
                                                                                          +

                                                                                          Error thrown when there are missing scopes after refreshing a token

                                                                                          +
                                                                                          +
                                                                                          +

                                                                                          Hierarchy (View Summary)

                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          Index
                                                                                           +
                                                                                          +
                                                                                          + +
                                                                                          constructor +
                                                                                          +
                                                                                          + +
                                                                                          audience +error +error_description +message +name +originalStack? +scope +stack? +zoneAwareStack? +
                                                                                          +
                                                                                          + +
                                                                                          fromPayload +
                                                                                          +
                                                                                          + +
                                                                                          +
                                                                                          + +
                                                                                          +
                                                                                          + +
                                                                                          +
                                                                                          + +
                                                                                          audience: string
                                                                                          +
                                                                                          + +
                                                                                          error: string
                                                                                          +
                                                                                          + +
                                                                                          error_description: string
                                                                                          +
                                                                                          + +
                                                                                          message: string
                                                                                          +
                                                                                          + +
                                                                                          name: string
                                                                                          +
                                                                                          + +
                                                                                          originalStack?: string
                                                                                          +

                                                                                          Original stack trace with no modifications

                                                                                          +
                                                                                          +
                                                                                          + +
                                                                                          scope: string
                                                                                          +
                                                                                          + +
                                                                                          stack?: string
                                                                                          +
                                                                                          + +
                                                                                          zoneAwareStack?: string
                                                                                          +

                                                                                          Stack trace where extra frames have been removed and zone names added.

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

                                                                                            Parameters

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

                                                                                            Returns GenericError

                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +

                                                                                          Settings

                                                                                           +
                                                                                          +
                                                                                          Member Visibility +
                                                                                            +
                                                                                            • +
                                                                                            • +
                                                                                          +
                                                                                          +
                                                                                          +

                                                                                          On This Page

                                                                                           +
                                                                                          +
                                                                                          Constructors +
                                                                                          +
                                                                                          Properties +
                                                                                          +
                                                                                          Methods +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          diff --git a/docs/classes/MyAccountApiError.html b/docs/classes/MyAccountApiError.html index 7b698ea7..a99808b3 100644 --- a/docs/classes/MyAccountApiError.html +++ b/docs/classes/MyAccountApiError.html @@ -1,1005 +1,164 @@ - - - - - - MyAccountApiError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                          -
                                                                                          - @auth0/auth0-angular - - - - -
                                                                                            -
                                                                                            -
                                                                                            Preparing search index...
                                                                                            -
                                                                                            -                                                                                             - -
                                                                                            -
                                                                                            -
                                                                                            -
                                                                                            -
                                                                                            - -

                                                                                            Class MyAccountApiError

                                                                                            -
                                                                                            -
                                                                                            -
                                                                                            -

                                                                                            - Error thrown when the MyAccount API returns a non-2xx response. -

                                                                                            -
                                                                                            -
                                                                                            -
                                                                                            - - 
                                                                                            try {
                                                                                              await myAccount.getAuthenticationMethods();
                                                                                            } catch (err) {
                                                                                              if (err instanceof MyAccountApiError) {
                                                                                                console.error(err.status, err.title, err.detail);
                                                                                              }
                                                                                            }
+MyAccountApiError | @auth0/auth0-angular
                                                                                            
+
                                                                                            @auth0/auth0-angular
+
+
                                                                                              
+
                                                                                              
+
                                                                                              Preparing search index...
                                                                                              
+
                                                                                              
+
                                                                                              
+
                                                                                              
+
+
                                                                                              Class MyAccountApiError
                                                                                              
+
                                                                                              
+
                                                                                              Error thrown when the MyAccount API returns a non-2xx response.
                                                                                              
+
                                                                                              
+
                                                                                              
+
                                                                                              
+
                                                                                              try {
                                                                                                await myAccount.getAuthenticationMethods();
                                                                                              } catch (err) {
                                                                                                if (err instanceof MyAccountApiError) {
                                                                                                  console.error(err.status, err.title, err.detail);
                                                                                                }
                                                                                              }
 
                                                                                              
-            
                                                                                              
-          
                                                                                              
-        
                                                                                              
-        
                                                                                              
-          
                                                                                              Hierarchy
                                                                                              
-          
                                                                                                
-            
                                                                                              • 
-              Error
-              
                                                                                                  
-                
                                                                                                • 
-                  MyAccountApiError
-                
                                                                                                  • 
-              
                                                                                                
-            
                                                                                                • 
-          
                                                                                              
-        
                                                                                              
-        
-        
                                                                                              
-          
                                                                                              
-            
                                                                                              
-              
-                
-                
                                                                                              Index
                                                                                              
-                                                                                                            
-              
                                                                                              
-                
                                                                                              
-                  
-                  
                                                                                              
-                    
-                        constructor
-                  
                                                                                              
-                
                                                                                              
-                
                                                                                              
-                  
-                  
                                                                                              
-                    
-                        detail
-                    
-                        message
-                    
-                        name
-                    
-                        originalStack?
-                    
-                        stack?
-                    
-                        status
-                    
-                        title
-                    
-                        type
-                    
-                        validation_errors?
-                    
-                        zoneAwareStack?
-                  
                                                                                              
-                
                                                                                              
-              
                                                                                              
-            
                                                                                              
-          
                                                                                              
-        
                                                                                              
-        
                                                                                              
-          
-            
-            
-          
-          
                                                                                              
-            
                                                                                              
-              
-              
                                                                                                
-                
                                                                                              • 
-                  
-                  
                                                                                                
-                    
                                                                                                
-                      
                                                                                                Parameters
                                                                                                
-                      
                                                                                                  
-                        
                                                                                                • 
-                          __namedParameters:
-                            ErrorResponse
-                        
                                                                                                  • 
-                      
                                                                                                
-                    
                                                                                                
-                    
                                                                                                
-                      Returns
-                      MyAccountApiError
-                    
                                                                                                
-                    
-                  
                                                                                                
-                
                                                                                                • 
-              
                                                                                              
-            
                                                                                              
-          
                                                                                              
-        
                                                                                              
-        
                                                                                              
-          
-            
-            
-          
-          
                                                                                              
-            
                                                                                              
-              
-              
                                                                                              
-                detail:
-                string
-              
                                                                                              
-              
                                                                                              
-                
                                                                                              Human-readable explanation specific to this occurrence
                                                                                              
-              
                                                                                              
-              
-            
                                                                                              
-            
                                                                                              
-              
-              
                                                                                              
-                message:
-                string
-              
                                                                                              
-              
-            
                                                                                              
-            
                                                                                              
-              
-              
                                                                                              
-                name:
-                string
-              
                                                                                              
-              
-            
                                                                                              
-            
                                                                                              
-              
-              
                                                                                              
-                originalStack?:
-                string
-              
                                                                                              
-              
                                                                                              
-                
                                                                                              Original stack trace with no modifications
                                                                                              
-              
                                                                                              
-              
-            
                                                                                              
-            
                                                                                              
-              
-              
                                                                                              
-                stack?:
-                string
-              
                                                                                              
-              
-            
                                                                                              
-            
                                                                                              
-              
-              
                                                                                              
-                status:
-                number
-              
                                                                                              
-              
                                                                                              
-                
                                                                                              HTTP status code
                                                                                              
-              
                                                                                              
-              
-            
                                                                                              
-            
                                                                                              
-              
-              
                                                                                              
-                title:
-                string
-              
                                                                                              
-              
                                                                                              
-                
                                                                                              Short human-readable summary of the error
                                                                                              
-              
                                                                                              
-              
-            
                                                                                              
-            
                                                                                              
-              
-              
                                                                                              
-                type:
-                string
-              
                                                                                              
-              
                                                                                              
-                
                                                                                              RFC 7807 error type identifier
                                                                                              
-              
                                                                                              
-              
-            
                                                                                              
-            
                                                                                              
-              
-              
                                                                                              
-                validation_errors?:
-                {
                                                                                                  detail:
-                string;
                                                                                                  field?:
-                string;
                                                                                                  pointer?:
-                string;
                                                                                                  source?:
-                string;
                                                                                              }[]
-              
                                                                                              
-              
                                                                                              
-                
                                                                                              Field-level validation errors, if present
                                                                                              
-              
                                                                                              
-              
-            
                                                                                              
-            
                                                                                              
-              
-              
                                                                                              
-                zoneAwareStack?:
-                string
-              
                                                                                              
-              
                                                                                              
-                
                                                                                              
-                  Stack trace where extra frames have been removed and zone
-                  names added.
-                
                                                                                              
-              
                                                                                              
-              
-            
                                                                                              
-          
                                                                                              
-        
                                                                                              
-      
                                                                                              
-      
                                                                                              
-        
                                                                                              
-          
                                                                                              
-            
                                                                                              
-              
-                
-                
                                                                                              Settings
                                                                                              
-                                                                                                            
-              
                                                                                              
-                
                                                                                              
-                  Member Visibility
-                  
                                                                                                
-                    
                                                                                              • 
-                      
-                    
                                                                                                • 
-                    
                                                                                              • 
-                      
-                    
                                                                                                • 
-                    
                                                                                              • 
-                      
-                    
                                                                                                • 
-                  
                                                                                              
-                
                                                                                              
-                
                                                                                              
-                  
-                
                                                                                              
-              
                                                                                              
-            
                                                                                              
-          
                                                                                              
-          
                                                                                              
-            
-              
-              
                                                                                              On This Page
                                                                                              
-                                                                                                          
-            
                                                                                              
-              
                                                                                              
-                
-                  Constructors
-                
-                
-              
                                                                                              
-              
                                                                                              
-                
-                  Properties
-                
-                
-              
                                                                                              
-            
                                                                                              
-          
                                                                                              
-        
                                                                                              
-        
                                                                                              
-          
-        
                                                                                              
-      
                                                                                              
-    
                                                                                              
-    
                                                                                              
-    
                                                                                              
-  
-
+
+
                                                                                              +
                                                                                              +

                                                                                              Hierarchy

                                                                                              +
                                                                                                +
                                                                                              • Error +
                                                                                                  +
                                                                                                • MyAccountApiError
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              Index
                                                                                               +
                                                                                              +
                                                                                              + +
                                                                                              constructor +
                                                                                              +
                                                                                              + +
                                                                                              detail +message +name +originalStack? +stack? +status +title +type +validation_errors? +zoneAwareStack? +
                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + +
                                                                                                +
                                                                                              • + +
                                                                                                +
                                                                                                +

                                                                                                Parameters

                                                                                                +
                                                                                                  +
                                                                                                • __namedParameters: ErrorResponse
                                                                                                +

                                                                                                Returns MyAccountApiError

                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + +
                                                                                              detail: string
                                                                                              +

                                                                                              Human-readable explanation specific to this occurrence

                                                                                              +
                                                                                              +
                                                                                              + +
                                                                                              message: string
                                                                                              +
                                                                                              + +
                                                                                              name: string
                                                                                              +
                                                                                              + +
                                                                                              originalStack?: string
                                                                                              +

                                                                                              Original stack trace with no modifications

                                                                                              +
                                                                                              +
                                                                                              + +
                                                                                              stack?: string
                                                                                              +
                                                                                              + +
                                                                                              status: number
                                                                                              +

                                                                                              HTTP status code

                                                                                              +
                                                                                              +
                                                                                              + +
                                                                                              title: string
                                                                                              +

                                                                                              Short human-readable summary of the error

                                                                                              +
                                                                                              +
                                                                                              + +
                                                                                              type: string
                                                                                              +

                                                                                              RFC 7807 error type identifier

                                                                                              +
                                                                                              +
                                                                                              + +
                                                                                              validation_errors?: {
                                                                                                  detail: string;
                                                                                                  field?: string;
                                                                                                  pointer?: string;
                                                                                                  source?: string;
                                                                                              }[]
                                                                                              +

                                                                                              Field-level validation errors, if present

                                                                                              +
                                                                                              +
                                                                                              + +
                                                                                              zoneAwareStack?: string
                                                                                              +

                                                                                              Stack trace where extra frames have been removed and zone names added.

                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +

                                                                                              Settings

                                                                                               +
                                                                                              +
                                                                                              Member Visibility +
                                                                                                +
                                                                                                • +
                                                                                                • +
                                                                                              +
                                                                                              +
                                                                                              +

                                                                                              On This Page

                                                                                               +
                                                                                              +
                                                                                              Constructors +
                                                                                              +
                                                                                              Properties +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              diff --git a/docs/classes/PasskeyChallengeError.html b/docs/classes/PasskeyChallengeError.html index e9fb70f3..34e7b040 100644 --- a/docs/classes/PasskeyChallengeError.html +++ b/docs/classes/PasskeyChallengeError.html @@ -1,998 +1,160 @@ - - - - - - PasskeyChallengeError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                              -
                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                -
                                                                                                -
                                                                                                Preparing search index...
                                                                                                -
                                                                                                -                                                                                                 - -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - -

                                                                                                Class PasskeyChallengeError

                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -

                                                                                                Error thrown when requesting a passkey login challenge fails.

                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -

                                                                                                Hierarchy

                                                                                                -
                                                                                                  -
                                                                                                • - PasskeyError -
                                                                                                    -
                                                                                                  • - PasskeyChallengeError -
                                                                                                    • -
                                                                                                  -
                                                                                                  • -
                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                -
                                                                                                - - -
                                                                                                Index
                                                                                                -                                                                                                 -
                                                                                                -
                                                                                                - -
                                                                                                - - constructor -
                                                                                                -
                                                                                                -
                                                                                                - -
                                                                                                - - body? - - cause? - - code - - headers? - - message - - name - - originalStack? - - stack? - - statusCode? - - zoneAwareStack? -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - - - - -
                                                                                                -
                                                                                                - -
                                                                                                  -
                                                                                                • - -
                                                                                                  -
                                                                                                  -

                                                                                                  Parameters

                                                                                                  -
                                                                                                    -
                                                                                                  • - message: - string -
                                                                                                    • -
                                                                                                  • - Optionalcause: - PasskeyApiErrorResponse -
                                                                                                    • -
                                                                                                  -
                                                                                                  -

                                                                                                  - Returns - PasskeyChallengeError -

                                                                                                  - -
                                                                                                  -
                                                                                                  • -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - - - - -
                                                                                                -
                                                                                                -

                                                                                                - Optionalbody -

                                                                                                -
                                                                                                - body?: - string -
                                                                                                -
                                                                                                -

                                                                                                Raw response body text, when available.

                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                - -
                                                                                                - cause?: - PasskeyApiErrorResponse -
                                                                                                - -
                                                                                                -
                                                                                                - -
                                                                                                - code: - string -
                                                                                                - -
                                                                                                -
                                                                                                - -
                                                                                                - headers?: - Headers -
                                                                                                -
                                                                                                -

                                                                                                - Response headers from the error response, when available. - Native Fetch Headers. -

                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                - -
                                                                                                - message: - string -
                                                                                                - -
                                                                                                -
                                                                                                - -
                                                                                                - name: - string -
                                                                                                - -
                                                                                                -
                                                                                                - -
                                                                                                - originalStack?: - string -
                                                                                                -
                                                                                                -

                                                                                                Original stack trace with no modifications

                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                - -
                                                                                                - stack?: - string -
                                                                                                - -
                                                                                                -
                                                                                                - -
                                                                                                - statusCode?: - number -
                                                                                                -
                                                                                                -

                                                                                                HTTP status code from the error response, when available.

                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                - -
                                                                                                - zoneAwareStack?: - string -
                                                                                                -
                                                                                                -

                                                                                                - Stack trace where extra frames have been removed and zone - names added. -

                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - - -

                                                                                                Settings

                                                                                                -                                                                                                 -
                                                                                                -
                                                                                                - Member Visibility -
                                                                                                  -
                                                                                                • - -
                                                                                                  • -
                                                                                                • - -
                                                                                                  • -
                                                                                                • - -
                                                                                                  • -
                                                                                                -
                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - - -

                                                                                                On This Page

                                                                                                -                                                                                                 -
                                                                                                -
                                                                                                - - Constructors - - -
                                                                                                -
                                                                                                - - Properties - - -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - - +PasskeyChallengeError | @auth0/auth0-angular
                                                                                                +
                                                                                                @auth0/auth0-angular + +
                                                                                                  +
                                                                                                  +
                                                                                                  Preparing search index...
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  + +

                                                                                                  Class PasskeyChallengeError

                                                                                                  +
                                                                                                  +

                                                                                                  Error thrown when requesting a passkey login challenge fails.

                                                                                                  +
                                                                                                  +
                                                                                                  +

                                                                                                  Hierarchy

                                                                                                  +
                                                                                                    +
                                                                                                  • PasskeyError +
                                                                                                      +
                                                                                                    • PasskeyChallengeError
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  Index
                                                                                                   +
                                                                                                  +
                                                                                                  + +
                                                                                                  constructor +
                                                                                                  +
                                                                                                  + +
                                                                                                  body? +cause? +code +headers? +message +name +originalStack? +stack? +statusCode? +zoneAwareStack? +
                                                                                                  +
                                                                                                  + +
                                                                                                  +
                                                                                                  + +
                                                                                                    +
                                                                                                  • + +
                                                                                                    +
                                                                                                    +

                                                                                                    Parameters

                                                                                                    +
                                                                                                      +
                                                                                                    • message: string
                                                                                                      • +
                                                                                                    • Optionalcause: PasskeyApiErrorResponse
                                                                                                    +

                                                                                                    Returns PasskeyChallengeError

                                                                                                  +
                                                                                                  + +
                                                                                                  +
                                                                                                  +

                                                                                                  Optionalbody

                                                                                                  +
                                                                                                  body?: string
                                                                                                  +

                                                                                                  Raw response body text, when available.

                                                                                                  +
                                                                                                  +
                                                                                                  + +
                                                                                                  cause?: PasskeyApiErrorResponse
                                                                                                  +
                                                                                                  + +
                                                                                                  code: string
                                                                                                  +
                                                                                                  + +
                                                                                                  headers?: Headers
                                                                                                  +

                                                                                                  Response headers from the error response, when available. Native Fetch Headers.

                                                                                                  +
                                                                                                  +
                                                                                                  + +
                                                                                                  message: string
                                                                                                  +
                                                                                                  + +
                                                                                                  name: string
                                                                                                  +
                                                                                                  + +
                                                                                                  originalStack?: string
                                                                                                  +

                                                                                                  Original stack trace with no modifications

                                                                                                  +
                                                                                                  +
                                                                                                  + +
                                                                                                  stack?: string
                                                                                                  +
                                                                                                  + +
                                                                                                  statusCode?: number
                                                                                                  +

                                                                                                  HTTP status code from the error response, when available.

                                                                                                  +
                                                                                                  +
                                                                                                  + +
                                                                                                  zoneAwareStack?: string
                                                                                                  +

                                                                                                  Stack trace where extra frames have been removed and zone names added.

                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +

                                                                                                  Settings

                                                                                                   +
                                                                                                  +
                                                                                                  Member Visibility +
                                                                                                    +
                                                                                                    • +
                                                                                                    • +
                                                                                                  +
                                                                                                  +
                                                                                                  +

                                                                                                  On This Page

                                                                                                   +
                                                                                                  +
                                                                                                  Constructors +
                                                                                                  +
                                                                                                  Properties +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  diff --git a/docs/classes/PasskeyError.html b/docs/classes/PasskeyError.html index 405192e3..065dda0a 100644 --- a/docs/classes/PasskeyError.html +++ b/docs/classes/PasskeyError.html @@ -1,849 +1,129 @@ - - - - - - PasskeyError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                  -
                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                    -
                                                                                                    -
                                                                                                    Preparing search index...
                                                                                                    -
                                                                                                    -                                                                                                     - -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - -

                                                                                                    Class PasskeyError

                                                                                                    -
                                                                                                    -
                                                                                                    -

                                                                                                    Hierarchy

                                                                                                    -
                                                                                                      -
                                                                                                    • - Error -
                                                                                                        -
                                                                                                      • - PasskeyError -
                                                                                                        • -
                                                                                                      -
                                                                                                      • -
                                                                                                    -
                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                    - - -
                                                                                                    Index
                                                                                                    -                                                                                                     -
                                                                                                    -
                                                                                                    - -
                                                                                                    - - constructor -
                                                                                                    -
                                                                                                    -
                                                                                                    - -
                                                                                                    - - cause? - - code - - message - - name - - originalStack? - - stack? - - zoneAwareStack? -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - - - - -
                                                                                                    -
                                                                                                    - -
                                                                                                      -
                                                                                                    • - -
                                                                                                      -
                                                                                                      -

                                                                                                      Parameters

                                                                                                      - -
                                                                                                      -

                                                                                                      - Returns - PasskeyError -

                                                                                                      - -
                                                                                                      -
                                                                                                      • -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - - - - -
                                                                                                    -
                                                                                                    - -
                                                                                                    - cause?: - PasskeyErrorResponse -
                                                                                                    - -
                                                                                                    -
                                                                                                    - -
                                                                                                    - code: - string -
                                                                                                    - -
                                                                                                    -
                                                                                                    - -
                                                                                                    - message: - string -
                                                                                                    - -
                                                                                                    -
                                                                                                    - -
                                                                                                    - name: - string -
                                                                                                    - -
                                                                                                    -
                                                                                                    - -
                                                                                                    - originalStack?: - string -
                                                                                                    -
                                                                                                    -

                                                                                                    Original stack trace with no modifications

                                                                                                    -
                                                                                                    - -
                                                                                                    -
                                                                                                    - -
                                                                                                    - stack?: - string -
                                                                                                    - -
                                                                                                    -
                                                                                                    - -
                                                                                                    - zoneAwareStack?: - string -
                                                                                                    -
                                                                                                    -

                                                                                                    - Stack trace where extra frames have been removed and zone - names added. -

                                                                                                    -
                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - - -

                                                                                                    Settings

                                                                                                    -                                                                                                     -
                                                                                                    -
                                                                                                    - Member Visibility -
                                                                                                      -
                                                                                                    • - -
                                                                                                      • -
                                                                                                    • - -
                                                                                                      • -
                                                                                                    • - -
                                                                                                      • -
                                                                                                    -
                                                                                                    -
                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - - -

                                                                                                    On This Page

                                                                                                    -                                                                                                     -
                                                                                                    -
                                                                                                    - - Constructors - - -
                                                                                                    -
                                                                                                    - - Properties - - -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - - +PasskeyError | @auth0/auth0-angular
                                                                                                    +
                                                                                                    @auth0/auth0-angular + +
                                                                                                      +
                                                                                                      +
                                                                                                      Preparing search index...
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      + +

                                                                                                      Class PasskeyError

                                                                                                      +
                                                                                                      +

                                                                                                      Hierarchy

                                                                                                      +
                                                                                                        +
                                                                                                      • Error +
                                                                                                          +
                                                                                                        • PasskeyError
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      Index
                                                                                                       +
                                                                                                      +
                                                                                                      + +
                                                                                                      constructor +
                                                                                                      +
                                                                                                      + +
                                                                                                      cause? +code +message +name +originalStack? +stack? +zoneAwareStack? +
                                                                                                      +
                                                                                                      + +
                                                                                                      +
                                                                                                      + +
                                                                                                        +
                                                                                                      • + +
                                                                                                        +
                                                                                                        +

                                                                                                        Parameters

                                                                                                        +
                                                                                                        +

                                                                                                        Returns PasskeyError

                                                                                                      +
                                                                                                      + +
                                                                                                      +
                                                                                                      + +
                                                                                                      cause?: PasskeyErrorResponse
                                                                                                      +
                                                                                                      + +
                                                                                                      code: string
                                                                                                      +
                                                                                                      + +
                                                                                                      message: string
                                                                                                      +
                                                                                                      + +
                                                                                                      name: string
                                                                                                      +
                                                                                                      + +
                                                                                                      originalStack?: string
                                                                                                      +

                                                                                                      Original stack trace with no modifications

                                                                                                      +
                                                                                                      +
                                                                                                      + +
                                                                                                      stack?: string
                                                                                                      +
                                                                                                      + +
                                                                                                      zoneAwareStack?: string
                                                                                                      +

                                                                                                      Stack trace where extra frames have been removed and zone names added.

                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +

                                                                                                      Settings

                                                                                                       +
                                                                                                      +
                                                                                                      Member Visibility +
                                                                                                        +
                                                                                                        • +
                                                                                                        • +
                                                                                                      +
                                                                                                      +
                                                                                                      +

                                                                                                      On This Page

                                                                                                       +
                                                                                                      +
                                                                                                      Constructors +
                                                                                                      +
                                                                                                      Properties +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      diff --git a/docs/classes/PasskeyGetTokenError.html b/docs/classes/PasskeyGetTokenError.html index 0ef43a16..4c69c09b 100644 --- a/docs/classes/PasskeyGetTokenError.html +++ b/docs/classes/PasskeyGetTokenError.html @@ -1,1002 +1,162 @@ - - - - - - PasskeyGetTokenError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                      -
                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                        -
                                                                                                        -
                                                                                                        Preparing search index...
                                                                                                        -
                                                                                                        -                                                                                                         - -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - -

                                                                                                        Class PasskeyGetTokenError

                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -

                                                                                                        - Error thrown when exchanging a passkey credential for tokens - fails. -

                                                                                                        -

                                                                                                        - Unlike the challenge errors, this carries mfa_token / - mfa_requirements on its cause when the - server responds with mfa_required. -

                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -

                                                                                                        Hierarchy

                                                                                                        -
                                                                                                          -
                                                                                                        • - PasskeyError -
                                                                                                            -
                                                                                                          • - PasskeyGetTokenError -
                                                                                                            • -
                                                                                                          -
                                                                                                          • -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        -
                                                                                                        - - -
                                                                                                        Index
                                                                                                        -                                                                                                         -
                                                                                                        -
                                                                                                        - -
                                                                                                        - - constructor -
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        - - body? - - cause? - - code - - headers? - - message - - name - - originalStack? - - stack? - - statusCode? - - zoneAwareStack? -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - - - - -
                                                                                                        -
                                                                                                        - -
                                                                                                          -
                                                                                                        • - -
                                                                                                          -
                                                                                                          -

                                                                                                          Parameters

                                                                                                          -
                                                                                                            -
                                                                                                          • - message: - string -
                                                                                                            • -
                                                                                                          • - Optionalcause: - PasskeyGetTokenApiErrorResponse -
                                                                                                            • -
                                                                                                          -
                                                                                                          -

                                                                                                          - Returns - PasskeyGetTokenError -

                                                                                                          - -
                                                                                                          -
                                                                                                          • -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - Optionalbody -

                                                                                                        -
                                                                                                        - body?: - string -
                                                                                                        -
                                                                                                        -

                                                                                                        Raw response body text, when available.

                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - -
                                                                                                        - cause?: - PasskeyGetTokenApiErrorResponse -
                                                                                                        - -
                                                                                                        -
                                                                                                        - -
                                                                                                        - code: - string -
                                                                                                        - -
                                                                                                        -
                                                                                                        - -
                                                                                                        - headers?: - Headers -
                                                                                                        -
                                                                                                        -

                                                                                                        - Response headers from the error response, when available. - Native Fetch Headers. -

                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - -
                                                                                                        - message: - string -
                                                                                                        - -
                                                                                                        -
                                                                                                        - -
                                                                                                        - name: - string -
                                                                                                        - -
                                                                                                        -
                                                                                                        - -
                                                                                                        - originalStack?: - string -
                                                                                                        -
                                                                                                        -

                                                                                                        Original stack trace with no modifications

                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - -
                                                                                                        - stack?: - string -
                                                                                                        - -
                                                                                                        -
                                                                                                        - -
                                                                                                        - statusCode?: - number -
                                                                                                        -
                                                                                                        -

                                                                                                        HTTP status code from the error response, when available.

                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - -
                                                                                                        - zoneAwareStack?: - string -
                                                                                                        -
                                                                                                        -

                                                                                                        - Stack trace where extra frames have been removed and zone - names added. -

                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - - -

                                                                                                        Settings

                                                                                                        -                                                                                                         -
                                                                                                        -
                                                                                                        - Member Visibility -
                                                                                                          -
                                                                                                        • - -
                                                                                                          • -
                                                                                                        • - -
                                                                                                          • -
                                                                                                        • - -
                                                                                                          • -
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - - -

                                                                                                        On This Page

                                                                                                        -                                                                                                         -
                                                                                                        -
                                                                                                        - - Constructors - - -
                                                                                                        -
                                                                                                        - - Properties - - -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - - +PasskeyGetTokenError | @auth0/auth0-angular
                                                                                                        +
                                                                                                        @auth0/auth0-angular + +
                                                                                                          +
                                                                                                          +
                                                                                                          Preparing search index...
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          + +

                                                                                                          Class PasskeyGetTokenError

                                                                                                          +
                                                                                                          +

                                                                                                          Error thrown when exchanging a passkey credential for tokens fails.

                                                                                                          +

                                                                                                          Unlike the challenge errors, this carries mfa_token / mfa_requirements on +its cause when the server responds with mfa_required.

                                                                                                          +
                                                                                                          +
                                                                                                          +

                                                                                                          Hierarchy

                                                                                                          +
                                                                                                            +
                                                                                                          • PasskeyError +
                                                                                                              +
                                                                                                            • PasskeyGetTokenError
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          Index
                                                                                                           +
                                                                                                          +
                                                                                                          + +
                                                                                                          constructor +
                                                                                                          +
                                                                                                          + +
                                                                                                          body? +cause? +code +headers? +message +name +originalStack? +stack? +statusCode? +zoneAwareStack? +
                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          + +
                                                                                                            +
                                                                                                          • + +
                                                                                                            +
                                                                                                            +

                                                                                                            Parameters

                                                                                                            +
                                                                                                              +
                                                                                                            • message: string
                                                                                                              • +
                                                                                                            • Optionalcause: PasskeyGetTokenApiErrorResponse
                                                                                                            +

                                                                                                            Returns PasskeyGetTokenError

                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          +

                                                                                                          Optionalbody

                                                                                                          +
                                                                                                          body?: string
                                                                                                          +

                                                                                                          Raw response body text, when available.

                                                                                                          +
                                                                                                          +
                                                                                                          + +
                                                                                                          cause?: PasskeyGetTokenApiErrorResponse
                                                                                                          +
                                                                                                          + +
                                                                                                          code: string
                                                                                                          +
                                                                                                          + +
                                                                                                          headers?: Headers
                                                                                                          +

                                                                                                          Response headers from the error response, when available. Native Fetch Headers.

                                                                                                          +
                                                                                                          +
                                                                                                          + +
                                                                                                          message: string
                                                                                                          +
                                                                                                          + +
                                                                                                          name: string
                                                                                                          +
                                                                                                          + +
                                                                                                          originalStack?: string
                                                                                                          +

                                                                                                          Original stack trace with no modifications

                                                                                                          +
                                                                                                          +
                                                                                                          + +
                                                                                                          stack?: string
                                                                                                          +
                                                                                                          + +
                                                                                                          statusCode?: number
                                                                                                          +

                                                                                                          HTTP status code from the error response, when available.

                                                                                                          +
                                                                                                          +
                                                                                                          + +
                                                                                                          zoneAwareStack?: string
                                                                                                          +

                                                                                                          Stack trace where extra frames have been removed and zone names added.

                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +

                                                                                                          Settings

                                                                                                           +
                                                                                                          +
                                                                                                          Member Visibility +
                                                                                                            +
                                                                                                            • +
                                                                                                            • +
                                                                                                          +
                                                                                                          +
                                                                                                          +

                                                                                                          On This Page

                                                                                                           +
                                                                                                          +
                                                                                                          Constructors +
                                                                                                          +
                                                                                                          Properties +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          diff --git a/docs/classes/PasskeyRegisterError.html b/docs/classes/PasskeyRegisterError.html index 09c68a16..31a547bc 100644 --- a/docs/classes/PasskeyRegisterError.html +++ b/docs/classes/PasskeyRegisterError.html @@ -1,998 +1,160 @@ - - - - - - PasskeyRegisterError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                          -
                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                            -
                                                                                                            -
                                                                                                            Preparing search index...
                                                                                                            -
                                                                                                            -                                                                                                             - -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            - -

                                                                                                            Class PasskeyRegisterError

                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -

                                                                                                            - Error thrown when requesting a passkey register challenge fails. -

                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -

                                                                                                            Hierarchy

                                                                                                            -
                                                                                                              -
                                                                                                            • - PasskeyError -
                                                                                                                -
                                                                                                              • - PasskeyRegisterError -
                                                                                                                • -
                                                                                                              -
                                                                                                              • -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            -
                                                                                                            - - -
                                                                                                            Index
                                                                                                            -                                                                                                             -
                                                                                                            -
                                                                                                            - -
                                                                                                            - - constructor -
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            - - body? - - cause? - - code - - headers? - - message - - name - - originalStack? - - stack? - - statusCode? - - zoneAwareStack? -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            - - - - -
                                                                                                            -
                                                                                                            - -
                                                                                                              -
                                                                                                            • - -
                                                                                                              -
                                                                                                              -

                                                                                                              Parameters

                                                                                                              -
                                                                                                                -
                                                                                                              • - message: - string -
                                                                                                                • -
                                                                                                              • - Optionalcause: - PasskeyApiErrorResponse -
                                                                                                                • -
                                                                                                              -
                                                                                                              -

                                                                                                              - Returns - PasskeyRegisterError -

                                                                                                              - -
                                                                                                              -
                                                                                                              • -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            - - - - -
                                                                                                            -
                                                                                                            -

                                                                                                            - Optionalbody -

                                                                                                            -
                                                                                                            - body?: - string -
                                                                                                            -
                                                                                                            -

                                                                                                            Raw response body text, when available.

                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - -
                                                                                                            - cause?: - PasskeyApiErrorResponse -
                                                                                                            - -
                                                                                                            -
                                                                                                            - -
                                                                                                            - code: - string -
                                                                                                            - -
                                                                                                            -
                                                                                                            - -
                                                                                                            - headers?: - Headers -
                                                                                                            -
                                                                                                            -

                                                                                                            - Response headers from the error response, when available. - Native Fetch Headers. -

                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - -
                                                                                                            - message: - string -
                                                                                                            - -
                                                                                                            -
                                                                                                            - -
                                                                                                            - name: - string -
                                                                                                            - -
                                                                                                            -
                                                                                                            - -
                                                                                                            - originalStack?: - string -
                                                                                                            -
                                                                                                            -

                                                                                                            Original stack trace with no modifications

                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - -
                                                                                                            - stack?: - string -
                                                                                                            - -
                                                                                                            -
                                                                                                            - -
                                                                                                            - statusCode?: - number -
                                                                                                            -
                                                                                                            -

                                                                                                            HTTP status code from the error response, when available.

                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - -
                                                                                                            - zoneAwareStack?: - string -
                                                                                                            -
                                                                                                            -

                                                                                                            - Stack trace where extra frames have been removed and zone - names added. -

                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            - - -

                                                                                                            Settings

                                                                                                            -                                                                                                             -
                                                                                                            -
                                                                                                            - Member Visibility -
                                                                                                              -
                                                                                                            • - -
                                                                                                              • -
                                                                                                            • - -
                                                                                                              • -
                                                                                                            • - -
                                                                                                              • -
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            - - -

                                                                                                            On This Page

                                                                                                            -                                                                                                             -
                                                                                                            -
                                                                                                            - - Constructors - - -
                                                                                                            -
                                                                                                            - - Properties - - -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            - - +PasskeyRegisterError | @auth0/auth0-angular
                                                                                                            +
                                                                                                            @auth0/auth0-angular + +
                                                                                                              +
                                                                                                              +
                                                                                                              Preparing search index...
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              + +

                                                                                                              Class PasskeyRegisterError

                                                                                                              +
                                                                                                              +

                                                                                                              Error thrown when requesting a passkey register challenge fails.

                                                                                                              +
                                                                                                              +
                                                                                                              +

                                                                                                              Hierarchy

                                                                                                              +
                                                                                                                +
                                                                                                              • PasskeyError +
                                                                                                                  +
                                                                                                                • PasskeyRegisterError
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              Index
                                                                                                               +
                                                                                                              +
                                                                                                              + +
                                                                                                              constructor +
                                                                                                              +
                                                                                                              + +
                                                                                                              body? +cause? +code +headers? +message +name +originalStack? +stack? +statusCode? +zoneAwareStack? +
                                                                                                              +
                                                                                                              + +
                                                                                                              +
                                                                                                              + +
                                                                                                                +
                                                                                                              • + +
                                                                                                                +
                                                                                                                +

                                                                                                                Parameters

                                                                                                                +
                                                                                                                  +
                                                                                                                • message: string
                                                                                                                  • +
                                                                                                                • Optionalcause: PasskeyApiErrorResponse
                                                                                                                +

                                                                                                                Returns PasskeyRegisterError

                                                                                                              +
                                                                                                              + +
                                                                                                              +
                                                                                                              +

                                                                                                              Optionalbody

                                                                                                              +
                                                                                                              body?: string
                                                                                                              +

                                                                                                              Raw response body text, when available.

                                                                                                              +
                                                                                                              +
                                                                                                              + +
                                                                                                              cause?: PasskeyApiErrorResponse
                                                                                                              +
                                                                                                              + +
                                                                                                              code: string
                                                                                                              +
                                                                                                              + +
                                                                                                              headers?: Headers
                                                                                                              +

                                                                                                              Response headers from the error response, when available. Native Fetch Headers.

                                                                                                              +
                                                                                                              +
                                                                                                              + +
                                                                                                              message: string
                                                                                                              +
                                                                                                              + +
                                                                                                              name: string
                                                                                                              +
                                                                                                              + +
                                                                                                              originalStack?: string
                                                                                                              +

                                                                                                              Original stack trace with no modifications

                                                                                                              +
                                                                                                              +
                                                                                                              + +
                                                                                                              stack?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              statusCode?: number
                                                                                                              +

                                                                                                              HTTP status code from the error response, when available.

                                                                                                              +
                                                                                                              +
                                                                                                              + +
                                                                                                              zoneAwareStack?: string
                                                                                                              +

                                                                                                              Stack trace where extra frames have been removed and zone names added.

                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +

                                                                                                              Settings

                                                                                                               +
                                                                                                              +
                                                                                                              Member Visibility +
                                                                                                                +
                                                                                                                • +
                                                                                                                • +
                                                                                                              +
                                                                                                              +
                                                                                                              +

                                                                                                              On This Page

                                                                                                               +
                                                                                                              +
                                                                                                              Constructors +
                                                                                                              +
                                                                                                              Properties +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              diff --git a/docs/classes/PopupCancelledError.html b/docs/classes/PopupCancelledError.html index 5dd06457..cb33e6ae 100644 --- a/docs/classes/PopupCancelledError.html +++ b/docs/classes/PopupCancelledError.html @@ -1,1092 +1,161 @@ - - - - - - PopupCancelledError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                              -
                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                -
                                                                                                                -
                                                                                                                Preparing search index...
                                                                                                                -
                                                                                                                -                                                                                                                 - -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                - -

                                                                                                                Class PopupCancelledError

                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -

                                                                                                                Thrown when network requests to the Auth server fail.

                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -

                                                                                                                - Hierarchy (View Summary) -

                                                                                                                - -
                                                                                                                - -
                                                                                                                -
                                                                                                                -
                                                                                                                - - -
                                                                                                                Index
                                                                                                                -                                                                                                                 -
                                                                                                                -
                                                                                                                - -
                                                                                                                - - constructor -
                                                                                                                -
                                                                                                                -
                                                                                                                - -
                                                                                                                - - error - - error_description - - message - - name - - originalStack? - - popup - - stack? - - zoneAwareStack? -
                                                                                                                -
                                                                                                                -
                                                                                                                - -
                                                                                                                - - fromPayload -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                - - - - -
                                                                                                                -
                                                                                                                - - -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                - - - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                - error: - string -
                                                                                                                - -
                                                                                                                -
                                                                                                                - -
                                                                                                                - error_description: - string -
                                                                                                                - -
                                                                                                                -
                                                                                                                - -
                                                                                                                - message: - string -
                                                                                                                - -
                                                                                                                -
                                                                                                                - -
                                                                                                                - name: - string -
                                                                                                                - -
                                                                                                                -
                                                                                                                - -
                                                                                                                - originalStack?: - string -
                                                                                                                -
                                                                                                                -

                                                                                                                Original stack trace with no modifications

                                                                                                                -
                                                                                                                - -
                                                                                                                -
                                                                                                                - -
                                                                                                                - popup: - Window -
                                                                                                                - -
                                                                                                                -
                                                                                                                - -
                                                                                                                - stack?: - string -
                                                                                                                - -
                                                                                                                -
                                                                                                                - -
                                                                                                                - zoneAwareStack?: - string -
                                                                                                                -
                                                                                                                -

                                                                                                                - Stack trace where extra frames have been removed and zone - names added. -

                                                                                                                -
                                                                                                                - -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                - - - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                  -
                                                                                                                • - -
                                                                                                                  -
                                                                                                                  -

                                                                                                                  Parameters

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

                                                                                                                  - Returns - GenericError -

                                                                                                                  - -
                                                                                                                  -
                                                                                                                  • -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                - - -

                                                                                                                Settings

                                                                                                                -                                                                                                                 -
                                                                                                                -
                                                                                                                - Member Visibility -
                                                                                                                  -
                                                                                                                • - -
                                                                                                                  • -
                                                                                                                • - -
                                                                                                                  • -
                                                                                                                • - -
                                                                                                                  • -
                                                                                                                -
                                                                                                                -
                                                                                                                - -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                - - -

                                                                                                                On This Page

                                                                                                                -                                                                                                                 -
                                                                                                                -
                                                                                                                - - Constructors - - -
                                                                                                                -
                                                                                                                - - Properties - - -
                                                                                                                -
                                                                                                                - - Methods - - -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                - -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                - - +PopupCancelledError | @auth0/auth0-angular
                                                                                                                +
                                                                                                                @auth0/auth0-angular + +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Preparing search index...
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  + +

                                                                                                                  Class PopupCancelledError

                                                                                                                  +
                                                                                                                  +

                                                                                                                  Thrown when network requests to the Auth server fail.

                                                                                                                  +
                                                                                                                  +
                                                                                                                  +

                                                                                                                  Hierarchy (View Summary)

                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Index
                                                                                                                   +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  constructor +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  error +error_description +message +name +originalStack? +popup +stack? +zoneAwareStack? +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  fromPayload +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  error: string
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  error_description: string
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  message: string
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  name: string
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  originalStack?: string
                                                                                                                  +

                                                                                                                  Original stack trace with no modifications

                                                                                                                  +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  popup: Window
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  stack?: string
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  zoneAwareStack?: string
                                                                                                                  +

                                                                                                                  Stack trace where extra frames have been removed and zone names added.

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

                                                                                                                    Parameters

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

                                                                                                                    Returns GenericError

                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +

                                                                                                                  Settings

                                                                                                                   +
                                                                                                                  +
                                                                                                                  Member Visibility +
                                                                                                                    +
                                                                                                                    • +
                                                                                                                    • +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +

                                                                                                                  On This Page

                                                                                                                   +
                                                                                                                  +
                                                                                                                  Constructors +
                                                                                                                  +
                                                                                                                  Properties +
                                                                                                                  +
                                                                                                                  Methods +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  diff --git a/docs/classes/PopupOpenError.html b/docs/classes/PopupOpenError.html index 61112cd2..d5301ca6 100644 --- a/docs/classes/PopupOpenError.html +++ b/docs/classes/PopupOpenError.html @@ -1,1038 +1,151 @@ - - - - - - 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
                                                                                                                    -                                                                                                                     -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    - - constructor -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    - - error - - error_description - - message - - name - - originalStack? - - stack? - - zoneAwareStack? -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    - - fromPayload -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - - - - -
                                                                                                                    -
                                                                                                                    - - -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - - - - -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    - error: - string -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    - error_description: - string -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    - message: - string -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    - name: - string -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    - originalStack?: - string -
                                                                                                                    -
                                                                                                                    -

                                                                                                                    Original stack trace with no modifications

                                                                                                                    -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    - stack?: - string -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    - zoneAwareStack?: - string -
                                                                                                                    -
                                                                                                                    -

                                                                                                                    - Stack trace where extra frames have been removed and zone - names added. -

                                                                                                                    -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - - - - -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                      -
                                                                                                                    • - -
                                                                                                                      -
                                                                                                                      -

                                                                                                                      Parameters

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

                                                                                                                      - Returns - GenericError -

                                                                                                                      - -
                                                                                                                      -
                                                                                                                      • -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - - -

                                                                                                                    Settings

                                                                                                                    -                                                                                                                     -
                                                                                                                    -
                                                                                                                    - Member Visibility -
                                                                                                                      -
                                                                                                                    • - -
                                                                                                                      • -
                                                                                                                    • - -
                                                                                                                      • -
                                                                                                                    • - -
                                                                                                                      • -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - - -

                                                                                                                    On This Page

                                                                                                                    -                                                                                                                     -
                                                                                                                    -
                                                                                                                    - - Constructors - - -
                                                                                                                    -
                                                                                                                    - - Properties - - -
                                                                                                                    -
                                                                                                                    - - Methods - - -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - - +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
                                                                                                                       +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      constructor +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      error +error_description +message +name +originalStack? +stack? +zoneAwareStack? +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      fromPayload +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      error: string
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      error_description: string
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      message: string
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      name: string
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      originalStack?: string
                                                                                                                      +

                                                                                                                      Original stack trace with no modifications

                                                                                                                      +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      stack?: string
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      zoneAwareStack?: string
                                                                                                                      +

                                                                                                                      Stack trace where extra frames have been removed and zone names added.

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

                                                                                                                        Parameters

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

                                                                                                                        Returns GenericError

                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +

                                                                                                                      Settings

                                                                                                                       +
                                                                                                                      +
                                                                                                                      Member Visibility +
                                                                                                                        +
                                                                                                                        • +
                                                                                                                        • +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +

                                                                                                                      On This Page

                                                                                                                       +
                                                                                                                      +
                                                                                                                      Constructors +
                                                                                                                      +
                                                                                                                      Properties +
                                                                                                                      +
                                                                                                                      Methods +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      diff --git a/docs/classes/PopupTimeoutError.html b/docs/classes/PopupTimeoutError.html index 392e83c8..70bfde1c 100644 --- a/docs/classes/PopupTimeoutError.html +++ b/docs/classes/PopupTimeoutError.html @@ -1,1095 +1,161 @@ - - - - - - PopupTimeoutError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                      -
                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        Preparing search index...
                                                                                                                        -
                                                                                                                        -                                                                                                                         - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - -

                                                                                                                        Class PopupTimeoutError

                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        - Error thrown when the login popup times out (if the user does not - complete auth) -

                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        - Hierarchy (View Summary) -

                                                                                                                        - -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - - -
                                                                                                                        Index
                                                                                                                        -                                                                                                                         -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - - constructor -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - - error - - error_description - - message - - name - - originalStack? - - popup - - stack? - - zoneAwareStack? -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - - fromPayload -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - - - - -
                                                                                                                        -
                                                                                                                        - - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - - - - -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - error: - string -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - error_description: - string -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - message: - string -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - name: - string -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - originalStack?: - string -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        Original stack trace with no modifications

                                                                                                                        -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - popup: - Window -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - stack?: - string -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - zoneAwareStack?: - string -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        - Stack trace where extra frames have been removed and zone - names added. -

                                                                                                                        -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - - - - -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                          -
                                                                                                                        • - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          Parameters

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

                                                                                                                          - Returns - GenericError -

                                                                                                                          - -
                                                                                                                          -
                                                                                                                          • -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - - -

                                                                                                                        Settings

                                                                                                                        -                                                                                                                         -
                                                                                                                        -
                                                                                                                        - Member Visibility -
                                                                                                                          -
                                                                                                                        • - -
                                                                                                                          • -
                                                                                                                        • - -
                                                                                                                          • -
                                                                                                                        • - -
                                                                                                                          • -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - - -

                                                                                                                        On This Page

                                                                                                                        -                                                                                                                         -
                                                                                                                        -
                                                                                                                        - - Constructors - - -
                                                                                                                        -
                                                                                                                        - - Properties - - -
                                                                                                                        -
                                                                                                                        - - Methods - - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - - +PopupTimeoutError | @auth0/auth0-angular
                                                                                                                        +
                                                                                                                        @auth0/auth0-angular + +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          Preparing search index...
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          + +

                                                                                                                          Class PopupTimeoutError

                                                                                                                          +
                                                                                                                          +

                                                                                                                          Error thrown when the login popup times out (if the user does not complete auth)

                                                                                                                          +
                                                                                                                          +
                                                                                                                          +

                                                                                                                          Hierarchy (View Summary)

                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          Index
                                                                                                                           +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          constructor +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          error +error_description +message +name +originalStack? +popup +stack? +zoneAwareStack? +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          fromPayload +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          error: string
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          error_description: string
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          message: string
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          name: string
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          originalStack?: string
                                                                                                                          +

                                                                                                                          Original stack trace with no modifications

                                                                                                                          +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          popup: Window
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          stack?: string
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          zoneAwareStack?: string
                                                                                                                          +

                                                                                                                          Stack trace where extra frames have been removed and zone names added.

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

                                                                                                                            Parameters

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

                                                                                                                            Returns GenericError

                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +

                                                                                                                          Settings

                                                                                                                           +
                                                                                                                          +
                                                                                                                          Member Visibility +
                                                                                                                            +
                                                                                                                            • +
                                                                                                                            • +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +

                                                                                                                          On This Page

                                                                                                                           +
                                                                                                                          +
                                                                                                                          Constructors +
                                                                                                                          +
                                                                                                                          Properties +
                                                                                                                          +
                                                                                                                          Methods +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html index d6f662a8..865ba641 100644 --- a/docs/classes/TimeoutError.html +++ b/docs/classes/TimeoutError.html @@ -1,1049 +1,154 @@ - - - - - - TimeoutError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            Preparing search index...
                                                                                                                            -
                                                                                                                            -                                                                                                                             - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - -

                                                                                                                            Class TimeoutError

                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            - Thrown when silent auth times out (usually due to a configuration - issue) or when network requests to the Auth server timeout. -

                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            - Hierarchy (View Summary) -

                                                                                                                            - -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            Index
                                                                                                                            -                                                                                                                             -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            - - constructor -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            - - error - - error_description - - message - - name - - originalStack? - - stack? - - zoneAwareStack? -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            - - fromPayload -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - - - - -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            - error: - string -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            - error_description: - string -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            - message: - string -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            - name: - string -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            - originalStack?: - string -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            Original stack trace with no modifications

                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            - stack?: - string -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            - zoneAwareStack?: - string -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            - Stack trace where extra frames have been removed and zone - names added. -

                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - - - - -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                              -
                                                                                                                            • - -
                                                                                                                              -
                                                                                                                              -

                                                                                                                              Parameters

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

                                                                                                                              - Returns - GenericError -

                                                                                                                              - -
                                                                                                                              -
                                                                                                                              • -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - - -

                                                                                                                            Settings

                                                                                                                            -                                                                                                                             -
                                                                                                                            -
                                                                                                                            - Member Visibility -
                                                                                                                              -
                                                                                                                            • - -
                                                                                                                              • -
                                                                                                                            • - -
                                                                                                                              • -
                                                                                                                            • - -
                                                                                                                              • -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - - -

                                                                                                                            On This Page

                                                                                                                            -                                                                                                                             -
                                                                                                                            -
                                                                                                                            - - Constructors - - -
                                                                                                                            -
                                                                                                                            - - Properties - - -
                                                                                                                            -
                                                                                                                            - - Methods - - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - - +TimeoutError | @auth0/auth0-angular
                                                                                                                            +
                                                                                                                            @auth0/auth0-angular + +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Preparing search index...
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              + +

                                                                                                                              Class TimeoutError

                                                                                                                              +
                                                                                                                              +

                                                                                                                              Thrown when silent auth times out (usually due to a configuration issue) or +when network requests to the Auth server timeout.

                                                                                                                              +
                                                                                                                              +
                                                                                                                              +

                                                                                                                              Hierarchy (View Summary)

                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Index
                                                                                                                               +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              constructor +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              error +error_description +message +name +originalStack? +stack? +zoneAwareStack? +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              fromPayload +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              error: string
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              error_description: string
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              message: string
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              name: string
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              originalStack?: string
                                                                                                                              +

                                                                                                                              Original stack trace with no modifications

                                                                                                                              +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              stack?: string
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              zoneAwareStack?: string
                                                                                                                              +

                                                                                                                              Stack trace where extra frames have been removed and zone names added.

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

                                                                                                                                Parameters

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

                                                                                                                                Returns GenericError

                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +

                                                                                                                              Settings

                                                                                                                               +
                                                                                                                              +
                                                                                                                              Member Visibility +
                                                                                                                                +
                                                                                                                                • +
                                                                                                                                • +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +

                                                                                                                              On This Page

                                                                                                                               +
                                                                                                                              +
                                                                                                                              Constructors +
                                                                                                                              +
                                                                                                                              Properties +
                                                                                                                              +
                                                                                                                              Methods +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              diff --git a/docs/classes/UseDpopNonceError.html b/docs/classes/UseDpopNonceError.html index 021ed505..12843de8 100644 --- a/docs/classes/UseDpopNonceError.html +++ b/docs/classes/UseDpopNonceError.html @@ -1,1108 +1,161 @@ - - - - - - UseDpopNonceError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                              -
                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                Preparing search index...
                                                                                                                                -
                                                                                                                                -                                                                                                                                 - -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - -

                                                                                                                                Class UseDpopNonceError

                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -

                                                                                                                                - Error thrown when the wrong DPoP nonce is used and a potential - subsequent retry wasn't able to fix it. -

                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -

                                                                                                                                - Hierarchy (View Summary) -

                                                                                                                                - -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - - -
                                                                                                                                Index
                                                                                                                                -                                                                                                                                 -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                - - constructor -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                - - error - - error_description - - message - - name - - newDpopNonce - - originalStack? - - stack? - - zoneAwareStack? -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                - - fromPayload -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - - - - -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                  -
                                                                                                                                • - -
                                                                                                                                  -
                                                                                                                                  -

                                                                                                                                  Parameters

                                                                                                                                  -
                                                                                                                                    -
                                                                                                                                  • - newDpopNonce: string - | - undefined -
                                                                                                                                    • -
                                                                                                                                  -
                                                                                                                                  -

                                                                                                                                  - Returns - UseDpopNonceError -

                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  • -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - - - - -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                - error: - string -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                - error_description: - string -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                - message: - string -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                - name: - string -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                - newDpopNonce: - string - | - undefined -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                - originalStack?: - string -
                                                                                                                                -
                                                                                                                                -

                                                                                                                                Original stack trace with no modifications

                                                                                                                                -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                - stack?: - string -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                - zoneAwareStack?: - string -
                                                                                                                                -
                                                                                                                                -

                                                                                                                                - Stack trace where extra frames have been removed and zone - names added. -

                                                                                                                                -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - - - - -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                  -
                                                                                                                                • - -
                                                                                                                                  -
                                                                                                                                  -

                                                                                                                                  Parameters

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

                                                                                                                                  - Returns - GenericError -

                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  • -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - - -

                                                                                                                                Settings

                                                                                                                                -                                                                                                                                 -
                                                                                                                                -
                                                                                                                                - Member Visibility -
                                                                                                                                  -
                                                                                                                                • - -
                                                                                                                                  • -
                                                                                                                                • - -
                                                                                                                                  • -
                                                                                                                                • - -
                                                                                                                                  • -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - - -

                                                                                                                                On This Page

                                                                                                                                -                                                                                                                                 -
                                                                                                                                -
                                                                                                                                - - Constructors - - -
                                                                                                                                -
                                                                                                                                - - Properties - - -
                                                                                                                                -
                                                                                                                                - - Methods - - -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - - +UseDpopNonceError | @auth0/auth0-angular
                                                                                                                                +
                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  Preparing search index...
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  + +

                                                                                                                                  Class UseDpopNonceError

                                                                                                                                  +
                                                                                                                                  +

                                                                                                                                  Error thrown when the wrong DPoP nonce is used and a potential subsequent retry wasn't able to fix it.

                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +

                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  Index
                                                                                                                                   +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  constructor +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  error +error_description +message +name +newDpopNonce +originalStack? +stack? +zoneAwareStack? +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  fromPayload +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  error: string
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  error_description: string
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  message: string
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  name: string
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  newDpopNonce: string | undefined
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  originalStack?: string
                                                                                                                                  +

                                                                                                                                  Original stack trace with no modifications

                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  stack?: string
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  zoneAwareStack?: string
                                                                                                                                  +

                                                                                                                                  Stack trace where extra frames have been removed and zone names added.

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

                                                                                                                                    Parameters

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

                                                                                                                                    Returns GenericError

                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +

                                                                                                                                  Settings

                                                                                                                                   +
                                                                                                                                  +
                                                                                                                                  Member Visibility +
                                                                                                                                    +
                                                                                                                                    • +
                                                                                                                                    • +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +

                                                                                                                                  On This Page

                                                                                                                                   +
                                                                                                                                  +
                                                                                                                                  Constructors +
                                                                                                                                  +
                                                                                                                                  Properties +
                                                                                                                                  +
                                                                                                                                  Methods +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  diff --git a/docs/classes/User.html b/docs/classes/User.html index 2dcc0799..80fe4ee1 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -1,1363 +1,194 @@ - - - - - - User | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                  -
                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    Preparing search index...
                                                                                                                                    -
                                                                                                                                    -                                                                                                                                     - -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - -

                                                                                                                                    Class User

                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    Indexable

                                                                                                                                    -
                                                                                                                                      -
                                                                                                                                    • -
                                                                                                                                      - [key: - string]: - any -
                                                                                                                                      -
                                                                                                                                      • -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    Index
                                                                                                                                    -                                                                                                                                     -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - - constructor -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - - act? - - address? - - birthdate? - - email? - - email_verified? - - family_name? - - gender? - - given_name? - - locale? - - middle_name? - - name? - - nickname? - - phone_number? - - phone_number_verified? - - picture? - - preferred_username? - - profile? - - sub? - - updated_at? - - website? - - zoneinfo? -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - - - - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                      -
                                                                                                                                    • - -
                                                                                                                                      -

                                                                                                                                      - Returns - User -

                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      • -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - - - - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - act?: - ActClaim -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - address?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - birthdate?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - email?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - email_verified?: - boolean -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - family_name?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - gender?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - given_name?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - locale?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - middle_name?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - name?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - nickname?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - phone_number?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - phone_number_verified?: - boolean -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - picture?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - preferred_username?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - profile?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - sub?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - updated_at?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - website?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - zoneinfo?: - string -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - - -

                                                                                                                                    Settings

                                                                                                                                    -                                                                                                                                     -
                                                                                                                                    -
                                                                                                                                    - Member Visibility -
                                                                                                                                      -
                                                                                                                                    • - -
                                                                                                                                      • -
                                                                                                                                    • - -
                                                                                                                                      • -
                                                                                                                                    • - -
                                                                                                                                      • -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - - -

                                                                                                                                    On This Page

                                                                                                                                    -                                                                                                                                     -
                                                                                                                                    -
                                                                                                                                    - - Constructors - - -
                                                                                                                                    -
                                                                                                                                    - - Properties - - -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - - +User | @auth0/auth0-angular
                                                                                                                                    +
                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Preparing search index...
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      + +

                                                                                                                                      Class User

                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      Indexable

                                                                                                                                      +
                                                                                                                                        +
                                                                                                                                      • +
                                                                                                                                        [key: string]: any
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Index
                                                                                                                                       +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      constructor +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      act? +address? +birthdate? +email? +email_verified? +family_name? +gender? +given_name? +locale? +middle_name? +name? +nickname? +phone_number? +phone_number_verified? +picture? +preferred_username? +profile? +sub? +updated_at? +website? +zoneinfo? +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      act?: ActClaim
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      address?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      birthdate?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      email?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      email_verified?: boolean
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      family_name?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      gender?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      given_name?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      locale?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      middle_name?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      name?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      nickname?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      phone_number?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      phone_number_verified?: boolean
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      picture?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      preferred_username?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      profile?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      sub?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      updated_at?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      website?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      zoneinfo?: string
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      Settings

                                                                                                                                       +
                                                                                                                                      +
                                                                                                                                      Member Visibility +
                                                                                                                                        +
                                                                                                                                        • +
                                                                                                                                        • +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      On This Page

                                                                                                                                       +
                                                                                                                                      +
                                                                                                                                      Constructors +
                                                                                                                                      +
                                                                                                                                      Properties +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      diff --git a/docs/enums/HttpMethod.html b/docs/enums/HttpMethod.html index 4f6ec132..cfb7c43a 100644 --- a/docs/enums/HttpMethod.html +++ b/docs/enums/HttpMethod.html @@ -1,606 +1,86 @@ - - - - - - HttpMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                      -
                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        Preparing search index...
                                                                                                                                        -
                                                                                                                                        -                                                                                                                                         - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -

                                                                                                                                        Enumeration HttpMethodConst

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Defines a common set of HTTP methods.

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        Index
                                                                                                                                        -                                                                                                                                         -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        - - Delete - - Get - - Head - - Patch - - Post - - Put -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - - - -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        - Delete: - "DELETE" -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        - Get: - "GET" -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        - Head: - "HEAD" -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        - Patch: - "PATCH" -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        - Post -

                                                                                                                                        -
                                                                                                                                        - Post: - "POST" -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        - Put: - "PUT" -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - -

                                                                                                                                        Settings

                                                                                                                                        -                                                                                                                                         -
                                                                                                                                        -
                                                                                                                                        - Member Visibility -
                                                                                                                                          -
                                                                                                                                        • - -
                                                                                                                                          • -
                                                                                                                                        • - -
                                                                                                                                          • -
                                                                                                                                        • - -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - -

                                                                                                                                        On This Page

                                                                                                                                        -                                                                                                                                         -
                                                                                                                                        -
                                                                                                                                        - - Enumeration Members - - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - +HttpMethod | @auth0/auth0-angular
                                                                                                                                        +
                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Preparing search index...
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + +

                                                                                                                                          Enumeration HttpMethodConst

                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          Defines a common set of HTTP methods.

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Index
                                                                                                                                           +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          Delete +Get +Head +Patch +Post +Put +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          Delete: "DELETE"
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          Get: "GET"
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          Head: "HEAD"
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          Patch: "PATCH"
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          Post

                                                                                                                                          +
                                                                                                                                          Post: "POST"
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          Put: "PUT"
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          Settings

                                                                                                                                           +
                                                                                                                                          +
                                                                                                                                          Member Visibility +
                                                                                                                                            +
                                                                                                                                            • +
                                                                                                                                            • +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          On This Page

                                                                                                                                           +
                                                                                                                                          +
                                                                                                                                          Enumeration Members +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          diff --git a/docs/enums/ResponseType.html b/docs/enums/ResponseType.html index dd142c9b..6e8b5b0a 100644 --- a/docs/enums/ResponseType.html +++ b/docs/enums/ResponseType.html @@ -1,439 +1,66 @@ - - - - - - ResponseType | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                          -
                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            Preparing search index...
                                                                                                                                            -
                                                                                                                                            -                                                                                                                                             - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            Enumeration ResponseType

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - The types of responses expected from the authorization server. -

                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                            • code: used for the standard login flow.
                                                                                                                                              • -
                                                                                                                                            • - connect_code: used for the connect account flow. -
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            Index
                                                                                                                                            -                                                                                                                                             -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - - Code - - ConnectCode -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - - - - -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - Code: - "code" -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - ConnectCode: - "connect_code" -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - - -

                                                                                                                                            Settings

                                                                                                                                            -                                                                                                                                             -
                                                                                                                                            -
                                                                                                                                            - Member Visibility -
                                                                                                                                              -
                                                                                                                                            • - -
                                                                                                                                              • -
                                                                                                                                            • - -
                                                                                                                                              • -
                                                                                                                                            • - -
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - - -

                                                                                                                                            On This Page

                                                                                                                                            -                                                                                                                                             -
                                                                                                                                            -
                                                                                                                                            - - Enumeration Members - - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - - +ResponseType | @auth0/auth0-angular
                                                                                                                                            +
                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              Preparing search index...
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              + +

                                                                                                                                              Enumeration ResponseType

                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              The types of responses expected from the authorization server.

                                                                                                                                              +
                                                                                                                                                +
                                                                                                                                              • code: used for the standard login flow.
                                                                                                                                                • +
                                                                                                                                              • connect_code: used for the connect account flow.
                                                                                                                                                • +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              Index
                                                                                                                                               +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              Code +ConnectCode +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              Code: "code"
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              ConnectCode: "connect_code"
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              Settings

                                                                                                                                               +
                                                                                                                                              +
                                                                                                                                              Member Visibility +
                                                                                                                                                +
                                                                                                                                                • +
                                                                                                                                                • +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              On This Page

                                                                                                                                               +
                                                                                                                                              +
                                                                                                                                              Enumeration Members +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              diff --git a/docs/functions/authGuardFn.html b/docs/functions/authGuardFn.html index 93c9a788..4a2190c2 100644 --- a/docs/functions/authGuardFn.html +++ b/docs/functions/authGuardFn.html @@ -1,334 +1,50 @@ - - - - - - authGuardFn | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                              -
                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                Preparing search index...
                                                                                                                                                -
                                                                                                                                                -                                                                                                                                                 - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                - -

                                                                                                                                                Function authGuardFn

                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                  -
                                                                                                                                                • - -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  - Functional AuthGuard to ensure routes can only be accessed - when authenticated. -

                                                                                                                                                  -

                                                                                                                                                  Note: Should only be used as of Angular 15

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  Parameters

                                                                                                                                                  -
                                                                                                                                                    -
                                                                                                                                                  • - route: - ActivatedRouteSnapshot -
                                                                                                                                                    -

                                                                                                                                                    - Contains the information about a route associated with - a component loaded in an outlet at a particular moment - in time. -

                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    • -
                                                                                                                                                  • - state: - RouterStateSnapshot -
                                                                                                                                                    -

                                                                                                                                                    - Represents the state of the router at a moment in - time. -

                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  - Returns Observable<boolean> -

                                                                                                                                                  -

                                                                                                                                                  - An Observable, indicating if the route can be accessed or not -

                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  • -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                - - -

                                                                                                                                                Settings

                                                                                                                                                -                                                                                                                                                 -
                                                                                                                                                -
                                                                                                                                                - Member Visibility -
                                                                                                                                                  -
                                                                                                                                                • - -
                                                                                                                                                  • -
                                                                                                                                                • - -
                                                                                                                                                  • -
                                                                                                                                                • - -
                                                                                                                                                  • -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                - - +authGuardFn | @auth0/auth0-angular
                                                                                                                                                +
                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Preparing search index...
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +

                                                                                                                                                  Function authGuardFn

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                    +
                                                                                                                                                  • + +
                                                                                                                                                    +

                                                                                                                                                    Functional AuthGuard to ensure routes can only be accessed when authenticated.

                                                                                                                                                    +

                                                                                                                                                    Note: Should only be used as of Angular 15

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +

                                                                                                                                                    Parameters

                                                                                                                                                    +
                                                                                                                                                      +
                                                                                                                                                    • route: ActivatedRouteSnapshot +

                                                                                                                                                      Contains the information about a route associated with a component loaded in an outlet at a particular moment in time.

                                                                                                                                                      +
                                                                                                                                                      • +
                                                                                                                                                    • state: RouterStateSnapshot +

                                                                                                                                                      Represents the state of the router at a moment in time.

                                                                                                                                                      +
                                                                                                                                                    +

                                                                                                                                                    Returns Observable<boolean>

                                                                                                                                                    An Observable, indicating if the route can be accessed or not

                                                                                                                                                    +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Settings

                                                                                                                                                   +
                                                                                                                                                  +
                                                                                                                                                  Member Visibility +
                                                                                                                                                    +
                                                                                                                                                    • +
                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  diff --git a/docs/functions/authHttpInterceptorFn.html b/docs/functions/authHttpInterceptorFn.html index 6c61c802..d62952b1 100644 --- a/docs/functions/authHttpInterceptorFn.html +++ b/docs/functions/authHttpInterceptorFn.html @@ -1,373 +1,51 @@ - - - - - - authHttpInterceptorFn | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    Preparing search index...
                                                                                                                                                    -
                                                                                                                                                    -                                                                                                                                                     - -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    - -

                                                                                                                                                    Function authHttpInterceptorFn

                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    • - -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Functional AuthHttpInterceptor to include the access token - in matching requests. -

                                                                                                                                                      -

                                                                                                                                                      Note: Should only be used as of Angular 15

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Parameters

                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      • - req: - HttpRequest<any> -
                                                                                                                                                        -

                                                                                                                                                        - An outgoing HTTP request with an optional typed body. -

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        • -
                                                                                                                                                      • - handle: - (req: - HttpRequest<unknown>) - => - Observable<HttpEvent<unknown>> -
                                                                                                                                                        -

                                                                                                                                                        - Represents the next interceptor in an interceptor - chain, or the real backend if there are no further - interceptors. -

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        • -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Returns Observable<HttpEvent<any>> -

                                                                                                                                                      -

                                                                                                                                                      An Observable representing the intercepted HttpRequest

                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      • -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    - - -

                                                                                                                                                    Settings

                                                                                                                                                    -                                                                                                                                                     -
                                                                                                                                                    -
                                                                                                                                                    - Member Visibility -
                                                                                                                                                      -
                                                                                                                                                    • - -
                                                                                                                                                      • -
                                                                                                                                                    • - -
                                                                                                                                                      • -
                                                                                                                                                    • - -
                                                                                                                                                      • -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    - -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    - -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    - - +authHttpInterceptorFn | @auth0/auth0-angular
                                                                                                                                                    +
                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Preparing search index...
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + +

                                                                                                                                                      Function authHttpInterceptorFn

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                        +
                                                                                                                                                      • + +
                                                                                                                                                        +

                                                                                                                                                        Functional AuthHttpInterceptor to include the access token in matching requests.

                                                                                                                                                        +

                                                                                                                                                        Note: Should only be used as of Angular 15

                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        +

                                                                                                                                                        Parameters

                                                                                                                                                        +
                                                                                                                                                          +
                                                                                                                                                        • req: HttpRequest<any> +

                                                                                                                                                          An outgoing HTTP request with an optional typed body.

                                                                                                                                                          +
                                                                                                                                                          • +
                                                                                                                                                        • handle: (req: HttpRequest<unknown>) => Observable<HttpEvent<unknown>> +

                                                                                                                                                          Represents the next interceptor in an interceptor chain, or the real backend if there are no +further interceptors.

                                                                                                                                                          +
                                                                                                                                                        +

                                                                                                                                                        Returns Observable<HttpEvent<any>>

                                                                                                                                                        An Observable representing the intercepted HttpRequest

                                                                                                                                                        +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      Settings

                                                                                                                                                       +
                                                                                                                                                      +
                                                                                                                                                      Member Visibility +
                                                                                                                                                        +
                                                                                                                                                        • +
                                                                                                                                                        • +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      diff --git a/docs/functions/isFederatedDomain.html b/docs/functions/isFederatedDomain.html index abfa46c8..42e6293d 100644 --- a/docs/functions/isFederatedDomain.html +++ b/docs/functions/isFederatedDomain.html @@ -1,346 +1,50 @@ - - - - - - isFederatedDomain | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                      -
                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        Preparing search index...
                                                                                                                                                        -
                                                                                                                                                        -                                                                                                                                                         - -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - -

                                                                                                                                                        Function isFederatedDomain

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        • - -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          - Checks whether an email domain is managed for enterprise SSO - on the given Auth0 tenant. Wraps the auth-js primitive to - inject spa-js telemetry by default. -

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          Parameters

                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • - auth0Domain: - string -
                                                                                                                                                            -

                                                                                                                                                            - Tenant domain, e.g. 'tenant.auth0.com'. A leading 'https://' or 'http://' is stripped - automatically. -

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            • -
                                                                                                                                                          • - emailDomain: - string -
                                                                                                                                                            -

                                                                                                                                                            - The email domain to check, e.g. 'acme.com'. -

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            • -
                                                                                                                                                          • - Optionaloptions: - IsFederatedDomainOptions -
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          - Returns Promise<boolean> -

                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          • -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - - -

                                                                                                                                                        Settings

                                                                                                                                                        -                                                                                                                                                         -
                                                                                                                                                        -
                                                                                                                                                        - Member Visibility -
                                                                                                                                                          -
                                                                                                                                                        • - -
                                                                                                                                                          • -
                                                                                                                                                        • - -
                                                                                                                                                          • -
                                                                                                                                                        • - -
                                                                                                                                                          • -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - - +isFederatedDomain | @auth0/auth0-angular
                                                                                                                                                        +
                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          Preparing search index...
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          + +

                                                                                                                                                          Function isFederatedDomain

                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                            +
                                                                                                                                                          • + +
                                                                                                                                                            +

                                                                                                                                                            Checks whether an email domain is managed for enterprise SSO on the given Auth0 tenant. +Wraps the auth-js primitive to inject spa-js telemetry by default.

                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +

                                                                                                                                                            Parameters

                                                                                                                                                            +
                                                                                                                                                            +

                                                                                                                                                            Returns Promise<boolean>

                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +

                                                                                                                                                          Settings

                                                                                                                                                           +
                                                                                                                                                          +
                                                                                                                                                          Member Visibility +
                                                                                                                                                            +
                                                                                                                                                            • +
                                                                                                                                                            • +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          diff --git a/docs/functions/isHttpInterceptorRouteConfig.html b/docs/functions/isHttpInterceptorRouteConfig.html index 67ccabfa..2972eae7 100644 --- a/docs/functions/isHttpInterceptorRouteConfig.html +++ b/docs/functions/isHttpInterceptorRouteConfig.html @@ -1,323 +1,45 @@ - - - - - - isHttpInterceptorRouteConfig | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            Preparing search index...
                                                                                                                                                            -
                                                                                                                                                            -                                                                                                                                                             - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - -

                                                                                                                                                            Function isHttpInterceptorRouteConfig

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - - -

                                                                                                                                                            Settings

                                                                                                                                                            -                                                                                                                                                             -
                                                                                                                                                            -
                                                                                                                                                            - Member Visibility -
                                                                                                                                                              -
                                                                                                                                                            • - -
                                                                                                                                                              • -
                                                                                                                                                            • - -
                                                                                                                                                              • -
                                                                                                                                                            • - -
                                                                                                                                                              • -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - - +isHttpInterceptorRouteConfig | @auth0/auth0-angular
                                                                                                                                                            +
                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Preparing search index...
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              + +

                                                                                                                                                              Function isHttpInterceptorRouteConfig

                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +

                                                                                                                                                              Settings

                                                                                                                                                               +
                                                                                                                                                              +
                                                                                                                                                              Member Visibility +
                                                                                                                                                                +
                                                                                                                                                                • +
                                                                                                                                                                • +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              diff --git a/docs/functions/provideAuth0.html b/docs/functions/provideAuth0.html index ca9dbe2a..215911dd 100644 --- a/docs/functions/provideAuth0.html +++ b/docs/functions/provideAuth0.html @@ -1,330 +1,55 @@ - - - - - - provideAuth0 | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                              -
                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                Preparing search index...
                                                                                                                                                                -
                                                                                                                                                                -                                                                                                                                                                 - -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                - -

                                                                                                                                                                Function provideAuth0

                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                  -
                                                                                                                                                                • - -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - Initialize the authentication system. Configuration can - either be specified here, or by calling AuthClientConfig.set - (perhaps from an APP_INITIALIZER factory function). -

                                                                                                                                                                  -

                                                                                                                                                                  - Note: Should only be used as of Angular 15. This function - returns EnvironmentProviders which ensures it - can only be used at the application/environment level and - cannot be added to a component's providers array (this will - result in a compile-time error). -

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  Parameters

                                                                                                                                                                  -
                                                                                                                                                                    -
                                                                                                                                                                  • - Optionalconfig: - AuthConfig -
                                                                                                                                                                    -

                                                                                                                                                                    The optional configuration for the SDK.

                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    • -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - Returns - EnvironmentProviders -

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - - 
                                                                                                                                                                  bootstrapApplication(AppComponent, {
                                                                                                                                                                    providers: [
                                                                                                                                                                      provideAuth0(),
                                                                                                                                                                    ],
                                                                                                                                                                  });
+provideAuth0 | @auth0/auth0-angular
                                                                                                                                                                  
+
                                                                                                                                                                  @auth0/auth0-angular
+
+
                                                                                                                                                                    
+
                                                                                                                                                                    
+
                                                                                                                                                                    Preparing search index...
                                                                                                                                                                    
+
                                                                                                                                                                    
+
                                                                                                                                                                    
+
                                                                                                                                                                    
+
+
                                                                                                                                                                    Function provideAuth0
                                                                                                                                                                    
+
                                                                                                                                                                    
+
                                                                                                                                                                      
+
                                                                                                                                                                    • 
+
+
                                                                                                                                                                      
+
                                                                                                                                                                      Initialize the authentication system. Configuration can either be specified here,
+or by calling AuthClientConfig.set (perhaps from an APP_INITIALIZER factory function).
                                                                                                                                                                      
+
                                                                                                                                                                      Note: Should only be used as of Angular 15. This function returns EnvironmentProviders
+which ensures it can only be used at the application/environment level and cannot be
+added to a component's providers array (this will result in a compile-time error).
                                                                                                                                                                      
+
                                                                                                                                                                      
+
                                                                                                                                                                      
+
                                                                                                                                                                      Parameters
                                                                                                                                                                      
+
                                                                                                                                                                        
+
                                                                                                                                                                      • Optionalconfig: AuthConfig
+
                                                                                                                                                                        The optional configuration for the SDK.
                                                                                                                                                                        
+
                                                                                                                                                                      
+
                                                                                                                                                                      Returns EnvironmentProviders
                                                                                                                                                                      
+
                                                                                                                                                                      
+
                                                                                                                                                                      
+
                                                                                                                                                                      bootstrapApplication(AppComponent, {
                                                                                                                                                                        providers: [
                                                                                                                                                                          provideAuth0(),
                                                                                                                                                                        ],
                                                                                                                                                                      });
 
                                                                                                                                                                      
-                  
                                                                                                                                                                      
-                
                                                                                                                                                                      
-                
-              
                                                                                                                                                                      
-            
                                                                                                                                                                      • 
-          
                                                                                                                                                                    
-        
                                                                                                                                                                    
-      
                                                                                                                                                                    
-      
                                                                                                                                                                    
-        
                                                                                                                                                                    
-          
                                                                                                                                                                    
-            
                                                                                                                                                                    
-              
-                
-                
                                                                                                                                                                    Settings
                                                                                                                                                                    
-                                                                                                                                                                                  
-              
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  Member Visibility
-                  
                                                                                                                                                                      
-                    
                                                                                                                                                                    • 
-                      
-                    
                                                                                                                                                                      • 
-                    
                                                                                                                                                                    • 
-                      
-                    
                                                                                                                                                                      • 
-                    
                                                                                                                                                                    • 
-                      
-                    
                                                                                                                                                                      • 
-                  
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  
-                
                                                                                                                                                                    
-              
                                                                                                                                                                    
-            
                                                                                                                                                                    
-          
                                                                                                                                                                    
-        
                                                                                                                                                                    
-        
                                                                                                                                                                    
-          
-        
                                                                                                                                                                    
-      
                                                                                                                                                                    
-    
                                                                                                                                                                    
-    
                                                                                                                                                                    
-    
                                                                                                                                                                    
-  
-
+
+
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +

                                                                                                                                                                  Settings

                                                                                                                                                                   +
                                                                                                                                                                  +
                                                                                                                                                                  Member Visibility +
                                                                                                                                                                    +
                                                                                                                                                                    • +
                                                                                                                                                                    • +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 2abe8751..bfd9f017 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1,489 +1,58 @@ - - - - - - @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                  -
                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    Preparing search index...
                                                                                                                                                                    -
                                                                                                                                                                    -                                                                                                                                                                     - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -

                                                                                                                                                                    @auth0/auth0-angular

                                                                                                                                                                    -
                                                                                                                                                                    -

                                                                                                                                                                    Hierarchy Summary

                                                                                                                                                                    - - - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - - -

                                                                                                                                                                    Settings

                                                                                                                                                                    -                                                                                                                                                                     -
                                                                                                                                                                    -
                                                                                                                                                                    - Member Visibility -
                                                                                                                                                                      -
                                                                                                                                                                    • - -
                                                                                                                                                                      • -
                                                                                                                                                                    • - -
                                                                                                                                                                      • -
                                                                                                                                                                    • - -
                                                                                                                                                                      • -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - - +@auth0/auth0-angular
                                                                                                                                                                    +
                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Preparing search index...
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +

                                                                                                                                                                      @auth0/auth0-angular

                                                                                                                                                                      +

                                                                                                                                                                      Hierarchy Summary

                                                                                                                                                                      + + +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +

                                                                                                                                                                      Settings

                                                                                                                                                                       +
                                                                                                                                                                      +
                                                                                                                                                                      Member Visibility +
                                                                                                                                                                        +
                                                                                                                                                                        • +
                                                                                                                                                                        • +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      diff --git a/docs/index.html b/docs/index.html index 46582694..19b3d410 100644 --- a/docs/index.html +++ b/docs/index.html @@ -95,6 +95,11 @@                                                                                                                                                                       +
                                                                                                                                                                      Note

                                                                                                                                                                      +Experiment Center support via SDKs is currently in Early Access. To request access to this feature, contact your Auth0 representative.

                                                                                                                                                                      +
                                                                                                                                                                      +

                                                                                                                                                                      You can also force a specific Experiment Center variant per login by passing experiment_id, variation_id, and the optional segment_id in authorizationParams - see the Experiment Center example.

                                                                                                                                                                      For more code samples on how to integrate the auth0-angular SDK in your Angular application, including how to use our standalone and function APIs, have a look at the examples.

                                                                                                                                                                      Explore public API's available in auth0-angular.

                                                                                                                                                                      @@ -148,7 +153,8 @@

                                                                                                                                                                      On This Page

                                                                                                                                                                      -
                                                                                                                                                                    • Add login to your application
                                                                                                                                                                      • API referenceFeedback +
                                                                                                                                                                    • Add login to your application
                                                                                                                                                                      • +
                                                                                                                                                                    • Experiment Center
                                                                                                                                                                      • API referenceFeedback
                                                                                                                                                                      • Contributing
                                                                                                                                                                      • Raise an issue
                                                                                                                                                                        • diff --git a/docs/interfaces/AppState.html b/docs/interfaces/AppState.html index 7634a00d..aaf33610 100644 --- a/docs/interfaces/AppState.html +++ b/docs/interfaces/AppState.html @@ -1,567 +1,85 @@ - - - - - - AppState | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - @auth0/auth0-angular - - - - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          Preparing search index...
                                                                                                                                                                          -
                                                                                                                                                                          -                                                                                                                                                                           - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - -

                                                                                                                                                                          Interface AppState

                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          - Angular specific state to be stored before redirect and any - account that the user may have connected to. -

                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - interface - AppState - {
                                                                                                                                                                              connectedAccount?: - ConnectedAccount;
                                                                                                                                                                              response_type?: - ResponseType;
                                                                                                                                                                              target?: - string;
                                                                                                                                                                              [key: - string]: - any;
                                                                                                                                                                          } -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          Indexable

                                                                                                                                                                          -
                                                                                                                                                                            -
                                                                                                                                                                          • -
                                                                                                                                                                            - [key: - string]: - any -
                                                                                                                                                                            -
                                                                                                                                                                            -

                                                                                                                                                                            Any custom parameter to be stored in appState

                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - - -
                                                                                                                                                                          Index
                                                                                                                                                                          -                                                                                                                                                                           -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - - connectedAccount? - - response_type? - - target? -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - - - - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - connectedAccount?: - ConnectedAccount -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          - The connected account information when the user has completed - a connect account flow. -

                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - response_type?: - ResponseType -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          - The response type returned from the authentication server. -

                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - target?: - string -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          - Target path the app gets routed to after handling the callback - from Auth0 (defaults to '/') -

                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - - -

                                                                                                                                                                          Settings

                                                                                                                                                                          -                                                                                                                                                                           -
                                                                                                                                                                          -
                                                                                                                                                                          - Member Visibility -
                                                                                                                                                                            -
                                                                                                                                                                          • - -
                                                                                                                                                                            • -
                                                                                                                                                                          • - -
                                                                                                                                                                            • -
                                                                                                                                                                          • - -
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - - -

                                                                                                                                                                          On This Page

                                                                                                                                                                          -                                                                                                                                                                           -
                                                                                                                                                                          -
                                                                                                                                                                          - - Properties - - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - - +AppState | @auth0/auth0-angular
                                                                                                                                                                          +
                                                                                                                                                                          @auth0/auth0-angular + +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Preparing search index...
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            + +

                                                                                                                                                                            Interface AppState

                                                                                                                                                                            +
                                                                                                                                                                            +

                                                                                                                                                                            Angular specific state to be stored before redirect +and any account that the user may have connected to.

                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            interface AppState {
                                                                                                                                                                                connectedAccount?: ConnectedAccount;
                                                                                                                                                                                response_type?: ResponseType;
                                                                                                                                                                                target?: string;
                                                                                                                                                                                [key: string]: any;
                                                                                                                                                                            }
                                                                                                                                                                            +
                                                                                                                                                                            +

                                                                                                                                                                            Indexable

                                                                                                                                                                            +
                                                                                                                                                                              +
                                                                                                                                                                            • +
                                                                                                                                                                              [key: string]: any
                                                                                                                                                                              +

                                                                                                                                                                              Any custom parameter to be stored in appState

                                                                                                                                                                              +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Index
                                                                                                                                                                             +
                                                                                                                                                                            +
                                                                                                                                                                            + +
                                                                                                                                                                            connectedAccount? +response_type? +target? +
                                                                                                                                                                            +
                                                                                                                                                                            + +
                                                                                                                                                                            +
                                                                                                                                                                            + +
                                                                                                                                                                            connectedAccount?: ConnectedAccount
                                                                                                                                                                            +

                                                                                                                                                                            The connected account information when the user has completed +a connect account flow.

                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            + +
                                                                                                                                                                            response_type?: ResponseType
                                                                                                                                                                            +

                                                                                                                                                                            The response type returned from the authentication server.

                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            + +
                                                                                                                                                                            target?: string
                                                                                                                                                                            +

                                                                                                                                                                            Target path the app gets routed to after +handling the callback from Auth0 (defaults to '/')

                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +

                                                                                                                                                                            Settings

                                                                                                                                                                             +
                                                                                                                                                                            +
                                                                                                                                                                            Member Visibility +
                                                                                                                                                                              +
                                                                                                                                                                              • +
                                                                                                                                                                              • +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +

                                                                                                                                                                            On This Page

                                                                                                                                                                             +
                                                                                                                                                                            +
                                                                                                                                                                            Properties +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            diff --git a/docs/interfaces/AuthConfig.html b/docs/interfaces/AuthConfig.html index e4da6149..760f126d 100644 --- a/docs/interfaces/AuthConfig.html +++ b/docs/interfaces/AuthConfig.html @@ -1,2476 +1,461 @@ - - - - - - AuthConfig | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                            -
                                                                                                                                                                            - @auth0/auth0-angular - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              Preparing search index...
                                                                                                                                                                              -
                                                                                                                                                                              -                                                                                                                                                                               - -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - -

                                                                                                                                                                              Interface AuthConfig

                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              Configuration for the authentication service

                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - interface - AuthConfig - {
                                                                                                                                                                                  auth0Client?: - {
                                                                                                                                                                                      env?: - { - [key: - string]: - string - };
                                                                                                                                                                                      name: - string;
                                                                                                                                                                                      version: - string;
                                                                                                                                                                                  };
                                                                                                                                                                                  authorizationParams?: - ClientAuthorizationParams;
                                                                                                                                                                                  authorizeTimeoutInSeconds?: - number;
                                                                                                                                                                                  cache?: - ICache;
                                                                                                                                                                                  cacheLocation?: - CacheLocation;
                                                                                                                                                                                  clientId: - string;
                                                                                                                                                                                  cookieDomain?: - string;
                                                                                                                                                                                  domain: - string;
                                                                                                                                                                                  enterpriseConnect?: - boolean;
                                                                                                                                                                                  errorPath?: - string;
                                                                                                                                                                                  httpInterceptor?: - HttpInterceptorConfig;
                                                                                                                                                                                  httpTimeoutInSeconds?: - number;
                                                                                                                                                                                  interactiveErrorHandler?: - "popup";
                                                                                                                                                                                  issuer?: - string;
                                                                                                                                                                                  leeway?: - number;
                                                                                                                                                                                  legacySameSiteCookie?: - boolean;
                                                                                                                                                                                  nowProvider?: - () - => - number - | - Promise<number>;
                                                                                                                                                                                  refreshTokenMode?: - RefreshTokenMode;
                                                                                                                                                                                  sessionCheckExpiryDays?: - number;
                                                                                                                                                                                  sessionTransferTokenQueryParamName?: - string;
                                                                                                                                                                                  skipRedirectCallback?: - boolean;
                                                                                                                                                                                  useCookiesForTransactions?: - boolean;
                                                                                                                                                                                  useDpop?: - boolean;
                                                                                                                                                                                  useFormData?: - boolean;
                                                                                                                                                                                  useMrrt?: - boolean;
                                                                                                                                                                                  useRefreshTokens?: - boolean;
                                                                                                                                                                                  useRefreshTokensFallback?: - boolean;
                                                                                                                                                                                  workerUrl?: - string;
                                                                                                                                                                              } -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              Hierarchy

                                                                                                                                                                              -
                                                                                                                                                                                -
                                                                                                                                                                              • - Auth0ClientOptions -
                                                                                                                                                                                  -
                                                                                                                                                                                • - AuthConfig -
                                                                                                                                                                                  • -
                                                                                                                                                                                -
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              Index
                                                                                                                                                                              -                                                                                                                                                                               -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - - auth0Client? - - authorizationParams? - - authorizeTimeoutInSeconds? - - cache? - - cacheLocation? - - clientId - - cookieDomain? - - domain - - enterpriseConnect? - - errorPath? - - httpInterceptor? - - httpTimeoutInSeconds? - - interactiveErrorHandler? - - issuer? - - leeway? - - legacySameSiteCookie? - - nowProvider? - - refreshTokenMode? - - sessionCheckExpiryDays? - - sessionTransferTokenQueryParamName? - - skipRedirectCallback? - - useCookiesForTransactions? - - useDpop? - - useFormData? - - useMrrt? - - useRefreshTokens? - - useRefreshTokensFallback? - - workerUrl? -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - auth0Client?: - { - env?: - { - [key: - string]: - string - }; - name: - string; - version: - string - } -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              - Internal property to send information about the client to the - authorization server. -

                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - authorizationParams?: - ClientAuthorizationParams -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              - URL parameters that will be sent back to the Authorization - Server. This can be known parameters defined by Auth0 or - custom parameters that you define. -

                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - authorizeTimeoutInSeconds?: - number -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              - A maximum number of seconds to wait before declaring - background calls to /authorize as failed for timeout Defaults - to 60s. -

                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - cache?: - ICache -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              - Specify a custom cache implementation to use for token storage - and retrieval. This setting takes precedence over - cacheLocation if they are both specified. -

                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - cacheLocation?: - CacheLocation -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              - The location to use when storing cache data. Valid values are - memory or localstorage. The default - setting is memory. -

                                                                                                                                                                              -

                                                                                                                                                                              - Read more about - changing storage options in the Auth0 docs -

                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - clientId: - string -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              The Client ID found on your Application settings page

                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - cookieDomain?: - string -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              - The domain the cookie is accessible from. If not set, the - cookie is scoped to the current domain, including the - subdomain. -

                                                                                                                                                                              -

                                                                                                                                                                              - Note: setting this incorrectly may cause silent authentication - to stop working on page load. -

                                                                                                                                                                              -

                                                                                                                                                                              - To keep a user logged in across multiple subdomains set this - to your top-level domain and prefixed with a - . (eg: .example.com). -

                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - domain: - string -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              - Your Auth0 account domain such as - 'example.auth0.com', - 'example.eu.auth0.com' or , - 'example.mycompany.com' (when using - custom domains) -

                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - enterpriseConnect?: - boolean -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              - Set to true when this client drives an Enterprise - Connect login (enterprise SSO resolved from the email domain - via - isFederatedDomain - and login_hint). -

                                                                                                                                                                              -

                                                                                                                                                                              - Enterprise Connect issues no refresh token and resolves the - organization from Home Realm Discovery at login. When enabled, - the SDK warns at initialization if the configuration - contradicts that: useRefreshTokens: true or - offline_access in scope (no refresh - token is issued) or a static organization (HRD - resolves it, and a static value breaks multi-customer setups). -

                                                                                                                                                                              -

                                                                                                                                                                              - This is a routing/telemetry flag only; it does not by itself - change the login flow. -

                                                                                                                                                                              -

                                                                                                                                                                              Default: false

                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - errorPath?: - string -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              - Path in your application to redirect to when the Authorization - server returns an error. Defaults to / -

                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - httpInterceptor?: - HttpInterceptorConfig -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              - Configuration for the built-in Http Interceptor, used for - automatically attaching access tokens. -

                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - httpTimeoutInSeconds?: - number -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              - Specify the timeout for HTTP calls using fetch. - The default is 10 seconds. -

                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - interactiveErrorHandler?: - "popup" -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              - Configures automatic handling of interactive authentication - errors. -

                                                                                                                                                                              -

                                                                                                                                                                              - When set, the SDK intercepts mfa_required errors - from getTokenSilently() and handles them - automatically instead of throwing to the caller. -

                                                                                                                                                                              -
                                                                                                                                                                                -
                                                                                                                                                                              • - 'popup': Opens Universal Login in a popup to - complete MFA. The original - authorizationParams (audience, scope) are - preserved. On success, the token is returned. On failure, - popup errors are thrown. -
                                                                                                                                                                                • -
                                                                                                                                                                              -

                                                                                                                                                                              - This option only affects getTokenSilently(). - Other methods are not affected. -

                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - - 
                                                                                                                                                                              undefined (MFA errors are thrown to the caller)
+AuthConfig | @auth0/auth0-angular
                                                                                                                                                                              
+
                                                                                                                                                                              @auth0/auth0-angular
+
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                Interface AuthConfig
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                Configuration for the authentication service
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                interface AuthConfig {
                                                                                                                                                                                    anonymousSessionsCacheMode?: "localStorage" | "memory";
                                                                                                                                                                                    auth0Client?: {
                                                                                                                                                                                        env?: { [key: string]: string };
                                                                                                                                                                                        name: string;
                                                                                                                                                                                        version: string;
                                                                                                                                                                                    };
                                                                                                                                                                                    authorizationParams?: ClientAuthorizationParams;
                                                                                                                                                                                    authorizeTimeoutInSeconds?: number;
                                                                                                                                                                                    cache?: ICache;
                                                                                                                                                                                    cacheLocation?: CacheLocation;
                                                                                                                                                                                    clientId: string;
                                                                                                                                                                                    cookieDomain?: string;
                                                                                                                                                                                    createAnonymousSessionOnFailedSilentAuth?: boolean;
                                                                                                                                                                                    domain: string;
                                                                                                                                                                                    enterpriseConnect?: boolean;
                                                                                                                                                                                    errorPath?: string;
                                                                                                                                                                                    httpInterceptor?: HttpInterceptorConfig;
                                                                                                                                                                                    httpTimeoutInSeconds?: number;
                                                                                                                                                                                    interactiveErrorHandler?: "popup";
                                                                                                                                                                                    issuer?: string;
                                                                                                                                                                                    leeway?: number;
                                                                                                                                                                                    legacySameSiteCookie?: boolean;
                                                                                                                                                                                    nowProvider?: () => number | Promise<number>;
                                                                                                                                                                                    refreshTokenMode?: RefreshTokenMode;
                                                                                                                                                                                    sessionCheckExpiryDays?: number;
                                                                                                                                                                                    sessionTransferTokenQueryParamName?: string;
                                                                                                                                                                                    skipRedirectCallback?: boolean;
                                                                                                                                                                                    useCookiesForTransactions?: boolean;
                                                                                                                                                                                    useDpop?: boolean;
                                                                                                                                                                                    useFormData?: boolean;
                                                                                                                                                                                    useMrrt?: boolean;
                                                                                                                                                                                    useRefreshTokens?: boolean;
                                                                                                                                                                                    useRefreshTokensFallback?: boolean;
                                                                                                                                                                                    workerUrl?: string;
                                                                                                                                                                                }
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                Hierarchy
                                                                                                                                                                                
+
                                                                                                                                                                                  
+
                                                                                                                                                                                • Auth0ClientOptions
+
                                                                                                                                                                                    
+
                                                                                                                                                                                  • AuthConfig
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                Index
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                anonymousSessionsCacheMode?
+auth0Client?
+authorizationParams?
+authorizeTimeoutInSeconds?
+cache?
+cacheLocation?
+clientId
+cookieDomain?
+createAnonymousSessionOnFailedSilentAuth?
+domain
+enterpriseConnect?
+errorPath?
+httpInterceptor?
+httpTimeoutInSeconds?
+interactiveErrorHandler?
+issuer?
+leeway?
+legacySameSiteCookie?
+nowProvider?
+refreshTokenMode?
+sessionCheckExpiryDays?
+sessionTransferTokenQueryParamName?
+skipRedirectCallback?
+useCookiesForTransactions?
+useDpop?
+useFormData?
+useMrrt?
+useRefreshTokens?
+useRefreshTokensFallback?
+workerUrl?
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                anonymousSessionsCacheMode?: "localStorage" | "memory"
                                                                                                                                                                                
+
                                                                                                                                                                                Where to store the anonymous session token.
                                                                                                                                                                                
+
                                                                                                                                                                                  
+
                                                                                                                                                                                • 'localStorage' (default): the session token survives page reloads. Suitable for most SPAs.
                                                                                                                                                                                  • 
+
                                                                                                                                                                                • 'memory': the session token lives only for the current page load. Use this if you do not
+want anonymous session data written to disk.
                                                                                                                                                                                  • 
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                'localStorage'
 
                                                                                                                                                                                
-                
                                                                                                                                                                                
-              
                                                                                                                                                                                
-              
-            
                                                                                                                                                                                
-            
                                                                                                                                                                                
-              
-              
                                                                                                                                                                                
-                issuer?:
-                string
-              
                                                                                                                                                                                
-              
                                                                                                                                                                                
-                
                                                                                                                                                                                
-                  The issuer to be used for validation of JWTs, optionally
-                  defaults to the domain above
-                
                                                                                                                                                                                
-              
                                                                                                                                                                                
-              
-            
                                                                                                                                                                                
-            
                                                                                                                                                                                
-              
-              
                                                                                                                                                                                
-                leeway?:
-                number
-              
                                                                                                                                                                                
-              
                                                                                                                                                                                
-                
                                                                                                                                                                                
-                  The value in seconds used to account for clock skew in JWT
-                  expirations. Typically, this value is no more than a minute or
-                  two at maximum. Defaults to 60s.
-                
                                                                                                                                                                                
-              
                                                                                                                                                                                
-              
-            
                                                                                                                                                                                
-            
                                                                                                                                                                                
-              
-              
                                                                                                                                                                                
-                legacySameSiteCookie?:
-                boolean
-              
                                                                                                                                                                                
-              
                                                                                                                                                                                
-                
                                                                                                                                                                                
-                  Sets an additional cookie with no SameSite attribute to
-                  support legacy browsers that are not compatible with the
-                  latest SameSite changes. This will log a warning on modern
-                  browsers, you can disable the warning by setting this to false
-                  but be aware that some older useragents will not work, See
-                  https://www.chromium.org/updates/same-site/incompatible-clients
-                  Defaults to true
-                
                                                                                                                                                                                
-              
                                                                                                                                                                                
-              
-            
                                                                                                                                                                                
-            
                                                                                                                                                                                
-              
-              
                                                                                                                                                                                
-                nowProvider?:
-                ()
-                =>
-                number
-                |
-                Promise<number>
-              
                                                                                                                                                                                
-              
                                                                                                                                                                                
-                
                                                                                                                                                                                
-                  Modify the value used as the current time during the token
-                  validation.
-                
                                                                                                                                                                                
-                
                                                                                                                                                                                
-                  Note: Using this improperly can potentially
-                  compromise the token validation.
-                
                                                                                                                                                                                
-              
                                                                                                                                                                                
-              
-            
                                                                                                                                                                                
-            
                                                                                                                                                                                
-              
-              
                                                                                                                                                                                
-                refreshTokenMode?:
-                RefreshTokenMode
-              
                                                                                                                                                                                
-              
                                                                                                                                                                                
-                
                                                                                                                                                                                
-                  Selects the refresh-token variant used when
-                  useRefreshTokens: true. Defaults to
-                  RefreshTokenMode.Offline.
-                
                                                                                                                                                                                
-                
-                
                                                                                                                                                                                
-                  Online mode requires useRefreshTokens: true and
-                  useDpop: true. The online_access and
-                  offline_access scopes are mutually exclusive.
-                
                                                                                                                                                                                
-              
                                                                                                                                                                                
-              
-            
                                                                                                                                                                                
-            
                                                                                                                                                                                
-              
-              
                                                                                                                                                                                
-                sessionCheckExpiryDays?:
-                number
-              
                                                                                                                                                                                
-              
                                                                                                                                                                                
-                
                                                                                                                                                                                
-                  Number of days until the cookie
-                  auth0.is.authenticated will expire Defaults to 1.
-                
                                                                                                                                                                                
-              
                                                                                                                                                                                
-              
-            
                                                                                                                                                                                
-            
                                                                                                                                                                                
-              
-              
                                                                                                                                                                                
-                sessionTransferTokenQueryParamName?:
-                string
-              
                                                                                                                                                                                
-              
                                                                                                                                                                                
-                
                                                                                                                                                                                
-                  Query parameter name to extract the session transfer token
-                  from for Native to Web SSO.
-                
                                                                                                                                                                                
-                
                                                                                                                                                                                
-                  When set, the SDK automatically extracts the token from the
-                  specified URL query parameter and includes it as
-                  session_transfer_token in authorization requests.
-                  This enables seamless single sign-on when users transition
-                  from a native mobile application to a web application.
-                
                                                                                                                                                                                
-                
                                                                                                                                                                                
-                  After extraction, the token is automatically removed from the
-                  URL using window.history.replaceState() to
-                  prevent accidental reuse on subsequent authentication
-                  requests.
-                
                                                                                                                                                                                
-                
                                                                                                                                                                                
-                  Default: undefined (feature
-                  disabled)
-                
                                                                                                                                                                                
-                
                                                                                                                                                                                Common values:
                                                                                                                                                                                
-                
                                                                                                                                                                                  
-                  
                                                                                                                                                                                • 
-                    'session_transfer_token' - Standard parameter
-                    name
-                  
                                                                                                                                                                                  • 
-                  
                                                                                                                                                                                • 'stt' - Shortened version
                                                                                                                                                                                  • 
-                  
                                                                                                                                                                                • Custom parameter name of your choice
                                                                                                                                                                                  • 
-                
                                                                                                                                                                                
-                
                                                                                                                                                                                
-                  Set to undefined to disable automatic extraction
-                  if you prefer to handle session transfer tokens manually.
-                
                                                                                                                                                                                
-              
                                                                                                                                                                                
-              
                                                                                                                                                                                
-                
                                                                                                                                                                                
-                  
-                  
                                                                                                                                                                                const auth0 = await createAuth0Client({
                                                                                                                                                                                  domain: '<AUTH0_DOMAIN>',
                                                                                                                                                                                  clientId: '<AUTH0_CLIENT_ID>',
                                                                                                                                                                                  sessionTransferTokenQueryParamName: 'session_transfer_token'
                                                                                                                                                                                });
+
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                auth0Client?: { env?: { [key: string]: string }; name: string; version: string }
                                                                                                                                                                                
+
                                                                                                                                                                                Internal property to send information about the client to the authorization server.
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                authorizationParams?: ClientAuthorizationParams
                                                                                                                                                                                
+
                                                                                                                                                                                URL parameters that will be sent back to the Authorization Server. This can be known parameters
+defined by Auth0 or custom parameters that you define.
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                authorizeTimeoutInSeconds?: number
                                                                                                                                                                                
+
                                                                                                                                                                                A maximum number of seconds to wait before declaring background calls to /authorize as failed for timeout
+Defaults to 60s.
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                cache?: ICache
                                                                                                                                                                                
+
                                                                                                                                                                                Specify a custom cache implementation to use for token storage and retrieval. This setting takes precedence over cacheLocation if they are both specified.
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                cacheLocation?: CacheLocation
                                                                                                                                                                                
+
                                                                                                                                                                                The location to use when storing cache data. Valid values are memory or localstorage.
+The default setting is memory.
                                                                                                                                                                                
+
                                                                                                                                                                                Read more about changing storage options in the Auth0 docs
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                clientId: string
                                                                                                                                                                                
+
                                                                                                                                                                                The Client ID found on your Application settings page
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                cookieDomain?: string
                                                                                                                                                                                
+
                                                                                                                                                                                The domain the cookie is accessible from. If not set, the cookie is scoped to
+the current domain, including the subdomain.
                                                                                                                                                                                
+
                                                                                                                                                                                Note: setting this incorrectly may cause silent authentication to stop working
+on page load.
                                                                                                                                                                                
+
                                                                                                                                                                                To keep a user logged in across multiple subdomains set this to your
+top-level domain and prefixed with a . (eg: .example.com).
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                createAnonymousSessionOnFailedSilentAuth?: boolean
                                                                                                                                                                                
+
                                                                                                                                                                                When true, checkSession() automatically creates (or restores) an anonymous
+session when the user is not authenticated. This does not affect standalone
+getTokenSilently() calls. checkSession() does not throw in this case.
                                                                                                                                                                                
+
                                                                                                                                                                                Metadata limitation: the session is created without metadata. If you need
+to attach metadata to the anonymous identity, do not use this option. Call
+auth0.anonymous.createSession({ metadata }) explicitly instead.
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                false
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                domain: string
                                                                                                                                                                                
+
                                                                                                                                                                                Your Auth0 account domain such as 'example.auth0.com',
+'example.eu.auth0.com' or , 'example.mycompany.com'
+(when using custom domains)
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                enterpriseConnect?: boolean
                                                                                                                                                                                
+
                                                                                                                                                                                Set to true when this client drives an Enterprise Connect login (enterprise
+SSO resolved from the email domain via isFederatedDomain and login_hint).
                                                                                                                                                                                
+
                                                                                                                                                                                Enterprise Connect issues no refresh token and resolves the organization from
+Home Realm Discovery at login. When enabled, the SDK warns at initialization if
+the configuration contradicts that: useRefreshTokens: true or offline_access
+in scope (no refresh token is issued) or a static organization (HRD resolves
+it, and a static value breaks multi-customer setups).
                                                                                                                                                                                
+
                                                                                                                                                                                This is a routing/telemetry flag only; it does not by itself change the login flow.
                                                                                                                                                                                
+
                                                                                                                                                                                Default: false
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                errorPath?: string
                                                                                                                                                                                
+
                                                                                                                                                                                Path in your application to redirect to when the Authorization server
+returns an error. Defaults to /
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                httpInterceptor?: HttpInterceptorConfig
                                                                                                                                                                                
+
                                                                                                                                                                                Configuration for the built-in Http Interceptor, used for
+automatically attaching access tokens.
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                httpTimeoutInSeconds?: number
                                                                                                                                                                                
+
                                                                                                                                                                                Specify the timeout for HTTP calls using fetch. The default is 10 seconds.
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                interactiveErrorHandler?: "popup"
                                                                                                                                                                                
+
                                                                                                                                                                                Configures automatic handling of interactive authentication errors.
                                                                                                                                                                                
+
                                                                                                                                                                                When set, the SDK intercepts mfa_required errors from getTokenSilently()
+and handles them automatically instead of throwing to the caller.
                                                                                                                                                                                
+
                                                                                                                                                                                  
+
                                                                                                                                                                                • 'popup': Opens Universal Login in a popup to complete MFA.
+The original authorizationParams (audience, scope) are preserved.
+On success, the token is returned. On failure, popup errors are thrown.
                                                                                                                                                                                  • 
+
                                                                                                                                                                                
+
                                                                                                                                                                                This option only affects getTokenSilently(). Other methods are not affected.
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                
+
                                                                                                                                                                                undefined (MFA errors are thrown to the caller)
 
                                                                                                                                                                                
-                
                                                                                                                                                                                
-                
                                                                                                                                                                                
-                  
-                  
                                                                                                                                                                                
-                    https://auth0.com/docs/authenticate/single-sign-on/native-to-web
-                  
                                                                                                                                                                                
-                
                                                                                                                                                                                
-              
                                                                                                                                                                                
-              
-            
                                                                                                                                                                                
-            
                                                                                                                                                                                
-              
-              
                                                                                                                                                                                
-                skipRedirectCallback?:
-                boolean
-              
                                                                                                                                                                                
-              
                                                                                                                                                                                
-                
                                                                                                                                                                                
-                  By default, if the page URL has code and state parameters, the
-                  SDK will assume they are for an Auth0 application and attempt
-                  to exchange the code for a token. In some cases the code might
-                  be for something else (e.g. another OAuth SDK). In these
-                  instances you can instruct the client to ignore them by
-                  setting skipRedirectCallback.
-                
                                                                                                                                                                                
-                
                                                                                                                                                                                AuthModule.forRoot({
                                                                                                                                                                                  skipRedirectCallback: window.location.pathname === '/other-callback'
                                                                                                                                                                                })
+
+
                                                                                                                                                                                +
                                                                                                                                                                                + +
                                                                                                                                                                                issuer?: string
                                                                                                                                                                                +

                                                                                                                                                                                The issuer to be used for validation of JWTs, optionally defaults to the domain above

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + +
                                                                                                                                                                                leeway?: number
                                                                                                                                                                                +

                                                                                                                                                                                The value in seconds used to account for clock skew in JWT expirations. +Typically, this value is no more than a minute or two at maximum. +Defaults to 60s.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + +
                                                                                                                                                                                legacySameSiteCookie?: boolean
                                                                                                                                                                                +

                                                                                                                                                                                Sets an additional cookie with no SameSite attribute to support legacy browsers +that are not compatible with the latest SameSite changes. +This will log a warning on modern browsers, you can disable the warning by setting +this to false but be aware that some older useragents will not work, +See https://www.chromium.org/updates/same-site/incompatible-clients +Defaults to true

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + +
                                                                                                                                                                                nowProvider?: () => number | Promise<number>
                                                                                                                                                                                +

                                                                                                                                                                                Modify the value used as the current time during the token validation.

                                                                                                                                                                                +

                                                                                                                                                                                Note: Using this improperly can potentially compromise the token validation.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + +
                                                                                                                                                                                refreshTokenMode?: RefreshTokenMode
                                                                                                                                                                                +

                                                                                                                                                                                Selects the refresh-token variant used when useRefreshTokens: true. +Defaults to RefreshTokenMode.Offline.

                                                                                                                                                                                + +

                                                                                                                                                                                Online mode requires useRefreshTokens: true and useDpop: true. The +online_access and offline_access scopes are mutually exclusive.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + +
                                                                                                                                                                                sessionCheckExpiryDays?: number
                                                                                                                                                                                +

                                                                                                                                                                                Number of days until the cookie auth0.is.authenticated will expire +Defaults to 1.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + +
                                                                                                                                                                                sessionTransferTokenQueryParamName?: string
                                                                                                                                                                                +

                                                                                                                                                                                Query parameter name to extract the session transfer token from for Native to Web SSO.

                                                                                                                                                                                +

                                                                                                                                                                                When set, the SDK automatically extracts the token from the specified URL query +parameter and includes it as session_transfer_token in authorization requests. +This enables seamless single sign-on when users transition from a native mobile +application to a web application.

                                                                                                                                                                                +

                                                                                                                                                                                After extraction, the token is automatically removed from the URL using +window.history.replaceState() to prevent accidental reuse on subsequent +authentication requests.

                                                                                                                                                                                +

                                                                                                                                                                                Default: undefined (feature disabled)

                                                                                                                                                                                +

                                                                                                                                                                                Common values:

                                                                                                                                                                                +
                                                                                                                                                                                  +
                                                                                                                                                                                • 'session_transfer_token' - Standard parameter name
                                                                                                                                                                                  • +
                                                                                                                                                                                • 'stt' - Shortened version
                                                                                                                                                                                  • +
                                                                                                                                                                                • Custom parameter name of your choice
                                                                                                                                                                                  • +
                                                                                                                                                                                +

                                                                                                                                                                                Set to undefined to disable automatic extraction if you prefer to handle +session transfer tokens manually.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                const auth0 = await createAuth0Client({
                                                                                                                                                                                  domain: '<AUTH0_DOMAIN>',
                                                                                                                                                                                  clientId: '<AUTH0_CLIENT_ID>',
                                                                                                                                                                                  sessionTransferTokenQueryParamName: 'session_transfer_token'
                                                                                                                                                                                });
                                                                                                                                                                                -

                                                                                                                                                                                - Note: In the above example, - /other-callback is an existing route that will be - called by any other OAuth provider with a - code (or error in case when - something went wrong) and state. -

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - useCookiesForTransactions?: - boolean -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - If true, the SDK will use a cookie when storing - information about the auth transaction while the user is going - through the authentication flow on the authorization server. -

                                                                                                                                                                                -

                                                                                                                                                                                - The default is false, in which case the SDK will - use session storage. -

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -

                                                                                                                                                                                - You might want to enable this if you rely on your users - being able to authenticate using flows that may end up - spanning across multiple tabs (e.g. magic links) or you - cannot otherwise rely on session storage being available. -

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - useDpop?: - boolean -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - If true, DPoP (OAuth 2.0 Demonstrating Proof of - Possession, RFC9449) will be used to cryptographically bind - tokens to this specific browser so they can't be used from a - different device in case of a leak. -

                                                                                                                                                                                -

                                                                                                                                                                                The default setting is false.

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - useFormData?: - boolean -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - If true, data to the token endpoint is transmitted as - x-www-form-urlencoded data, if false it will be transmitted as - JSON. The default setting is true. -

                                                                                                                                                                                -

                                                                                                                                                                                - Note: Setting this to false may - affect you if you use Auth0 Rules and are sending custom, - non-primitive data. If you disable this, please verify that - your Auth0 Rules continue to work as intended. -

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - useMrrt?: - boolean -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - If true, the SDK will allow the refreshing of - tokens using MRRT -

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - useRefreshTokens?: - boolean -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - If true, refresh tokens are used to fetch new access tokens - from the Auth0 server. If false, the standard technique of - using a hidden iframe and the - authorization_code grant with - prompt=none is used. The default setting is - false. -

                                                                                                                                                                                -

                                                                                                                                                                                - Standard technique relies on cookies. Because browsers - increasingly block third-party cookies, it requires a Custom - Domain to function reliably. Refresh tokens serve as a - fallback for environments where third-party cookies are - blocked. Using a Custom Domain with this set to - false is the most secure and recommended - approach. -

                                                                                                                                                                                -

                                                                                                                                                                                - Note: Use of refresh tokens must be enabled - by an administrator on your Auth0 client application. -

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - useRefreshTokensFallback?: - boolean -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - If true, fallback to the technique of using a hidden iframe - and the authorization_code grant with - prompt=none when unable to use refresh tokens. If - false, the iframe fallback is not used and errors relating to - a failed refresh_token grant should be handled - appropriately. The default setting is false. -

                                                                                                                                                                                -

                                                                                                                                                                                - Note: There might be situations where doing - silent auth with a Web Message response from an iframe is not - possible, like when you're serving your application from the - file system or a custom protocol (like in a Desktop or Native - app). In situations like this you can disable the iframe - fallback and handle the failed - refresh_token grant and prompt the user to login - interactively with loginWithRedirect or - loginWithPopup." -

                                                                                                                                                                                -

                                                                                                                                                                                - E.g. Using the file: protocol in an Electron - application does not support that legacy technique. -

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - - 
                                                                                                                                                                                let token: string;
                                                                                                                                                                                try {
                                                                                                                                                                                  token = await auth0.getTokenSilently();
                                                                                                                                                                                } catch (e) {
                                                                                                                                                                                  if (e.error === 'missing_refresh_token' || e.error === 'invalid_grant') {
                                                                                                                                                                                    auth0.loginWithRedirect();
                                                                                                                                                                                  }
                                                                                                                                                                                }
+
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                https://auth0.com/docs/authenticate/single-sign-on/native-to-web

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + +
                                                                                                                                                                                skipRedirectCallback?: boolean
                                                                                                                                                                                +

                                                                                                                                                                                By default, if the page URL has code and state parameters, the SDK will assume they are for +an Auth0 application and attempt to exchange the code for a token. +In some cases the code might be for something else (e.g. another OAuth SDK). In these +instances you can instruct the client to ignore them by setting skipRedirectCallback.

                                                                                                                                                                                +
                                                                                                                                                                                AuthModule.forRoot({
                                                                                                                                                                                  skipRedirectCallback: window.location.pathname === '/other-callback'
                                                                                                                                                                                })
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - - -
                                                                                                                                                                                - -
                                                                                                                                                                                - workerUrl?: - string -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - If provided, the SDK will load the token worker from this URL - instead of the integrated blob. An example of - when this is useful is if you have strict - Content-Security-Policy (CSP) and wish to avoid needing to set - worker-src: blob:. We recommend either serving - the worker, which you can find in the module at - <module_path>/dist/auth0-spa-js.worker.production.js, from the same host as your application or using the Auth0 - CDN - https://cdn.auth0.com/js/auth0-spa-js/<version>/auth0-spa-js.worker.production.js. -

                                                                                                                                                                                -

                                                                                                                                                                                - Note: The worker is only used when - useRefreshTokens: true, - cacheLocation: 'memory', and the - cache is not custom. -

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - - -

                                                                                                                                                                                Settings

                                                                                                                                                                                -                                                                                                                                                                                 -
                                                                                                                                                                                -
                                                                                                                                                                                - Member Visibility -
                                                                                                                                                                                  -
                                                                                                                                                                                • - -
                                                                                                                                                                                  • -
                                                                                                                                                                                • - -
                                                                                                                                                                                  • -
                                                                                                                                                                                • - -
                                                                                                                                                                                  • -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - - -

                                                                                                                                                                                On This Page

                                                                                                                                                                                -                                                                                                                                                                                 -
                                                                                                                                                                                -
                                                                                                                                                                                - - Properties - - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - - + +

                                                                                                                                                                                Note: In the above example, /other-callback is an existing route that will be called +by any other OAuth provider with a code (or error in case when something went wrong) and state.

                                                                                                                                                                                + +
                                                                                                                                                                                + +
                                                                                                                                                                                useCookiesForTransactions?: boolean
                                                                                                                                                                                +

                                                                                                                                                                                If true, the SDK will use a cookie when storing information about the auth transaction while +the user is going through the authentication flow on the authorization server.

                                                                                                                                                                                +

                                                                                                                                                                                The default is false, in which case the SDK will use session storage.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                You might want to enable this if you rely on your users being able to authenticate using flows that +may end up spanning across multiple tabs (e.g. magic links) or you cannot otherwise rely on session storage being available.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + +
                                                                                                                                                                                useDpop?: boolean
                                                                                                                                                                                +

                                                                                                                                                                                If true, DPoP (OAuth 2.0 Demonstrating Proof of Possession, RFC9449) +will be used to cryptographically bind tokens to this specific browser +so they can't be used from a different device in case of a leak.

                                                                                                                                                                                +

                                                                                                                                                                                The default setting is false.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + +
                                                                                                                                                                                useFormData?: boolean
                                                                                                                                                                                +

                                                                                                                                                                                If true, data to the token endpoint is transmitted as x-www-form-urlencoded data, if false it will be transmitted as JSON. The default setting is true.

                                                                                                                                                                                +

                                                                                                                                                                                Note: Setting this to false may affect you if you use Auth0 Rules and are sending custom, non-primitive data. If you disable this, +please verify that your Auth0 Rules continue to work as intended.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + +
                                                                                                                                                                                useMrrt?: boolean
                                                                                                                                                                                +

                                                                                                                                                                                If true, the SDK will allow the refreshing of tokens using MRRT

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + +
                                                                                                                                                                                useRefreshTokens?: boolean
                                                                                                                                                                                +

                                                                                                                                                                                If true, refresh tokens are used to fetch new access tokens from the Auth0 server. If false, the standard technique of using a hidden iframe and the authorization_code grant with prompt=none is used. +The default setting is false.

                                                                                                                                                                                +

                                                                                                                                                                                Standard technique relies on cookies. Because browsers increasingly block third-party cookies, it requires a Custom Domain to function reliably. Refresh tokens serve as a fallback for environments where third-party cookies are blocked. +Using a Custom Domain with this set to false is the most secure and recommended approach.

                                                                                                                                                                                +

                                                                                                                                                                                Note: Use of refresh tokens must be enabled by an administrator on your Auth0 client application.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + +
                                                                                                                                                                                useRefreshTokensFallback?: boolean
                                                                                                                                                                                +

                                                                                                                                                                                If true, fallback to the technique of using a hidden iframe and the authorization_code grant with prompt=none when unable to use refresh tokens. If false, the iframe fallback is not used and +errors relating to a failed refresh_token grant should be handled appropriately. The default setting is false.

                                                                                                                                                                                +

                                                                                                                                                                                Note: There might be situations where doing silent auth with a Web Message response from an iframe is not possible, +like when you're serving your application from the file system or a custom protocol (like in a Desktop or Native app). +In situations like this you can disable the iframe fallback and handle the failed refresh_token grant and prompt the user to login interactively with loginWithRedirect or loginWithPopup."

                                                                                                                                                                                +

                                                                                                                                                                                E.g. Using the file: protocol in an Electron application does not support that legacy technique.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                let token: string;
                                                                                                                                                                                try {
                                                                                                                                                                                  token = await auth0.getTokenSilently();
                                                                                                                                                                                } catch (e) {
                                                                                                                                                                                  if (e.error === 'missing_refresh_token' || e.error === 'invalid_grant') {
                                                                                                                                                                                    auth0.loginWithRedirect();
                                                                                                                                                                                  }
                                                                                                                                                                                }
+
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                + +
                                                                                                                                                                                workerUrl?: string
                                                                                                                                                                                +

                                                                                                                                                                                If provided, the SDK will load the token worker from this URL instead of the integrated blob. An example of when this is useful is if you have strict +Content-Security-Policy (CSP) and wish to avoid needing to set worker-src: blob:. We recommend either serving the worker, which you can find in the module +at <module_path>/dist/auth0-spa-js.worker.production.js, from the same host as your application or using the Auth0 CDN +https://cdn.auth0.com/js/auth0-spa-js/<version>/auth0-spa-js.worker.production.js.

                                                                                                                                                                                +

                                                                                                                                                                                Note: The worker is only used when useRefreshTokens: true, cacheLocation: 'memory', and the cache is not custom.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Settings

                                                                                                                                                                                 +
                                                                                                                                                                                +
                                                                                                                                                                                Member Visibility +
                                                                                                                                                                                  +
                                                                                                                                                                                  • +
                                                                                                                                                                                  • +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                On This Page

                                                                                                                                                                                 +
                                                                                                                                                                                +
                                                                                                                                                                                Properties +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                diff --git a/docs/interfaces/AuthorizationParams.html b/docs/interfaces/AuthorizationParams.html index be1d0820..30025e2d 100644 --- a/docs/interfaces/AuthorizationParams.html +++ b/docs/interfaces/AuthorizationParams.html @@ -10,7 +10,7 @@

                                                                                                                                                                                Interface AuthorizationParams

                                                                                                                                                                                -
                                                                                                                                                                                interface AuthorizationParams {
                                                                                                                                                                                    acr_values?: string;
                                                                                                                                                                                    audience?: string;
                                                                                                                                                                                    connection?: string;
                                                                                                                                                                                    display?: "page" | "popup" | "touch" | "wap";
                                                                                                                                                                                    id_token_hint?: string;
                                                                                                                                                                                    invitation?: string;
                                                                                                                                                                                    login_hint?: string;
                                                                                                                                                                                    max_age?: string | number;
                                                                                                                                                                                    organization?: string;
                                                                                                                                                                                    prompt?: "none" | "login" | "consent" | "select_account";
                                                                                                                                                                                    redirect_uri?: string;
                                                                                                                                                                                    scope?: string;
                                                                                                                                                                                    screen_hint?: string;
                                                                                                                                                                                    session_transfer_token?: string;
                                                                                                                                                                                    ui_locales?: string;
                                                                                                                                                                                    [key: string]: any;
                                                                                                                                                                                }
                                                                                                                                                                                +
                                                                                                                                                                                interface AuthorizationParams {
                                                                                                                                                                                    acr_values?: string;
                                                                                                                                                                                    audience?: string;
                                                                                                                                                                                    connection?: string;
                                                                                                                                                                                    display?: "page" | "popup" | "touch" | "wap";
                                                                                                                                                                                    experiment_id?: string;
                                                                                                                                                                                    id_token_hint?: string;
                                                                                                                                                                                    invitation?: string;
                                                                                                                                                                                    login_hint?: string;
                                                                                                                                                                                    max_age?: string | number;
                                                                                                                                                                                    organization?: string;
                                                                                                                                                                                    prompt?: "none" | "login" | "consent" | "select_account";
                                                                                                                                                                                    redirect_uri?: string;
                                                                                                                                                                                    scope?: string;
                                                                                                                                                                                    screen_hint?: string;
                                                                                                                                                                                    segment_id?: string;
                                                                                                                                                                                    session_transfer_token?: string;
                                                                                                                                                                                    ui_locales?: string;
                                                                                                                                                                                    variation_id?: string;
                                                                                                                                                                                    [key: string]: any;
                                                                                                                                                                                }

                                                                                                                                                                                Indexable

                                                                                                                                                                                @@ -81,6 +84,24 @@
                                                                                                                                                                              + +
                                                                                                                                                                              experiment_id?: string
                                                                                                                                                                              +

                                                                                                                                                                              Forces a specific Experiment Center variant for this /authorize request +instead of letting Auth0 assign one via its hash. Use together with +variation_id.

                                                                                                                                                                              +

                                                                                                                                                                              Pass per-call (on loginWithRedirect/loginWithPopup) rather than at +client construction time so the override does not bleed into silent +prompt=none token-renewal calls, where Experiment Center does not run.

                                                                                                                                                                              +

                                                                                                                                                                              Testing: drive from test automation (e.g. Cypress/Playwright) with IDs +from a CI environment variable against a staging tenant. Do not hard-code +this in shipped app code.

                                                                                                                                                                              +

                                                                                                                                                                              Production: pass the variant decision from a feature-flag tool +(e.g. LaunchDarkly) that has already decided which variant the user should +see for this request.

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              id_token_hint?: string

                                                                                                                                                                              Previously issued ID Token.

                                                                                                                                                                              @@ -171,6 +192,14 @@
                                                                                                                                                                              + +
                                                                                                                                                                              segment_id?: string
                                                                                                                                                                              +

                                                                                                                                                                              An optional segment identifier to pass alongside experiment_id and +variation_id when forcing a variant.

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              session_transfer_token?: string

                                                                                                                                                                              Session transfer token from a native application for Native to Web SSO. @@ -190,7 +219,17 @@

                                                                                                                                                                              +
                                                                                                                                                                            • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:46
                                                                                                                                                                              • +
                                                                                                                                                                              + +
                                                                                                                                                                              variation_id?: string
                                                                                                                                                                              +

                                                                                                                                                                              The variation to force within the experiment identified by experiment_id. +Auth0 uses this value instead of computing an assignment for the current +request. The override applies to this request only; the next login without +these params reverts to normal server-side assignment.

                                                                                                                                                                              +
                                                                                                                                                                              @@ -207,7 +246,7 @@

                                                                                                                                                                              Settings

                                                                                                                                                                              On This Page

                                                                                                                                                                              Properties -
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                                +
                                                                                                                                                                              • + +
                                                                                                                                                                                +

                                                                                                                                                                                Register a new user with a passkey.

                                                                                                                                                                                +

                                                                                                                                                                                Handles the full flow: requests a signup challenge, triggers the browser +WebAuthn credential creation ceremony, serializes the result, and exchanges +it for tokens.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Parameters

                                                                                                                                                                                +
                                                                                                                                                                                  +
                                                                                                                                                                                • options: PasskeySignupOptions +

                                                                                                                                                                                  Passkey signup options (user identifier, optional scope/audience)

                                                                                                                                                                                  +
                                                                                                                                                                                +

                                                                                                                                                                                Returns Promise<TokenEndpointResponse>

                                                                                                                                                                                A promise that resolves to the token endpoint response containing access/ID tokens

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                If WebAuthn is not supported in the browser

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                If the challenge request fails

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                If the token exchange fails

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                If the user cancels the WebAuthn prompt

                                                                                                                                                                                +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              Settings

                                                                                                                                                                               +
                                                                                                                                                                              +
                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                                • +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              On This Page

                                                                                                                                                                               +
                                                                                                                                                                              +
                                                                                                                                                                              Methods +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              diff --git a/docs/interfaces/PasskeyAuthenticationMethod.html b/docs/interfaces/PasskeyAuthenticationMethod.html index 3f4b5a13..48e4d62a 100644 --- a/docs/interfaces/PasskeyAuthenticationMethod.html +++ b/docs/interfaces/PasskeyAuthenticationMethod.html @@ -1,1124 +1,147 @@ - - - - - - PasskeyAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                -
                                                                                                                                                                                -                                                                                                                                                                                 - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -

                                                                                                                                                                                Interface PasskeyAuthenticationMethod

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - interface - PasskeyAuthenticationMethod - {
                                                                                                                                                                                    aaguid?: - string;
                                                                                                                                                                                    created_at: - string;
                                                                                                                                                                                    credential_backed_up: - boolean;
                                                                                                                                                                                    credential_device_type: - "single_device" - | - "multi_device";
                                                                                                                                                                                    id: - string;
                                                                                                                                                                                    identity_user_id: - string;
                                                                                                                                                                                    key_id: - string;
                                                                                                                                                                                    last_auth_at?: - string;
                                                                                                                                                                                    public_key: - string;
                                                                                                                                                                                    relying_party_id?: - string;
                                                                                                                                                                                    transports?: - string[];
                                                                                                                                                                                    type: - "passkey";
                                                                                                                                                                                    usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                    user_agent?: - string;
                                                                                                                                                                                    user_handle: - string;
                                                                                                                                                                                } -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                Hierarchy

                                                                                                                                                                                -
                                                                                                                                                                                  -
                                                                                                                                                                                • - AuthenticationMethodBase -
                                                                                                                                                                                    -
                                                                                                                                                                                  • - PasskeyAuthenticationMethod -
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                  • -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - - -
                                                                                                                                                                                Index
                                                                                                                                                                                -                                                                                                                                                                                 -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - - aaguid? - - created_at - - credential_backed_up - - credential_device_type - - id - - identity_user_id - - key_id - - last_auth_at? - - public_key - - relying_party_id? - - transports? - - type - - usage - - user_agent? - - user_handle -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - aaguid?: - string -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - created_at: - string -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - credential_backed_up: - boolean -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - credential_device_type: - "single_device" - | - "multi_device" -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - id: - string -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - identity_user_id: - string -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - key_id: - string -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - last_auth_at?: - string -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - public_key: - string -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - relying_party_id?: - string -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - transports?: - string[] -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - type: - "passkey" -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - user_agent?: - string -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - user_handle: - string -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - - -

                                                                                                                                                                                Settings

                                                                                                                                                                                -                                                                                                                                                                                 -
                                                                                                                                                                                -
                                                                                                                                                                                - Member Visibility -
                                                                                                                                                                                  -
                                                                                                                                                                                • - -
                                                                                                                                                                                  • -
                                                                                                                                                                                • - -
                                                                                                                                                                                  • -
                                                                                                                                                                                • - -
                                                                                                                                                                                  • -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - - -

                                                                                                                                                                                On This Page

                                                                                                                                                                                -                                                                                                                                                                                 -
                                                                                                                                                                                -
                                                                                                                                                                                - - Properties - - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - - +PasskeyAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                +
                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +

                                                                                                                                                                                  Interface PasskeyAuthenticationMethod

                                                                                                                                                                                  +
                                                                                                                                                                                  interface PasskeyAuthenticationMethod {
                                                                                                                                                                                      aaguid?: string;
                                                                                                                                                                                      created_at: string;
                                                                                                                                                                                      credential_backed_up: boolean;
                                                                                                                                                                                      credential_device_type: "single_device" | "multi_device";
                                                                                                                                                                                      id: string;
                                                                                                                                                                                      identity_user_id: string;
                                                                                                                                                                                      key_id: string;
                                                                                                                                                                                      last_auth_at?: string;
                                                                                                                                                                                      public_key: string;
                                                                                                                                                                                      relying_party_id?: string;
                                                                                                                                                                                      transports?: string[];
                                                                                                                                                                                      type: "passkey";
                                                                                                                                                                                      usage: ("primary" | "secondary")[];
                                                                                                                                                                                      user_agent?: string;
                                                                                                                                                                                      user_handle: string;
                                                                                                                                                                                  }
                                                                                                                                                                                  +
                                                                                                                                                                                  +

                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                  +
                                                                                                                                                                                    +
                                                                                                                                                                                  • AuthenticationMethodBase +
                                                                                                                                                                                      +
                                                                                                                                                                                    • PasskeyAuthenticationMethod
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  Index
                                                                                                                                                                                   +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  aaguid? +created_at +credential_backed_up +credential_device_type +id +identity_user_id +key_id +last_auth_at? +public_key +relying_party_id? +transports? +type +usage +user_agent? +user_handle +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  aaguid?: string
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  created_at: string
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  credential_backed_up: boolean
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  credential_device_type: "single_device" | "multi_device"
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  id: string
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  identity_user_id: string
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  key_id: string
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  last_auth_at?: string
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  public_key: string
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  relying_party_id?: string
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  transports?: string[]
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  type: "passkey"
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  usage: ("primary" | "secondary")[]
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  user_agent?: string
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  user_handle: string
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +

                                                                                                                                                                                  Settings

                                                                                                                                                                                   +
                                                                                                                                                                                  +
                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                    +
                                                                                                                                                                                    • +
                                                                                                                                                                                    • +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +

                                                                                                                                                                                  On This Page

                                                                                                                                                                                   +
                                                                                                                                                                                  +
                                                                                                                                                                                  Properties +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  diff --git a/docs/interfaces/PasskeyCreationOptions.html b/docs/interfaces/PasskeyCreationOptions.html index c7b97ad1..fca74cc8 100644 --- a/docs/interfaces/PasskeyCreationOptions.html +++ b/docs/interfaces/PasskeyCreationOptions.html @@ -1,717 +1,87 @@ - - - - - - PasskeyCreationOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                    -
                                                                                                                                                                                    -                                                                                                                                                                                     - -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -

                                                                                                                                                                                    Interface PasskeyCreationOptions

                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -

                                                                                                                                                                                    - Public key credential creation options returned by signup - challenges. -

                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    - interface - PasskeyCreationOptions - {
                                                                                                                                                                                        authenticatorSelection?: - {
                                                                                                                                                                                            residentKey?: - string;
                                                                                                                                                                                            userVerification?: - string;
                                                                                                                                                                                        };
                                                                                                                                                                                        challenge: - string;
                                                                                                                                                                                        pubKeyCredParams: - { - alg: - number; - type: - string - }[];
                                                                                                                                                                                        rp: - { - id: - string; - name: - string - };
                                                                                                                                                                                        timeout?: - number;
                                                                                                                                                                                        user: - { - displayName: - string; - id: - string; - name: - string - };
                                                                                                                                                                                    } -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    - - -
                                                                                                                                                                                    Index
                                                                                                                                                                                    -                                                                                                                                                                                     -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    - - authenticatorSelection? - - challenge - - pubKeyCredParams - - rp - - timeout? - - user -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    - authenticatorSelection?: - { - residentKey?: - string; - userVerification?: - string - } -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    - challenge: - string -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    - pubKeyCredParams: - { - alg: - number; - type: - string - }[] -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    - rp: - { - id: - string; - name: - string - } -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    - timeout?: - number -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    - user: - { - displayName: - string; - id: - string; - name: - string - } -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    - - -

                                                                                                                                                                                    Settings

                                                                                                                                                                                    -                                                                                                                                                                                     -
                                                                                                                                                                                    -
                                                                                                                                                                                    - Member Visibility -
                                                                                                                                                                                      -
                                                                                                                                                                                    • - -
                                                                                                                                                                                      • -
                                                                                                                                                                                    • - -
                                                                                                                                                                                      • -
                                                                                                                                                                                    • - -
                                                                                                                                                                                      • -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    - - -

                                                                                                                                                                                    On This Page

                                                                                                                                                                                    -                                                                                                                                                                                     -
                                                                                                                                                                                    -
                                                                                                                                                                                    - - Properties - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    - - +PasskeyCreationOptions | @auth0/auth0-angular
                                                                                                                                                                                    +
                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      + +

                                                                                                                                                                                      Interface PasskeyCreationOptions

                                                                                                                                                                                      +
                                                                                                                                                                                      +

                                                                                                                                                                                      Public key credential creation options returned by signup challenges.

                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      interface PasskeyCreationOptions {
                                                                                                                                                                                          authenticatorSelection?: {
                                                                                                                                                                                              residentKey?: string;
                                                                                                                                                                                              userVerification?: string;
                                                                                                                                                                                          };
                                                                                                                                                                                          challenge: string;
                                                                                                                                                                                          pubKeyCredParams: { alg: number; type: string }[];
                                                                                                                                                                                          rp: { id: string; name: string };
                                                                                                                                                                                          timeout?: number;
                                                                                                                                                                                          user: { displayName: string; id: string; name: string };
                                                                                                                                                                                      }
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Index
                                                                                                                                                                                       +
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      authenticatorSelection? +challenge +pubKeyCredParams +rp +timeout? +user +
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      authenticatorSelection?: { residentKey?: string; userVerification?: string }
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      challenge: string
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      pubKeyCredParams: { alg: number; type: string }[]
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      rp: { id: string; name: string }
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      timeout?: number
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      user: { displayName: string; id: string; name: string }
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +

                                                                                                                                                                                      Settings

                                                                                                                                                                                       +
                                                                                                                                                                                      +
                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                        +
                                                                                                                                                                                        • +
                                                                                                                                                                                        • +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +

                                                                                                                                                                                      On This Page

                                                                                                                                                                                       +
                                                                                                                                                                                      +
                                                                                                                                                                                      Properties +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      diff --git a/docs/interfaces/PasskeyCredentialResponse.html b/docs/interfaces/PasskeyCredentialResponse.html index bab48bec..8311a4ed 100644 --- a/docs/interfaces/PasskeyCredentialResponse.html +++ b/docs/interfaces/PasskeyCredentialResponse.html @@ -1,705 +1,88 @@ - - - - - - PasskeyCredentialResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                      -
                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                        -
                                                                                                                                                                                        -                                                                                                                                                                                         - -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        - -

                                                                                                                                                                                        Interface PasskeyCredentialResponse

                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -

                                                                                                                                                                                        - Serialized credential response from the platform WebAuthn API. All - binary fields (rawId, clientDataJSON, etc.) must be - base64url-encoded strings. -

                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        - interface - PasskeyCredentialResponse - {
                                                                                                                                                                                            authenticatorAttachment?: - string;
                                                                                                                                                                                            clientExtensionResults?: - Record<string, - unknown>;
                                                                                                                                                                                            id: - string;
                                                                                                                                                                                            rawId: - string;
                                                                                                                                                                                            response: - {
                                                                                                                                                                                                attestationObject?: - string;
                                                                                                                                                                                                authenticatorData?: - string;
                                                                                                                                                                                                clientDataJSON: - string;
                                                                                                                                                                                                signature?: - string;
                                                                                                                                                                                                userHandle?: - string;
                                                                                                                                                                                            };
                                                                                                                                                                                            type: - string;
                                                                                                                                                                                        } -
                                                                                                                                                                                        - -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        Index
                                                                                                                                                                                        -                                                                                                                                                                                         -
                                                                                                                                                                                        -
                                                                                                                                                                                        - -
                                                                                                                                                                                        - - authenticatorAttachment? - - clientExtensionResults? - - id - - rawId - - response - - type -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - -
                                                                                                                                                                                        - authenticatorAttachment?: - string -
                                                                                                                                                                                        - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - -
                                                                                                                                                                                        - clientExtensionResults?: - Record<string, - unknown> -
                                                                                                                                                                                        - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - -
                                                                                                                                                                                        - id: - string -
                                                                                                                                                                                        - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - -
                                                                                                                                                                                        - rawId: - string -
                                                                                                                                                                                        - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - -
                                                                                                                                                                                        - response: - {
                                                                                                                                                                                            attestationObject?: - string;
                                                                                                                                                                                            authenticatorData?: - string;
                                                                                                                                                                                            clientDataJSON: - string;
                                                                                                                                                                                            signature?: - string;
                                                                                                                                                                                            userHandle?: - string;
                                                                                                                                                                                        } -
                                                                                                                                                                                        - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - -
                                                                                                                                                                                        - type: - string -
                                                                                                                                                                                        - -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -

                                                                                                                                                                                        Settings

                                                                                                                                                                                        -                                                                                                                                                                                         -
                                                                                                                                                                                        -
                                                                                                                                                                                        - Member Visibility -
                                                                                                                                                                                          -
                                                                                                                                                                                        • - -
                                                                                                                                                                                          • -
                                                                                                                                                                                        • - -
                                                                                                                                                                                          • -
                                                                                                                                                                                        • - -
                                                                                                                                                                                          • -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        - -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -

                                                                                                                                                                                        On This Page

                                                                                                                                                                                        -                                                                                                                                                                                         -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - Properties - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        - -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - +PasskeyCredentialResponse | @auth0/auth0-angular
                                                                                                                                                                                        +
                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          + +

                                                                                                                                                                                          Interface PasskeyCredentialResponse

                                                                                                                                                                                          +
                                                                                                                                                                                          +

                                                                                                                                                                                          Serialized credential response from the platform WebAuthn API. +All binary fields (rawId, clientDataJSON, etc.) must be base64url-encoded strings.

                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          interface PasskeyCredentialResponse {
                                                                                                                                                                                              authenticatorAttachment?: string;
                                                                                                                                                                                              clientExtensionResults?: Record<string, unknown>;
                                                                                                                                                                                              id: string;
                                                                                                                                                                                              rawId: string;
                                                                                                                                                                                              response: {
                                                                                                                                                                                                  attestationObject?: string;
                                                                                                                                                                                                  authenticatorData?: string;
                                                                                                                                                                                                  clientDataJSON: string;
                                                                                                                                                                                                  signature?: string;
                                                                                                                                                                                                  userHandle?: string;
                                                                                                                                                                                              };
                                                                                                                                                                                              type: string;
                                                                                                                                                                                          }
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Index
                                                                                                                                                                                           +
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          authenticatorAttachment? +clientExtensionResults? +id +rawId +response +type +
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          authenticatorAttachment?: string
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          clientExtensionResults?: Record<string, unknown>
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          id: string
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          rawId: string
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          response: {
                                                                                                                                                                                              attestationObject?: string;
                                                                                                                                                                                              authenticatorData?: string;
                                                                                                                                                                                              clientDataJSON: string;
                                                                                                                                                                                              signature?: string;
                                                                                                                                                                                              userHandle?: string;
                                                                                                                                                                                          }
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          type: string
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +

                                                                                                                                                                                          Settings

                                                                                                                                                                                           +
                                                                                                                                                                                          +
                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                            +
                                                                                                                                                                                            • +
                                                                                                                                                                                            • +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +

                                                                                                                                                                                          On This Page

                                                                                                                                                                                           +
                                                                                                                                                                                          +
                                                                                                                                                                                          Properties +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          diff --git a/docs/interfaces/PasskeyEnrollmentChallengeResponse.html b/docs/interfaces/PasskeyEnrollmentChallengeResponse.html index 64757d7d..4fc7f831 100644 --- a/docs/interfaces/PasskeyEnrollmentChallengeResponse.html +++ b/docs/interfaces/PasskeyEnrollmentChallengeResponse.html @@ -1,634 +1,87 @@ - - - - - - PasskeyEnrollmentChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                            -
                                                                                                                                                                                            -                                                                                                                                                                                             - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -

                                                                                                                                                                                            Interface PasskeyEnrollmentChallengeResponse

                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - interface - PasskeyEnrollmentChallengeResponse - {
                                                                                                                                                                                                auth_session: - string;
                                                                                                                                                                                                authn_params_public_key: - PasskeyCreationOptions;
                                                                                                                                                                                                id: - string;
                                                                                                                                                                                                location: - string;
                                                                                                                                                                                                type: - "passkey";
                                                                                                                                                                                            } -
                                                                                                                                                                                            -
                                                                                                                                                                                            -

                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                            -
                                                                                                                                                                                              -
                                                                                                                                                                                            • - EnrollmentChallengeBaseResponse -
                                                                                                                                                                                                -
                                                                                                                                                                                              • - PasskeyEnrollmentChallengeResponse -
                                                                                                                                                                                                • -
                                                                                                                                                                                              -
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - - -
                                                                                                                                                                                            Index
                                                                                                                                                                                            -                                                                                                                                                                                             -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -
                                                                                                                                                                                            - - auth_session - - authn_params_public_key - - id - - location - - type -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - - - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -
                                                                                                                                                                                            - auth_session: - string -
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -
                                                                                                                                                                                            - authn_params_public_key: - PasskeyCreationOptions -
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -
                                                                                                                                                                                            - id: - string -
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -
                                                                                                                                                                                            - location: - string -
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -
                                                                                                                                                                                            - type: - "passkey" -
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - - -

                                                                                                                                                                                            Settings

                                                                                                                                                                                            -                                                                                                                                                                                             -
                                                                                                                                                                                            -
                                                                                                                                                                                            - Member Visibility -
                                                                                                                                                                                              -
                                                                                                                                                                                            • - -
                                                                                                                                                                                              • -
                                                                                                                                                                                            • - -
                                                                                                                                                                                              • -
                                                                                                                                                                                            • - -
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - - -

                                                                                                                                                                                            On This Page

                                                                                                                                                                                            -                                                                                                                                                                                             -
                                                                                                                                                                                            -
                                                                                                                                                                                            - - Properties - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - - +PasskeyEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                            +
                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              + +

                                                                                                                                                                                              Interface PasskeyEnrollmentChallengeResponse

                                                                                                                                                                                              +
                                                                                                                                                                                              interface PasskeyEnrollmentChallengeResponse {
                                                                                                                                                                                                  auth_session: string;
                                                                                                                                                                                                  authn_params_public_key: PasskeyCreationOptions;
                                                                                                                                                                                                  id: string;
                                                                                                                                                                                                  location: string;
                                                                                                                                                                                                  type: "passkey";
                                                                                                                                                                                              }
                                                                                                                                                                                              +
                                                                                                                                                                                              +

                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                              +
                                                                                                                                                                                                +
                                                                                                                                                                                              • EnrollmentChallengeBaseResponse +
                                                                                                                                                                                                  +
                                                                                                                                                                                                • PasskeyEnrollmentChallengeResponse
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Index
                                                                                                                                                                                               +
                                                                                                                                                                                              +
                                                                                                                                                                                              + +
                                                                                                                                                                                              auth_session +authn_params_public_key +id +location +type +
                                                                                                                                                                                              +
                                                                                                                                                                                              + +
                                                                                                                                                                                              +
                                                                                                                                                                                              + +
                                                                                                                                                                                              auth_session: string
                                                                                                                                                                                              +
                                                                                                                                                                                              + +
                                                                                                                                                                                              authn_params_public_key: PasskeyCreationOptions
                                                                                                                                                                                              +
                                                                                                                                                                                              + +
                                                                                                                                                                                              id: string
                                                                                                                                                                                              +
                                                                                                                                                                                              + +
                                                                                                                                                                                              location: string
                                                                                                                                                                                              +
                                                                                                                                                                                              + +
                                                                                                                                                                                              type: "passkey"
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +

                                                                                                                                                                                              Settings

                                                                                                                                                                                               +
                                                                                                                                                                                              +
                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                +
                                                                                                                                                                                                • +
                                                                                                                                                                                                • +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +

                                                                                                                                                                                              On This Page

                                                                                                                                                                                               +
                                                                                                                                                                                              +
                                                                                                                                                                                              Properties +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              diff --git a/docs/interfaces/PasskeyEnrollmentVerifyOptions.html b/docs/interfaces/PasskeyEnrollmentVerifyOptions.html index c0084e86..aa3e61b8 100644 --- a/docs/interfaces/PasskeyEnrollmentVerifyOptions.html +++ b/docs/interfaces/PasskeyEnrollmentVerifyOptions.html @@ -1,574 +1,80 @@ - - - - - - PasskeyEnrollmentVerifyOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                -
                                                                                                                                                                                                -                                                                                                                                                                                                 - -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                - -

                                                                                                                                                                                                Interface PasskeyEnrollmentVerifyOptions

                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                - interface - PasskeyEnrollmentVerifyOptions - {
                                                                                                                                                                                                    auth_session: - string;
                                                                                                                                                                                                    authn_response: - PasskeyCredentialResponse;
                                                                                                                                                                                                    location: - string;
                                                                                                                                                                                                    type: - "passkey";
                                                                                                                                                                                                } -
                                                                                                                                                                                                -
                                                                                                                                                                                                -

                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                -
                                                                                                                                                                                                  -
                                                                                                                                                                                                • - EnrollmentVerifyBaseOptions -
                                                                                                                                                                                                    -
                                                                                                                                                                                                  • - PasskeyEnrollmentVerifyOptions -
                                                                                                                                                                                                    • -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  • -
                                                                                                                                                                                                -
                                                                                                                                                                                                - -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                Index
                                                                                                                                                                                                -                                                                                                                                                                                                 -
                                                                                                                                                                                                -
                                                                                                                                                                                                - -
                                                                                                                                                                                                - - auth_session - - authn_response - - location - - type -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - -
                                                                                                                                                                                                - auth_session: - string -
                                                                                                                                                                                                - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - -
                                                                                                                                                                                                - authn_response: - PasskeyCredentialResponse -
                                                                                                                                                                                                - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - -
                                                                                                                                                                                                - location: - string -
                                                                                                                                                                                                - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - -
                                                                                                                                                                                                - type: - "passkey" -
                                                                                                                                                                                                - -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -

                                                                                                                                                                                                Settings

                                                                                                                                                                                                -                                                                                                                                                                                                 -
                                                                                                                                                                                                -
                                                                                                                                                                                                - Member Visibility -
                                                                                                                                                                                                  -
                                                                                                                                                                                                • - -
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • - -
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • - -
                                                                                                                                                                                                  • -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                - -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -

                                                                                                                                                                                                On This Page

                                                                                                                                                                                                -                                                                                                                                                                                                 -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - Properties - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                - -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - +PasskeyEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                +
                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +

                                                                                                                                                                                                  Interface PasskeyEnrollmentVerifyOptions

                                                                                                                                                                                                  +
                                                                                                                                                                                                  interface PasskeyEnrollmentVerifyOptions {
                                                                                                                                                                                                      auth_session: string;
                                                                                                                                                                                                      authn_response: PasskeyCredentialResponse;
                                                                                                                                                                                                      location: string;
                                                                                                                                                                                                      type: "passkey";
                                                                                                                                                                                                  }
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +

                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                  +
                                                                                                                                                                                                    +
                                                                                                                                                                                                  • EnrollmentVerifyBaseOptions +
                                                                                                                                                                                                      +
                                                                                                                                                                                                    • PasskeyEnrollmentVerifyOptions
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Index
                                                                                                                                                                                                   +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  auth_session +authn_response +location +type +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  auth_session: string
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  authn_response: PasskeyCredentialResponse
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  location: string
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  type: "passkey"
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +

                                                                                                                                                                                                  Settings

                                                                                                                                                                                                   +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    • +
                                                                                                                                                                                                    • +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +

                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                   +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  diff --git a/docs/interfaces/PasskeyLoginChallengeOptions.html b/docs/interfaces/PasskeyLoginChallengeOptions.html index 9d8e9516..99777c68 100644 --- a/docs/interfaces/PasskeyLoginChallengeOptions.html +++ b/docs/interfaces/PasskeyLoginChallengeOptions.html @@ -1,458 +1,67 @@ - - - - - - PasskeyLoginChallengeOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -                                                                                                                                                                                                     - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    Interface PasskeyLoginChallengeOptions

                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Options for requesting a passkey login challenge.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - interface - PasskeyLoginChallengeOptions - {
                                                                                                                                                                                                        organization?: - string;
                                                                                                                                                                                                        realm?: - string;
                                                                                                                                                                                                    } -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    Index
                                                                                                                                                                                                    -                                                                                                                                                                                                     -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - organization? - - realm? -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - organization?: - string -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    - Organization ID or name (scopes tokens to the organization - context) -

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - realm?: - string -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    - Database connection name (sent as realm to the - API) -

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -

                                                                                                                                                                                                    Settings

                                                                                                                                                                                                    -                                                                                                                                                                                                     -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - Member Visibility -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • - -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • - -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • - -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -

                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                    -                                                                                                                                                                                                     -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - Properties - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - +PasskeyLoginChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                    +
                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +

                                                                                                                                                                                                      Interface PasskeyLoginChallengeOptions

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +

                                                                                                                                                                                                      Options for requesting a passkey login challenge.

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      interface PasskeyLoginChallengeOptions {
                                                                                                                                                                                                          organization?: string;
                                                                                                                                                                                                          realm?: string;
                                                                                                                                                                                                      }
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Index
                                                                                                                                                                                                       +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      organization? +realm? +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      organization?: string
                                                                                                                                                                                                      +

                                                                                                                                                                                                      Organization ID or name (scopes tokens to the organization context)

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      realm?: string
                                                                                                                                                                                                      +

                                                                                                                                                                                                      Database connection name (sent as realm to the API)

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                       +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        • +
                                                                                                                                                                                                        • +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +

                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                       +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      diff --git a/docs/interfaces/PasskeyLoginChallengeResponse.html b/docs/interfaces/PasskeyLoginChallengeResponse.html index 64100897..f63d47dd 100644 --- a/docs/interfaces/PasskeyLoginChallengeResponse.html +++ b/docs/interfaces/PasskeyLoginChallengeResponse.html @@ -1,458 +1,63 @@ - - - - - - PasskeyLoginChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -                                                                                                                                                                                                         - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - -

                                                                                                                                                                                                        Interface PasskeyLoginChallengeResponse

                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Response from a passkey login challenge request.

                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - interface - PasskeyLoginChallengeResponse - {
                                                                                                                                                                                                            authnParamsPublicKey: - PasskeyRequestOptions;
                                                                                                                                                                                                            authSession: - string;
                                                                                                                                                                                                        } -
                                                                                                                                                                                                        - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - - -
                                                                                                                                                                                                        Index
                                                                                                                                                                                                        -                                                                                                                                                                                                         -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - -
                                                                                                                                                                                                        - - authnParamsPublicKey - - authSession -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - - - - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - -
                                                                                                                                                                                                        - authnParamsPublicKey: - PasskeyRequestOptions -
                                                                                                                                                                                                        - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - -
                                                                                                                                                                                                        - authSession: - string -
                                                                                                                                                                                                        - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - - -

                                                                                                                                                                                                        Settings

                                                                                                                                                                                                        -                                                                                                                                                                                                         -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - Member Visibility -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • - -
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • - -
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • - -
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - - -

                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                        -                                                                                                                                                                                                         -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - - Properties - - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - - +PasskeyLoginChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                        +
                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Interface PasskeyLoginChallengeResponse

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +

                                                                                                                                                                                                          Response from a passkey login challenge request.

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          interface PasskeyLoginChallengeResponse {
                                                                                                                                                                                                              authnParamsPublicKey: PasskeyRequestOptions;
                                                                                                                                                                                                              authSession: string;
                                                                                                                                                                                                          }
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Index
                                                                                                                                                                                                           +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          authnParamsPublicKey +authSession +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          authnParamsPublicKey: PasskeyRequestOptions
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          authSession: string
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                           +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            • +
                                                                                                                                                                                                            • +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +

                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                           +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Properties +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          diff --git a/docs/interfaces/PasskeyRequestOptions.html b/docs/interfaces/PasskeyRequestOptions.html index 78ac1397..43f300ba 100644 --- a/docs/interfaces/PasskeyRequestOptions.html +++ b/docs/interfaces/PasskeyRequestOptions.html @@ -1,564 +1,81 @@ - - - - - - PasskeyRequestOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -                                                                                                                                                                                                             - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -

                                                                                                                                                                                                            Interface PasskeyRequestOptions

                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -

                                                                                                                                                                                                            - Public key credential request options returned by login challenges - (rpId, timeout, userVerification). -

                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -

                                                                                                                                                                                                            - This interface describes WebAuthn challenge parameters and is - unrelated to RequestOptions which controls per-request HTTP - settings (signal, headers, customFetch). In a future major, this - type will be renamed to PasskeyChallengeOptions to - eliminate the naming ambiguity. -

                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - interface - PasskeyRequestOptions - {
                                                                                                                                                                                                                challenge: - string;
                                                                                                                                                                                                                rpId: - string;
                                                                                                                                                                                                                timeout?: - number;
                                                                                                                                                                                                                userVerification?: - string;
                                                                                                                                                                                                            } -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - - -
                                                                                                                                                                                                            Index
                                                                                                                                                                                                            -                                                                                                                                                                                                             -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            - - challenge - - rpId - - timeout? - - userVerification? -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - - - - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            - challenge: - string -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            - rpId: - string -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            - timeout?: - number -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            - userVerification?: - string -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - - -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            -                                                                                                                                                                                                             -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - Member Visibility -
                                                                                                                                                                                                              -
                                                                                                                                                                                                            • - -
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • - -
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • - -
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - - -

                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                            -                                                                                                                                                                                                             -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - - Properties - - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - - +PasskeyRequestOptions | @auth0/auth0-angular
                                                                                                                                                                                                            +
                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +

                                                                                                                                                                                                              Interface PasskeyRequestOptions

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +

                                                                                                                                                                                                              Public key credential request options returned by login challenges (rpId, timeout, userVerification).

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +

                                                                                                                                                                                                              This interface describes WebAuthn challenge parameters and is unrelated to +RequestOptions which controls per-request HTTP settings (signal, headers, customFetch). +In a future major, this type will be renamed to PasskeyChallengeOptions to eliminate the naming ambiguity.

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              interface PasskeyRequestOptions {
                                                                                                                                                                                                                  challenge: string;
                                                                                                                                                                                                                  rpId: string;
                                                                                                                                                                                                                  timeout?: number;
                                                                                                                                                                                                                  userVerification?: string;
                                                                                                                                                                                                              }
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Index
                                                                                                                                                                                                               +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              challenge +rpId +timeout? +userVerification? +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              challenge: string
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              rpId: string
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              timeout?: number
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              userVerification?: string
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +

                                                                                                                                                                                                              Settings

                                                                                                                                                                                                               +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                • +
                                                                                                                                                                                                                • +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +

                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                               +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Properties +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              diff --git a/docs/interfaces/PasskeySignupChallengeResponse.html b/docs/interfaces/PasskeySignupChallengeResponse.html index f31d6b4b..0a97ea4a 100644 --- a/docs/interfaces/PasskeySignupChallengeResponse.html +++ b/docs/interfaces/PasskeySignupChallengeResponse.html @@ -1,458 +1,63 @@ - - - - - - PasskeySignupChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -                                                                                                                                                                                                                 - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -

                                                                                                                                                                                                                Interface PasskeySignupChallengeResponse

                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -

                                                                                                                                                                                                                Response from a passkey signup challenge request.

                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - interface - PasskeySignupChallengeResponse - {
                                                                                                                                                                                                                    authnParamsPublicKey: - PasskeyCreationOptions;
                                                                                                                                                                                                                    authSession: - string;
                                                                                                                                                                                                                } -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                Index
                                                                                                                                                                                                                -                                                                                                                                                                                                                 -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                - - authnParamsPublicKey - - authSession -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                - authnParamsPublicKey: - PasskeyCreationOptions -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                - authSession: - string -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                -                                                                                                                                                                                                                 -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - Member Visibility -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                -                                                                                                                                                                                                                 -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - - Properties - - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - - +PasskeySignupChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                +
                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                  Interface PasskeySignupChallengeResponse

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Response from a passkey signup challenge request.

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  interface PasskeySignupChallengeResponse {
                                                                                                                                                                                                                      authnParamsPublicKey: PasskeyCreationOptions;
                                                                                                                                                                                                                      authSession: string;
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                   +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  authnParamsPublicKey +authSession +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  authnParamsPublicKey: PasskeyCreationOptions
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  authSession: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                   +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                   +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  diff --git a/docs/interfaces/PasswordAuthenticationMethod.html b/docs/interfaces/PasswordAuthenticationMethod.html index 62790ce4..b4db60e7 100644 --- a/docs/interfaces/PasswordAuthenticationMethod.html +++ b/docs/interfaces/PasswordAuthenticationMethod.html @@ -1,672 +1,93 @@ - - - - - - PasswordAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -                                                                                                                                                                                                                     - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                    Interface PasswordAuthenticationMethod

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - interface - PasswordAuthenticationMethod - {
                                                                                                                                                                                                                        created_at: - string;
                                                                                                                                                                                                                        id: - string;
                                                                                                                                                                                                                        identity_user_id: - string;
                                                                                                                                                                                                                        last_password_reset?: - string;
                                                                                                                                                                                                                        type: - "password";
                                                                                                                                                                                                                        usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                                                    } -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • - AuthenticationMethodBase -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • - PasswordAuthenticationMethod -
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                    -                                                                                                                                                                                                                     -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    - - created_at - - id - - identity_user_id - - last_password_reset? - - type - - usage -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    - created_at: - string -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    - id: - string -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    - identity_user_id: - string -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    - last_password_reset?: - string -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    - type: - "password" -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                    -                                                                                                                                                                                                                     -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - Member Visibility -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                    -                                                                                                                                                                                                                     -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - - Properties - - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - - +PasswordAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                      Interface PasswordAuthenticationMethod

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      interface PasswordAuthenticationMethod {
                                                                                                                                                                                                                          created_at: string;
                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                          identity_user_id: string;
                                                                                                                                                                                                                          last_password_reset?: string;
                                                                                                                                                                                                                          type: "password";
                                                                                                                                                                                                                          usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                      }
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                      • AuthenticationMethodBase +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                        • PasswordAuthenticationMethod
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                       +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      created_at +id +identity_user_id +last_password_reset? +type +usage +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      created_at: string
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      id: string
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      identity_user_id: string
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      last_password_reset?: string
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      type: "password"
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      usage: ("primary" | "secondary")[]
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                       +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                       +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      diff --git a/docs/interfaces/PasswordEnrollmentChallengeResponse.html b/docs/interfaces/PasswordEnrollmentChallengeResponse.html index 2682ee41..370e543a 100644 --- a/docs/interfaces/PasswordEnrollmentChallengeResponse.html +++ b/docs/interfaces/PasswordEnrollmentChallengeResponse.html @@ -1,621 +1,87 @@ - - - - - - PasswordEnrollmentChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -                                                                                                                                                                                                                         - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                        Interface PasswordEnrollmentChallengeResponse

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - interface - PasswordEnrollmentChallengeResponse - {
                                                                                                                                                                                                                            auth_session: - string;
                                                                                                                                                                                                                            id: - string;
                                                                                                                                                                                                                            location: - string;
                                                                                                                                                                                                                            policy: - PasswordPolicy;
                                                                                                                                                                                                                            type: - "password";
                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • - EnrollmentChallengeBaseResponse -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • - PasswordEnrollmentChallengeResponse -
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                        -                                                                                                                                                                                                                         -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        - - auth_session - - id - - location - - policy - - type -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - - - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        - auth_session: - string -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        - id: - string -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        - location: - string -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        - policy: - PasswordPolicy -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        - type: - "password" -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                        -                                                                                                                                                                                                                         -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - Member Visibility -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                        -                                                                                                                                                                                                                         -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - Properties - - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - +PasswordEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                          Interface PasswordEnrollmentChallengeResponse

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          interface PasswordEnrollmentChallengeResponse {
                                                                                                                                                                                                                              auth_session: string;
                                                                                                                                                                                                                              id: string;
                                                                                                                                                                                                                              location: string;
                                                                                                                                                                                                                              policy: PasswordPolicy;
                                                                                                                                                                                                                              type: "password";
                                                                                                                                                                                                                          }
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                          • EnrollmentChallengeBaseResponse +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            • PasswordEnrollmentChallengeResponse
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                           +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          auth_session +id +location +policy +type +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          auth_session: string
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          id: string
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          location: string
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          policy: PasswordPolicy
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          type: "password"
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                           +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                           +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Properties +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          diff --git a/docs/interfaces/PasswordEnrollmentVerifyOptions.html b/docs/interfaces/PasswordEnrollmentVerifyOptions.html index 3b897f4c..a4119081 100644 --- a/docs/interfaces/PasswordEnrollmentVerifyOptions.html +++ b/docs/interfaces/PasswordEnrollmentVerifyOptions.html @@ -1,569 +1,80 @@ - - - - - - PasswordEnrollmentVerifyOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -                                                                                                                                                                                                                             - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                            Interface PasswordEnrollmentVerifyOptions

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - interface - PasswordEnrollmentVerifyOptions - {
                                                                                                                                                                                                                                auth_session: - string;
                                                                                                                                                                                                                                location: - string;
                                                                                                                                                                                                                                new_password: - string;
                                                                                                                                                                                                                                type: - "password";
                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • - EnrollmentVerifyBaseOptions -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                              • - PasswordEnrollmentVerifyOptions -
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                            -                                                                                                                                                                                                                             -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            - - auth_session - - location - - new_password - - type -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - - - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            - auth_session: - string -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            - location: - string -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            - new_password: - string -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            - type: - "password" -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                            -                                                                                                                                                                                                                             -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - Member Visibility -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                            -                                                                                                                                                                                                                             -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - Properties - - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - +PasswordEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                              Interface PasswordEnrollmentVerifyOptions

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              interface PasswordEnrollmentVerifyOptions {
                                                                                                                                                                                                                                  auth_session: string;
                                                                                                                                                                                                                                  location: string;
                                                                                                                                                                                                                                  new_password: string;
                                                                                                                                                                                                                                  type: "password";
                                                                                                                                                                                                                              }
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                              • EnrollmentVerifyBaseOptions +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                • PasswordEnrollmentVerifyOptions
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                               +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              auth_session +location +new_password +type +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              auth_session: string
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              location: string
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              new_password: string
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              type: "password"
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                               +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                               +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Properties +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              diff --git a/docs/interfaces/PhoneAuthenticationMethod.html b/docs/interfaces/PhoneAuthenticationMethod.html index 1a737b75..1c822d46 100644 --- a/docs/interfaces/PhoneAuthenticationMethod.html +++ b/docs/interfaces/PhoneAuthenticationMethod.html @@ -1,849 +1,114 @@ - - - - - - PhoneAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -                                                                                                                                                                                                                                 - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                Interface PhoneAuthenticationMethod

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - interface - PhoneAuthenticationMethod - {
                                                                                                                                                                                                                                    confirmed: - boolean;
                                                                                                                                                                                                                                    created_at: - string;
                                                                                                                                                                                                                                    id: - string;
                                                                                                                                                                                                                                    last_auth_at?: - string;
                                                                                                                                                                                                                                    name?: - string;
                                                                                                                                                                                                                                    phone_number: - string;
                                                                                                                                                                                                                                    preferred_authentication_method: - "sms" - | - "voice";
                                                                                                                                                                                                                                    type: - "phone";
                                                                                                                                                                                                                                    usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • - AuthenticationMethodWithMetadata -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - PhoneAuthenticationMethod -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                -                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                - - confirmed - - created_at - - id - - last_auth_at? - - name? - - phone_number - - preferred_authentication_method - - type - - usage -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                - confirmed: - boolean -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                - created_at: - string -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                - id: - string -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                - last_auth_at?: - string -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                - name?: - string -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                - phone_number: - string -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                - preferred_authentication_method: - "sms" - | - "voice" -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                - type: - "phone" -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                -                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - Member Visibility -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                -                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - Properties - - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - +PhoneAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                  Interface PhoneAuthenticationMethod

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  interface PhoneAuthenticationMethod {
                                                                                                                                                                                                                                      confirmed: boolean;
                                                                                                                                                                                                                                      created_at: string;
                                                                                                                                                                                                                                      id: string;
                                                                                                                                                                                                                                      last_auth_at?: string;
                                                                                                                                                                                                                                      name?: string;
                                                                                                                                                                                                                                      phone_number: string;
                                                                                                                                                                                                                                      preferred_authentication_method: "sms" | "voice";
                                                                                                                                                                                                                                      type: "phone";
                                                                                                                                                                                                                                      usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  • AuthenticationMethodWithMetadata +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • PhoneAuthenticationMethod
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  confirmed +created_at +id +last_auth_at? +name? +phone_number +preferred_authentication_method +type +usage +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  confirmed: boolean
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  created_at: string
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  id: string
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  last_auth_at?: string
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  name?: string
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  phone_number: string
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  preferred_authentication_method: "sms" | "voice"
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  type: "phone"
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  usage: ("primary" | "secondary")[]
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  diff --git a/docs/interfaces/PhoneEnrollmentChallengeResponse.html b/docs/interfaces/PhoneEnrollmentChallengeResponse.html index 47ac20f8..2003e3be 100644 --- a/docs/interfaces/PhoneEnrollmentChallengeResponse.html +++ b/docs/interfaces/PhoneEnrollmentChallengeResponse.html @@ -1,573 +1,81 @@ - - - - - - PhoneEnrollmentChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                     - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                    Interface PhoneEnrollmentChallengeResponse

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - interface - PhoneEnrollmentChallengeResponse - {
                                                                                                                                                                                                                                        auth_session: - string;
                                                                                                                                                                                                                                        id: - string;
                                                                                                                                                                                                                                        location: - string;
                                                                                                                                                                                                                                        type: - "phone";
                                                                                                                                                                                                                                    } -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • - EnrollmentChallengeBaseResponse -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                      • - PhoneEnrollmentChallengeResponse -
                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    - - auth_session - - id - - location - - type -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    - auth_session: - string -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    - id: - string -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    - location: - string -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    - type: - "phone" -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - Member Visibility -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - Properties - - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - +PhoneEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                      Interface PhoneEnrollmentChallengeResponse

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      interface PhoneEnrollmentChallengeResponse {
                                                                                                                                                                                                                                          auth_session: string;
                                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                                          location: string;
                                                                                                                                                                                                                                          type: "phone";
                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                      • EnrollmentChallengeBaseResponse +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                        • PhoneEnrollmentChallengeResponse
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      auth_session +id +location +type +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      auth_session: string
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      id: string
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      location: string
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      type: "phone"
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      diff --git a/docs/interfaces/PhoneEnrollmentVerifyOptions.html b/docs/interfaces/PhoneEnrollmentVerifyOptions.html index dff71a0b..e7869e85 100644 --- a/docs/interfaces/PhoneEnrollmentVerifyOptions.html +++ b/docs/interfaces/PhoneEnrollmentVerifyOptions.html @@ -1,565 +1,80 @@ - - - - - - PhoneEnrollmentVerifyOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                         - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                        Interface PhoneEnrollmentVerifyOptions

                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - interface - PhoneEnrollmentVerifyOptions - {
                                                                                                                                                                                                                                            auth_session: - string;
                                                                                                                                                                                                                                            location: - string;
                                                                                                                                                                                                                                            otp_code: - string;
                                                                                                                                                                                                                                            type: - "phone";
                                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                        • - EnrollmentVerifyBaseOptions -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                          • - PhoneEnrollmentVerifyOptions -
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                        - - auth_session - - location - - otp_code - - type -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - - - - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                        - auth_session: - string -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                        - location: - string -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                        - otp_code: - string -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                        - type: - "phone" -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - Member Visibility -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - - Properties - - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - - +PhoneEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          Interface PhoneEnrollmentVerifyOptions

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          interface PhoneEnrollmentVerifyOptions {
                                                                                                                                                                                                                                              auth_session: string;
                                                                                                                                                                                                                                              location: string;
                                                                                                                                                                                                                                              otp_code: string;
                                                                                                                                                                                                                                              type: "phone";
                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                          • EnrollmentVerifyBaseOptions +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                            • PhoneEnrollmentVerifyOptions
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          auth_session +location +otp_code +type +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          auth_session: string
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          location: string
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          otp_code: string
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          type: "phone"
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Properties +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index a9ed829a..a375964e 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -1,547 +1,92 @@ - - - - - - PopupConfigOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                             - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                            Interface PopupConfigOptions

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - interface - PopupConfigOptions - {
                                                                                                                                                                                                                                                closePopup?: - boolean;
                                                                                                                                                                                                                                                popup?: - any;
                                                                                                                                                                                                                                                timeoutInSeconds?: - number;
                                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - - closePopup? - - popup? - - timeoutInSeconds? -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - - - - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - closePopup?: - boolean -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                            - Controls whether the SDK automatically closes the popup - window. -

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                            • - true (default): SDK closes the popup - automatically after receiving the authorization response -
                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                            • - false: SDK does not close the popup. The caller - is responsible for closing it, including on errors. -
                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                            - Setting this to false is useful when you need - full control over the popup lifecycle, such as in Chrome - extensions where closing the popup too early can terminate the - extension's service worker before authentication completes. -

                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                            - When closePopup: false, you should close the - popup in a try/finally block: -

                                                                                                                                                                                                                                            - 
                                                                                                                                                                                                                                            const popup = window.open('', '_blank');
                                                                                                                                                                                                                                            try {
                                                                                                                                                                                                                                              await auth0.loginWithPopup({}, { popup, closePopup: false });
                                                                                                                                                                                                                                            } finally {
                                                                                                                                                                                                                                              popup.close();
                                                                                                                                                                                                                                            }
+PopupConfigOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                            @auth0/auth0-angular
+
+
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                                              Interface PopupConfigOptions
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              interface PopupConfigOptions {
                                                                                                                                                                                                                                                  closePopup?: boolean;
                                                                                                                                                                                                                                                  popup?: any;
                                                                                                                                                                                                                                                  timeoutInSeconds?: number;
                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                                              closePopup?
+popup?
+timeoutInSeconds?
+
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                                              closePopup?: boolean
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              Controls whether the SDK automatically closes the popup window.
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                              • true (default): SDK closes the popup automatically after receiving the authorization response
                                                                                                                                                                                                                                                • 
+
                                                                                                                                                                                                                                              • false: SDK does not close the popup. The caller is responsible for closing it, including on errors.
                                                                                                                                                                                                                                                • 
+
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              Setting this to false is useful when you need full control over the popup lifecycle,
+such as in Chrome extensions where closing the popup too early can terminate the
+extension's service worker before authentication completes.
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              When closePopup: false, you should close the popup in a try/finally block:
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              const popup = window.open('', '_blank');
                                                                                                                                                                                                                                              try {
                                                                                                                                                                                                                                                await auth0.loginWithPopup({}, { popup, closePopup: false });
                                                                                                                                                                                                                                              } finally {
                                                                                                                                                                                                                                                popup.close();
                                                                                                                                                                                                                                              }
 
                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                              
-                  
-                  
                                                                                                                                                                                                                                              true
+
+
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              true
 
                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                              
-              
-            
                                                                                                                                                                                                                                              
-            
                                                                                                                                                                                                                                              
-              
-              
                                                                                                                                                                                                                                              
-                popup?:
-                any
-              
                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                              
-                  Accepts an already-created popup window to use. If not
-                  specified, the SDK will create its own. This may be useful for
-                  platforms like iOS that have security restrictions around when
-                  popups can be invoked (e.g. from a user click event)
-                
                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                              
-              
-            
                                                                                                                                                                                                                                              
-            
                                                                                                                                                                                                                                              
-              
-              
                                                                                                                                                                                                                                              
-                timeoutInSeconds?:
-                number
-              
                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                              
-                  The number of seconds to wait for a popup response before
-                  throwing a timeout error. Defaults to 60s
-                
                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                              
-              
-            
                                                                                                                                                                                                                                              
-          
                                                                                                                                                                                                                                              
-        
                                                                                                                                                                                                                                              
-      
                                                                                                                                                                                                                                              
-      
                                                                                                                                                                                                                                              
-        
                                                                                                                                                                                                                                              
-          
                                                                                                                                                                                                                                              
-            
                                                                                                                                                                                                                                              
-              
-                
-                
                                                                                                                                                                                                                                              Settings
                                                                                                                                                                                                                                              
-                                                                                                                                                                                                                                                            
-              
                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                              
-                  Member Visibility
-                  
                                                                                                                                                                                                                                                
-                    
                                                                                                                                                                                                                                              • 
-                      
-                    
                                                                                                                                                                                                                                                • 
-                    
                                                                                                                                                                                                                                              • 
-                      
-                    
                                                                                                                                                                                                                                                • 
-                    
                                                                                                                                                                                                                                              • 
-                      
-                    
                                                                                                                                                                                                                                                • 
-                  
                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                              
-                  
-                
                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                              
-            
                                                                                                                                                                                                                                              
-          
                                                                                                                                                                                                                                              
-          
                                                                                                                                                                                                                                              
-            
-              
-              
                                                                                                                                                                                                                                              On This Page
                                                                                                                                                                                                                                              
-                                                                                                                                                                                                                                                          
-            
                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                              
-                
-                  Properties
-                
-                
-              
                                                                                                                                                                                                                                              
-            
                                                                                                                                                                                                                                              
-          
                                                                                                                                                                                                                                              
-        
                                                                                                                                                                                                                                              
-        
                                                                                                                                                                                                                                              
-          
-        
                                                                                                                                                                                                                                              
-      
                                                                                                                                                                                                                                              
-    
                                                                                                                                                                                                                                              
-    
                                                                                                                                                                                                                                              
-    
                                                                                                                                                                                                                                              
-  
-
+
+
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                              popup?: any
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Accepts an already-created popup window to use. If not specified, the SDK +will create its own. This may be useful for platforms like iOS that have +security restrictions around when popups can be invoked (e.g. from a user click event)

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                              timeoutInSeconds?: number
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              The number of seconds to wait for a popup response before +throwing a timeout error. Defaults to 60s

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              Properties +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 24378931..5aca82e0 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -1,441 +1,66 @@ - - - - - - PopupLoginOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                 - -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                Interface PopupLoginOptions

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - interface - PopupLoginOptions - {
                                                                                                                                                                                                                                                    authorizationParams?: - AuthorizationParams;
                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                - Hierarchy (View Summary) -

                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                - - authorizationParams? -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                - authorizationParams?: - AuthorizationParams -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                - URL parameters that will be sent back to the Authorization - Server. This can be known parameters defined by Auth0 or - custom parameters that you define. -

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - Member Visibility -
                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - - Properties - - -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - - +PopupLoginOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                  Interface PopupLoginOptions

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  interface PopupLoginOptions {
                                                                                                                                                                                                                                                      authorizationParams?: AuthorizationParams;
                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  authorizationParams? +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  authorizationParams?: AuthorizationParams
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  URL parameters that will be sent back to the Authorization Server. This can be known parameters +defined by Auth0 or custom parameters that you define.

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/PushNotificationAuthenticationMethod.html b/docs/interfaces/PushNotificationAuthenticationMethod.html index f3bb81b5..f633de49 100644 --- a/docs/interfaces/PushNotificationAuthenticationMethod.html +++ b/docs/interfaces/PushNotificationAuthenticationMethod.html @@ -1,744 +1,102 @@ - - - - - - PushNotificationAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                     - -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                    Interface PushNotificationAuthenticationMethod

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - interface - PushNotificationAuthenticationMethod - {
                                                                                                                                                                                                                                                        confirmed: - boolean;
                                                                                                                                                                                                                                                        created_at: - string;
                                                                                                                                                                                                                                                        id: - string;
                                                                                                                                                                                                                                                        last_auth_at?: - string;
                                                                                                                                                                                                                                                        name?: - string;
                                                                                                                                                                                                                                                        type: - "push-notification";
                                                                                                                                                                                                                                                        usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                                                                                    } -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                    • - AuthenticationMethodWithMetadata -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                      • - PushNotificationAuthenticationMethod -
                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    - - confirmed - - created_at - - id - - last_auth_at? - - name? - - type - - usage -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    - confirmed: - boolean -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    - created_at: - string -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    - id: - string -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    - last_auth_at?: - string -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    - name?: - string -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    - type: - "push-notification" -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - Member Visibility -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - - Properties - - -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - - +PushNotificationAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                      Interface PushNotificationAuthenticationMethod

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      interface PushNotificationAuthenticationMethod {
                                                                                                                                                                                                                                                          confirmed: boolean;
                                                                                                                                                                                                                                                          created_at: string;
                                                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                                                          last_auth_at?: string;
                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                          type: "push-notification";
                                                                                                                                                                                                                                                          usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      • AuthenticationMethodWithMetadata +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                        • PushNotificationAuthenticationMethod
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      confirmed +created_at +id +last_auth_at? +name? +type +usage +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      confirmed: boolean
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      created_at: string
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      id: string
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      last_auth_at?: string
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      name?: string
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      type: "push-notification"
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      usage: ("primary" | "secondary")[]
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/PushNotificationEnrollmentChallengeResponse.html b/docs/interfaces/PushNotificationEnrollmentChallengeResponse.html index 746c4149..f453078f 100644 --- a/docs/interfaces/PushNotificationEnrollmentChallengeResponse.html +++ b/docs/interfaces/PushNotificationEnrollmentChallengeResponse.html @@ -1,678 +1,93 @@ - - - - - - - PushNotificationEnrollmentChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                         - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                        Interface PushNotificationEnrollmentChallengeResponse

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - interface - PushNotificationEnrollmentChallengeResponse - {
                                                                                                                                                                                                                                                            auth_session: - string;
                                                                                                                                                                                                                                                            barcode_uri: - string;
                                                                                                                                                                                                                                                            id: - string;
                                                                                                                                                                                                                                                            location: - string;
                                                                                                                                                                                                                                                            manual_input_code?: - string;
                                                                                                                                                                                                                                                            type: - "push-notification";
                                                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                        • - EnrollmentChallengeBaseResponse -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                          • - PushNotificationEnrollmentChallengeResponse -
                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        - - auth_session - - barcode_uri - - id - - location - - manual_input_code? - - type -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - - - - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        - auth_session: - string -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        - barcode_uri: - string -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        - id: - string -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        - location: - string -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        - manual_input_code?: - string -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        - type: - "push-notification" -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - Member Visibility -
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - - Properties - - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - - +PushNotificationEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                          Interface PushNotificationEnrollmentChallengeResponse

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          interface PushNotificationEnrollmentChallengeResponse {
                                                                                                                                                                                                                                                              auth_session: string;
                                                                                                                                                                                                                                                              barcode_uri: string;
                                                                                                                                                                                                                                                              id: string;
                                                                                                                                                                                                                                                              location: string;
                                                                                                                                                                                                                                                              manual_input_code?: string;
                                                                                                                                                                                                                                                              type: "push-notification";
                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                          • EnrollmentChallengeBaseResponse +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                            • PushNotificationEnrollmentChallengeResponse
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          auth_session +barcode_uri +id +location +manual_input_code? +type +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          auth_session: string
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          barcode_uri: string
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          id: string
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          location: string
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          manual_input_code?: string
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          type: "push-notification"
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Properties +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/PushNotificationEnrollmentVerifyOptions.html b/docs/interfaces/PushNotificationEnrollmentVerifyOptions.html index a64e83ba..8049461d 100644 --- a/docs/interfaces/PushNotificationEnrollmentVerifyOptions.html +++ b/docs/interfaces/PushNotificationEnrollmentVerifyOptions.html @@ -1,525 +1,74 @@ - - - - - - - PushNotificationEnrollmentVerifyOptions | @auth0/auth0-angular - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                             - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                            Interface PushNotificationEnrollmentVerifyOptions

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - interface - PushNotificationEnrollmentVerifyOptions - {
                                                                                                                                                                                                                                                                auth_session: - string;
                                                                                                                                                                                                                                                                location: - string;
                                                                                                                                                                                                                                                                type: - "push-notification";
                                                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                            • - EnrollmentVerifyBaseOptions -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                              • - PushNotificationEnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            - - auth_session - - location - - type -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - - - - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            - auth_session: - string -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            - location: - string -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            - type: - "push-notification" -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - Member Visibility -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - - Properties - - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - - +PushNotificationEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              Interface PushNotificationEnrollmentVerifyOptions

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              interface PushNotificationEnrollmentVerifyOptions {
                                                                                                                                                                                                                                                                  auth_session: string;
                                                                                                                                                                                                                                                                  location: string;
                                                                                                                                                                                                                                                                  type: "push-notification";
                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • EnrollmentVerifyBaseOptions +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                • PushNotificationEnrollmentVerifyOptions
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              auth_session +location +type +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              auth_session: string
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              location: string
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              type: "push-notification"
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Properties +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/RecoveryCodeAuthenticationMethod.html b/docs/interfaces/RecoveryCodeAuthenticationMethod.html index 15e1040f..2d1d99b1 100644 --- a/docs/interfaces/RecoveryCodeAuthenticationMethod.html +++ b/docs/interfaces/RecoveryCodeAuthenticationMethod.html @@ -1,727 +1,95 @@ - - - - - - RecoveryCodeAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                 - -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                Interface RecoveryCodeAuthenticationMethod

                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - interface - RecoveryCodeAuthenticationMethod - {
                                                                                                                                                                                                                                                                    confirmed: - boolean;
                                                                                                                                                                                                                                                                    created_at: - string;
                                                                                                                                                                                                                                                                    id: - string;
                                                                                                                                                                                                                                                                    last_auth_at?: - string;
                                                                                                                                                                                                                                                                    type: - "recovery-code";
                                                                                                                                                                                                                                                                    usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                • - Omit<AuthenticationMethodWithMetadata, - "name"> -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                  • - RecoveryCodeAuthenticationMethod -
                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                - - confirmed - - created_at - - id - - last_auth_at? - - type - - usage -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                - confirmed: - boolean -
                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                - created_at: - string -
                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                - id: - string -
                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                - last_auth_at?: - string -
                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                - type: - "recovery-code" -
                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - Member Visibility -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - - Properties - - -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - - +RecoveryCodeAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                  Interface RecoveryCodeAuthenticationMethod

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  interface RecoveryCodeAuthenticationMethod {
                                                                                                                                                                                                                                                                      confirmed: boolean;
                                                                                                                                                                                                                                                                      created_at: string;
                                                                                                                                                                                                                                                                      id: string;
                                                                                                                                                                                                                                                                      last_auth_at?: string;
                                                                                                                                                                                                                                                                      type: "recovery-code";
                                                                                                                                                                                                                                                                      usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • Omit<AuthenticationMethodWithMetadata, "name"> +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • RecoveryCodeAuthenticationMethod
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  confirmed +created_at +id +last_auth_at? +type +usage +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  confirmed: boolean
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  created_at: string
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  id: string
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  last_auth_at?: string
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  type: "recovery-code"
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  usage: ("primary" | "secondary")[]
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/RecoveryCodeEnrollmentChallengeResponse.html b/docs/interfaces/RecoveryCodeEnrollmentChallengeResponse.html index 6c395ead..0616eba4 100644 --- a/docs/interfaces/RecoveryCodeEnrollmentChallengeResponse.html +++ b/docs/interfaces/RecoveryCodeEnrollmentChallengeResponse.html @@ -1,627 +1,87 @@ - - - - - - - RecoveryCodeEnrollmentChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                     - -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                    Interface RecoveryCodeEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - interface - RecoveryCodeEnrollmentChallengeResponse - {
                                                                                                                                                                                                                                                                        auth_session: - string;
                                                                                                                                                                                                                                                                        id: - string;
                                                                                                                                                                                                                                                                        location: - string;
                                                                                                                                                                                                                                                                        recovery_code: - string;
                                                                                                                                                                                                                                                                        type: - "recovery-code";
                                                                                                                                                                                                                                                                    } -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                    • - EnrollmentChallengeBaseResponse -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                      • - RecoveryCodeEnrollmentChallengeResponse -
                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                    - - auth_session - - id - - location - - recovery_code - - type -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                    - auth_session: - string -
                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                    - id: - string -
                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                    - location: - string -
                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                    - recovery_code: - string -
                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                    - type: - "recovery-code" -
                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - Member Visibility -
                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - - Properties - - -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - - +RecoveryCodeEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                      Interface RecoveryCodeEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      interface RecoveryCodeEnrollmentChallengeResponse {
                                                                                                                                                                                                                                                                          auth_session: string;
                                                                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                                                                          location: string;
                                                                                                                                                                                                                                                                          recovery_code: string;
                                                                                                                                                                                                                                                                          type: "recovery-code";
                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • EnrollmentChallengeBaseResponse +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                        • RecoveryCodeEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      auth_session +id +location +recovery_code +type +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      auth_session: string
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      id: string
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      location: string
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      recovery_code: string
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      type: "recovery-code"
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/RecoveryCodeEnrollmentVerifyOptions.html b/docs/interfaces/RecoveryCodeEnrollmentVerifyOptions.html index 5527b0dc..2557ee0b 100644 --- a/docs/interfaces/RecoveryCodeEnrollmentVerifyOptions.html +++ b/docs/interfaces/RecoveryCodeEnrollmentVerifyOptions.html @@ -1,523 +1,74 @@ - - - - - - RecoveryCodeEnrollmentVerifyOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                         - -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                        Interface RecoveryCodeEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - interface - RecoveryCodeEnrollmentVerifyOptions - {
                                                                                                                                                                                                                                                                            auth_session: - string;
                                                                                                                                                                                                                                                                            location: - string;
                                                                                                                                                                                                                                                                            type: - "recovery-code";
                                                                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                        • - EnrollmentVerifyBaseOptions -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                          • - RecoveryCodeEnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                        - - auth_session - - location - - type -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - - - - -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                        - auth_session: - string -
                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                        - location: - string -
                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                        - type: - "recovery-code" -
                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - Member Visibility -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - - Properties - - -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - - +RecoveryCodeEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                          Interface RecoveryCodeEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          interface RecoveryCodeEnrollmentVerifyOptions {
                                                                                                                                                                                                                                                                              auth_session: string;
                                                                                                                                                                                                                                                                              location: string;
                                                                                                                                                                                                                                                                              type: "recovery-code";
                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                          • EnrollmentVerifyBaseOptions +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                            • RecoveryCodeEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          auth_session +location +type +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          auth_session: string
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          location: string
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          type: "recovery-code"
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Properties +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/RedirectConnectAccountOptions.html b/docs/interfaces/RedirectConnectAccountOptions.html index 2f9ac3e2..4d588d87 100644 --- a/docs/interfaces/RedirectConnectAccountOptions.html +++ b/docs/interfaces/RedirectConnectAccountOptions.html @@ -1,780 +1,124 @@ - - - - - - RedirectConnectAccountOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                                             - -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                            Interface RedirectConnectAccountOptions<TAppState>

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            - interface - RedirectConnectAccountOptions<TAppState - = - any> - {
                                                                                                                                                                                                                                                                                appState?: - TAppState;
                                                                                                                                                                                                                                                                                authorization_params?: - AuthorizationParams;
                                                                                                                                                                                                                                                                                connection: - string;
                                                                                                                                                                                                                                                                                openUrl?: - (url: - string) - => - Promise<void>;
                                                                                                                                                                                                                                                                                redirectUri?: - string;
                                                                                                                                                                                                                                                                                scopes?: - string[];
                                                                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            • - TAppState = - any -
                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            - - appState? - - authorization_params? - - connection - - openUrl? - - redirectUri? - - scopes? -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            - - - - -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            - appState?: - TAppState -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            - Optional application state to persist through the transaction. -

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            - - 
                                                                                                                                                                                                                                                                            await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                                              connection: 'google-oauth2',
                                                                                                                                                                                                                                                                              appState: { returnTo: '/settings' }
                                                                                                                                                                                                                                                                            });
+RedirectConnectAccountOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                                            @auth0/auth0-angular
+
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                                                                              Interface RedirectConnectAccountOptions<TAppState>
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              interface RedirectConnectAccountOptions<TAppState = any> {
                                                                                                                                                                                                                                                                                  appState?: TAppState;
                                                                                                                                                                                                                                                                                  authorization_params?: AuthorizationParams;
                                                                                                                                                                                                                                                                                  connection: string;
                                                                                                                                                                                                                                                                                  openUrl?: (url: string) => Promise<void>;
                                                                                                                                                                                                                                                                                  redirectUri?: string;
                                                                                                                                                                                                                                                                                  scopes?: string[];
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              Type Parameters
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                                                              • TAppState = any
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                                                                              appState?
+authorization_params?
+connection
+openUrl?
+redirectUri?
+scopes?
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                                                                              appState?: TAppState
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              Optional application state to persist through the transaction.
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                                                connection: 'google-oauth2',
                                                                                                                                                                                                                                                                                appState: { returnTo: '/settings' }
                                                                                                                                                                                                                                                                              });
 
                                                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-              
-            
                                                                                                                                                                                                                                                                              
-            
                                                                                                                                                                                                                                                                              
-              
-              
                                                                                                                                                                                                                                                                              
-                authorization_params?:
-                AuthorizationParams
-              
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                                                              Additional authorization parameters for the request.
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                                                              
-                  
-                  
                                                                                                                                                                                                                                                                              await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                                                connection: 'github',
                                                                                                                                                                                                                                                                                authorization_params: {
                                                                                                                                                                                                                                                                                  audience: 'https://api.github.com'
                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                              });
+
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                                                                              authorization_params?: AuthorizationParams
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              Additional authorization parameters for the request.
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                                                connection: 'github',
                                                                                                                                                                                                                                                                                authorization_params: {
                                                                                                                                                                                                                                                                                  audience: 'https://api.github.com'
                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                              });
 
                                                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-              
-            
                                                                                                                                                                                                                                                                              
-            
                                                                                                                                                                                                                                                                              
-              
-              
                                                                                                                                                                                                                                                                              
-                connection:
-                string
-              
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                                                              
-                  The name of the connection to link (e.g. 'google-oauth2').
-                
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-              
-            
                                                                                                                                                                                                                                                                              
-            
                                                                                                                                                                                                                                                                              
-              
-              
                                                                                                                                                                                                                                                                              
-                openUrl?:
-                (url:
-                string)
-                =>
-                Promise<void>
-              
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                                                              Optional function to handle the redirect URL.
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                                                              
-                  
-                  
                                                                                                                                                                                                                                                                              await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                                                connection: 'google-oauth2',
                                                                                                                                                                                                                                                                                openUrl: async (url) => { myBrowserApi.open(url); }
                                                                                                                                                                                                                                                                              });
+
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                                                                              connection: string
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              The name of the connection to link (e.g. 'google-oauth2').
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                                                                              openUrl?: (url: string) => Promise<void>
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              Optional function to handle the redirect URL.
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                                                connection: 'google-oauth2',
                                                                                                                                                                                                                                                                                openUrl: async (url) => { myBrowserApi.open(url); }
                                                                                                                                                                                                                                                                              });
 
                                                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-              
-            
                                                                                                                                                                                                                                                                              
-            
                                                                                                                                                                                                                                                                              
-              
-              
                                                                                                                                                                                                                                                                              
-                redirectUri?:
-                string
-              
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                                                              The URI to redirect back to after connecting the account.
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-              
-            
                                                                                                                                                                                                                                                                              
-            
                                                                                                                                                                                                                                                                              
-              
-              
                                                                                                                                                                                                                                                                              
-                scopes?:
-                string[]
-              
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                                                              
-                  Array of scopes to request from the Identity Provider during
-                  the connect account flow.
-                
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                                                              
-                  
-                  
                                                                                                                                                                                                                                                                              await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                                                connection: 'google-oauth2',
                                                                                                                                                                                                                                                                                scopes: ['https://www.googleapis.com/auth/calendar']
                                                                                                                                                                                                                                                                              });
+
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                                                                              redirectUri?: string
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              The URI to redirect back to after connecting the account.
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                                                                              scopes?: string[]
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              Array of scopes to request from the Identity Provider during the connect account flow.
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                                              await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                                                connection: 'google-oauth2',
                                                                                                                                                                                                                                                                                scopes: ['https://www.googleapis.com/auth/calendar']
                                                                                                                                                                                                                                                                              });
 
                                                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-              
-            
                                                                                                                                                                                                                                                                              
-          
                                                                                                                                                                                                                                                                              
-        
                                                                                                                                                                                                                                                                              
-      
                                                                                                                                                                                                                                                                              
-      
                                                                                                                                                                                                                                                                              
-        
                                                                                                                                                                                                                                                                              
-          
                                                                                                                                                                                                                                                                              
-            
                                                                                                                                                                                                                                                                              
-              
-                
-                
                                                                                                                                                                                                                                                                              Settings
                                                                                                                                                                                                                                                                              
-                                                                                                                                                                                                                                                                                            
-              
                                                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                                                              
-                  Member Visibility
-                  
                                                                                                                                                                                                                                                                                
-                    
                                                                                                                                                                                                                                                                              • 
-                      
-                    
                                                                                                                                                                                                                                                                                • 
-                    
                                                                                                                                                                                                                                                                              • 
-                      
-                    
                                                                                                                                                                                                                                                                                • 
-                    
                                                                                                                                                                                                                                                                              • 
-                      
-                    
                                                                                                                                                                                                                                                                                • 
-                  
                                                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                                                              
-                
                                                                                                                                                                                                                                                                              
-                  
-                
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-            
                                                                                                                                                                                                                                                                              
-          
                                                                                                                                                                                                                                                                              
-          
                                                                                                                                                                                                                                                                              
-            
-              
-              
                                                                                                                                                                                                                                                                              On This Page
                                                                                                                                                                                                                                                                              
-                                                                                                                                                                                                                                                                                          
-            
                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                              
-                
-                  Properties
-                
-                
-              
                                                                                                                                                                                                                                                                              
-            
                                                                                                                                                                                                                                                                              
-          
                                                                                                                                                                                                                                                                              
-        
                                                                                                                                                                                                                                                                              
-        
                                                                                                                                                                                                                                                                              
-          
-        
                                                                                                                                                                                                                                                                              
-      
                                                                                                                                                                                                                                                                              
-    
                                                                                                                                                                                                                                                                              
-    
                                                                                                                                                                                                                                                                              
-    
                                                                                                                                                                                                                                                                              
-  
-
+
+
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              Properties +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index 33ea2040..d17efaad 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -1,692 +1,106 @@ - - - - - - RedirectLoginOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                 - -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                Interface RedirectLoginOptions<TAppState>

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - interface - RedirectLoginOptions<TAppState> - {
                                                                                                                                                                                                                                                                                    appState?: - TAppState;
                                                                                                                                                                                                                                                                                    authorizationParams?: - AuthorizationParams;
                                                                                                                                                                                                                                                                                    fragment?: - string;
                                                                                                                                                                                                                                                                                    openUrl?: - (url: - string) - => - void - | - Promise<void>;
                                                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                • - TAppState -
                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                • - Omit<SPARedirectLoginOptions<TAppState>, - "onRedirect"> -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                  • - RedirectLoginOptions -
                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                - - appState? - - authorizationParams? - - fragment? - - openUrl? -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                - appState?: - TAppState -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                Used to store state before doing the redirect

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                - authorizationParams?: - AuthorizationParams -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                - URL parameters that will be sent back to the Authorization - Server. This can be known parameters defined by Auth0 or - custom parameters that you define. -

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                - fragment?: - string -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                Used to add to the URL fragment before redirecting

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                - openUrl?: - (url: - string) - => - void - | - Promise<void> -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                - Used to control the redirect and not rely on the SDK to do the - actual redirect. -

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - - 
                                                                                                                                                                                                                                                                                const client = new Auth0Client({
                                                                                                                                                                                                                                                                                  openUrl(url) {
                                                                                                                                                                                                                                                                                    window.location.replace(url);
                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                });
+RedirectLoginOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                                                                @auth0/auth0-angular
+
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
+
                                                                                                                                                                                                                                                                                  Interface RedirectLoginOptions<TAppState>
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  interface RedirectLoginOptions<TAppState> {
                                                                                                                                                                                                                                                                                      appState?: TAppState;
                                                                                                                                                                                                                                                                                      authorizationParams?: AuthorizationParams;
                                                                                                                                                                                                                                                                                      fragment?: string;
                                                                                                                                                                                                                                                                                      openUrl?: (url: string) => void | Promise<void>;
                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  Type Parameters
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                                  • TAppState
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  Hierarchy
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                                  • Omit<SPARedirectLoginOptions<TAppState>, "onRedirect">
+
                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                    • RedirectLoginOptions
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
+
                                                                                                                                                                                                                                                                                  appState?
+authorizationParams?
+fragment?
+openUrl?
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
+
                                                                                                                                                                                                                                                                                  appState?: TAppState
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  Used to store state before doing the redirect
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
+
                                                                                                                                                                                                                                                                                  authorizationParams?: AuthorizationParams
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  URL parameters that will be sent back to the Authorization Server. This can be known parameters
+defined by Auth0 or custom parameters that you define.
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
+
                                                                                                                                                                                                                                                                                  fragment?: string
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  Used to add to the URL fragment before redirecting
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
+
                                                                                                                                                                                                                                                                                  openUrl?: (url: string) => void | Promise<void>
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  Used to control the redirect and not rely on the SDK to do the actual redirect.
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  const client = new Auth0Client({
                                                                                                                                                                                                                                                                                    openUrl(url) {
                                                                                                                                                                                                                                                                                      window.location.replace(url);
                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                  });
 
                                                                                                                                                                                                                                                                                  
-                
                                                                                                                                                                                                                                                                                  
-                
                                                                                                                                                                                                                                                                                  
-                  
-                  
                                                                                                                                                                                                                                                                                  import { Browser } from '@capacitor/browser';

                                                                                                                                                                                                                                                                                  const client = new Auth0Client({
                                                                                                                                                                                                                                                                                    async openUrl(url) {
                                                                                                                                                                                                                                                                                      await Browser.open({ url });
                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                  });
+
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                  import { Browser } from '@capacitor/browser';

                                                                                                                                                                                                                                                                                  const client = new Auth0Client({
                                                                                                                                                                                                                                                                                    async openUrl(url) {
                                                                                                                                                                                                                                                                                      await Browser.open({ url });
                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                  });
 
                                                                                                                                                                                                                                                                                  
-                
                                                                                                                                                                                                                                                                                  
-              
                                                                                                                                                                                                                                                                                  
-              
-            
                                                                                                                                                                                                                                                                                  
-          
                                                                                                                                                                                                                                                                                  
-        
                                                                                                                                                                                                                                                                                  
-      
                                                                                                                                                                                                                                                                                  
-      
                                                                                                                                                                                                                                                                                  
-        
                                                                                                                                                                                                                                                                                  
-          
                                                                                                                                                                                                                                                                                  
-            
                                                                                                                                                                                                                                                                                  
-              
-                
-                
                                                                                                                                                                                                                                                                                  Settings
                                                                                                                                                                                                                                                                                  
-                                                                                                                                                                                                                                                                                                
-              
                                                                                                                                                                                                                                                                                  
-                
                                                                                                                                                                                                                                                                                  
-                  Member Visibility
-                  
                                                                                                                                                                                                                                                                                    
-                    
                                                                                                                                                                                                                                                                                  • 
-                      
-                    
                                                                                                                                                                                                                                                                                    • 
-                    
                                                                                                                                                                                                                                                                                  • 
-                      
-                    
                                                                                                                                                                                                                                                                                    • 
-                    
                                                                                                                                                                                                                                                                                  • 
-                      
-                    
                                                                                                                                                                                                                                                                                    • 
-                  
                                                                                                                                                                                                                                                                                  
-                
                                                                                                                                                                                                                                                                                  
-                
                                                                                                                                                                                                                                                                                  
-                  
-                
                                                                                                                                                                                                                                                                                  
-              
                                                                                                                                                                                                                                                                                  
-            
                                                                                                                                                                                                                                                                                  
-          
                                                                                                                                                                                                                                                                                  
-          
                                                                                                                                                                                                                                                                                  
-            
-              
-              
                                                                                                                                                                                                                                                                                  On This Page
                                                                                                                                                                                                                                                                                  
-                                                                                                                                                                                                                                                                                              
-            
                                                                                                                                                                                                                                                                                  
-              
                                                                                                                                                                                                                                                                                  
-                
-                  Properties
-                
-                
-              
                                                                                                                                                                                                                                                                                  
-            
                                                                                                                                                                                                                                                                                  
-          
                                                                                                                                                                                                                                                                                  
-        
                                                                                                                                                                                                                                                                                  
-        
                                                                                                                                                                                                                                                                                  
-          
-        
                                                                                                                                                                                                                                                                                  
-      
                                                                                                                                                                                                                                                                                  
-    
                                                                                                                                                                                                                                                                                  
-    
                                                                                                                                                                                                                                                                                  
-    
                                                                                                                                                                                                                                                                                  
-  
-
+
+
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/TotpAuthenticationMethod.html b/docs/interfaces/TotpAuthenticationMethod.html index 41df2197..ab487cf9 100644 --- a/docs/interfaces/TotpAuthenticationMethod.html +++ b/docs/interfaces/TotpAuthenticationMethod.html @@ -1,736 +1,102 @@ - - - - - - TotpAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                     - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                    Interface TotpAuthenticationMethod

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - interface - TotpAuthenticationMethod - {
                                                                                                                                                                                                                                                                                        confirmed: - boolean;
                                                                                                                                                                                                                                                                                        created_at: - string;
                                                                                                                                                                                                                                                                                        id: - string;
                                                                                                                                                                                                                                                                                        last_auth_at?: - string;
                                                                                                                                                                                                                                                                                        name?: - string;
                                                                                                                                                                                                                                                                                        type: - "totp";
                                                                                                                                                                                                                                                                                        usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                                                                                                                    } -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                    • - AuthenticationMethodWithMetadata -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                      • - TotpAuthenticationMethod -
                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    - - confirmed - - created_at - - id - - last_auth_at? - - name? - - type - - usage -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    - confirmed: - boolean -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    - created_at: - string -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    - id: - string -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    - last_auth_at?: - string -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    - name?: - string -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    - type: - "totp" -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - Member Visibility -
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - Properties - - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - +TotpAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                      Interface TotpAuthenticationMethod

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      interface TotpAuthenticationMethod {
                                                                                                                                                                                                                                                                                          confirmed: boolean;
                                                                                                                                                                                                                                                                                          created_at: string;
                                                                                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                                                                                          last_auth_at?: string;
                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                          type: "totp";
                                                                                                                                                                                                                                                                                          usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                      • AuthenticationMethodWithMetadata +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                        • TotpAuthenticationMethod
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      confirmed +created_at +id +last_auth_at? +name? +type +usage +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      confirmed: boolean
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      created_at: string
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      id: string
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      last_auth_at?: string
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      name?: string
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      type: "totp"
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      usage: ("primary" | "secondary")[]
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/TotpEnrollmentChallengeResponse.html b/docs/interfaces/TotpEnrollmentChallengeResponse.html index ad54a3eb..a9da7a59 100644 --- a/docs/interfaces/TotpEnrollmentChallengeResponse.html +++ b/docs/interfaces/TotpEnrollmentChallengeResponse.html @@ -1,672 +1,93 @@ - - - - - - TotpEnrollmentChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                         - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                        Interface TotpEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - interface - TotpEnrollmentChallengeResponse - {
                                                                                                                                                                                                                                                                                            auth_session: - string;
                                                                                                                                                                                                                                                                                            barcode_uri: - string;
                                                                                                                                                                                                                                                                                            id: - string;
                                                                                                                                                                                                                                                                                            location: - string;
                                                                                                                                                                                                                                                                                            manual_input_code?: - string;
                                                                                                                                                                                                                                                                                            type: - "totp";
                                                                                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • - EnrollmentChallengeBaseResponse -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • - TotpEnrollmentChallengeResponse -
                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        - - auth_session - - barcode_uri - - id - - location - - manual_input_code? - - type -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - - - - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        - auth_session: - string -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        - barcode_uri: - string -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        - id: - string -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        - location: - string -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        - manual_input_code?: - string -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        - type: - "totp" -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - Member Visibility -
                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - - Properties - - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - - +TotpEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                          Interface TotpEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          interface TotpEnrollmentChallengeResponse {
                                                                                                                                                                                                                                                                                              auth_session: string;
                                                                                                                                                                                                                                                                                              barcode_uri: string;
                                                                                                                                                                                                                                                                                              id: string;
                                                                                                                                                                                                                                                                                              location: string;
                                                                                                                                                                                                                                                                                              manual_input_code?: string;
                                                                                                                                                                                                                                                                                              type: "totp";
                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • EnrollmentChallengeBaseResponse +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                            • TotpEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          auth_session +barcode_uri +id +location +manual_input_code? +type +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          auth_session: string
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          barcode_uri: string
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          id: string
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          location: string
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          manual_input_code?: string
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          type: "totp"
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Properties +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/TotpEnrollmentVerifyOptions.html b/docs/interfaces/TotpEnrollmentVerifyOptions.html index 4c9774c1..db14298e 100644 --- a/docs/interfaces/TotpEnrollmentVerifyOptions.html +++ b/docs/interfaces/TotpEnrollmentVerifyOptions.html @@ -1,565 +1,80 @@ - - - - - - TotpEnrollmentVerifyOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                                                             - -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                            Interface TotpEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - interface - TotpEnrollmentVerifyOptions - {
                                                                                                                                                                                                                                                                                                auth_session: - string;
                                                                                                                                                                                                                                                                                                location: - string;
                                                                                                                                                                                                                                                                                                otp_code: - string;
                                                                                                                                                                                                                                                                                                type: - "totp";
                                                                                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                            • - EnrollmentVerifyBaseOptions -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                              • - TotpEnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                            - - auth_session - - location - - otp_code - - type -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - - - - -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                            - auth_session: - string -
                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                            - location: - string -
                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                            - otp_code: - string -
                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                            - type: - "totp" -
                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - Member Visibility -
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - - Properties - - -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            - - +TotpEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                              Interface TotpEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              interface TotpEnrollmentVerifyOptions {
                                                                                                                                                                                                                                                                                                  auth_session: string;
                                                                                                                                                                                                                                                                                                  location: string;
                                                                                                                                                                                                                                                                                                  otp_code: string;
                                                                                                                                                                                                                                                                                                  type: "totp";
                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                              • EnrollmentVerifyBaseOptions +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                • TotpEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              auth_session +location +otp_code +type +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              auth_session: string
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              location: string
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              otp_code: string
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              type: "totp"
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Properties +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/WebAuthnPlatformAuthenticationMethod.html b/docs/interfaces/WebAuthnPlatformAuthenticationMethod.html index 908d75fc..df42d014 100644 --- a/docs/interfaces/WebAuthnPlatformAuthenticationMethod.html +++ b/docs/interfaces/WebAuthnPlatformAuthenticationMethod.html @@ -1,855 +1,116 @@ - - - - - - WebAuthnPlatformAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                 - -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                Interface WebAuthnPlatformAuthenticationMethod

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - interface - WebAuthnPlatformAuthenticationMethod - {
                                                                                                                                                                                                                                                                                                    confirmed: - boolean;
                                                                                                                                                                                                                                                                                                    created_at: - string;
                                                                                                                                                                                                                                                                                                    id: - string;
                                                                                                                                                                                                                                                                                                    key_id?: - string;
                                                                                                                                                                                                                                                                                                    last_auth_at?: - string;
                                                                                                                                                                                                                                                                                                    name?: - string;
                                                                                                                                                                                                                                                                                                    public_key?: - string;
                                                                                                                                                                                                                                                                                                    type: - "webauthn-platform";
                                                                                                                                                                                                                                                                                                    usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                • - WebAuthnAuthenticationMethodBase -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                  • - WebAuthnPlatformAuthenticationMethod -
                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                - - confirmed - - created_at - - id - - key_id? - - last_auth_at? - - name? - - public_key? - - type - - usage -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                - confirmed: - boolean -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                - created_at: - string -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                - id: - string -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                - key_id?: - string -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                - last_auth_at?: - string -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                - name?: - string -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                - public_key?: - string -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                - type: - "webauthn-platform" -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - Member Visibility -
                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - - Properties - - -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                - - +WebAuthnPlatformAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                  Interface WebAuthnPlatformAuthenticationMethod

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  interface WebAuthnPlatformAuthenticationMethod {
                                                                                                                                                                                                                                                                                                      confirmed: boolean;
                                                                                                                                                                                                                                                                                                      created_at: string;
                                                                                                                                                                                                                                                                                                      id: string;
                                                                                                                                                                                                                                                                                                      key_id?: string;
                                                                                                                                                                                                                                                                                                      last_auth_at?: string;
                                                                                                                                                                                                                                                                                                      name?: string;
                                                                                                                                                                                                                                                                                                      public_key?: string;
                                                                                                                                                                                                                                                                                                      type: "webauthn-platform";
                                                                                                                                                                                                                                                                                                      usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                  • WebAuthnAuthenticationMethodBase +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                    • WebAuthnPlatformAuthenticationMethod
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  confirmed +created_at +id +key_id? +last_auth_at? +name? +public_key? +type +usage +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  confirmed: boolean
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  created_at: string
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  id: string
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  key_id?: string
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  last_auth_at?: string
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  name?: string
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  public_key?: string
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  type: "webauthn-platform"
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  usage: ("primary" | "secondary")[]
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/WebAuthnRoamingAuthenticationMethod.html b/docs/interfaces/WebAuthnRoamingAuthenticationMethod.html index cbff0883..cc2498bf 100644 --- a/docs/interfaces/WebAuthnRoamingAuthenticationMethod.html +++ b/docs/interfaces/WebAuthnRoamingAuthenticationMethod.html @@ -1,855 +1,116 @@ - - - - - - WebAuthnRoamingAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                                     - -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                    Interface WebAuthnRoamingAuthenticationMethod

                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - interface - WebAuthnRoamingAuthenticationMethod - {
                                                                                                                                                                                                                                                                                                        confirmed: - boolean;
                                                                                                                                                                                                                                                                                                        created_at: - string;
                                                                                                                                                                                                                                                                                                        id: - string;
                                                                                                                                                                                                                                                                                                        key_id?: - string;
                                                                                                                                                                                                                                                                                                        last_auth_at?: - string;
                                                                                                                                                                                                                                                                                                        name?: - string;
                                                                                                                                                                                                                                                                                                        public_key?: - string;
                                                                                                                                                                                                                                                                                                        type: - "webauthn-roaming";
                                                                                                                                                                                                                                                                                                        usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                                                                                                                                    } -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                    • - WebAuthnAuthenticationMethodBase -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                      • - WebAuthnRoamingAuthenticationMethod -
                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    - - confirmed - - created_at - - id - - key_id? - - last_auth_at? - - name? - - public_key? - - type - - usage -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    - confirmed: - boolean -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    - created_at: - string -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    - id: - string -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    - key_id?: - string -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    - last_auth_at?: - string -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    - name?: - string -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    - public_key?: - string -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    - type: - "webauthn-roaming" -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - Member Visibility -
                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - - Properties - - -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - - +WebAuthnRoamingAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                      Interface WebAuthnRoamingAuthenticationMethod

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      interface WebAuthnRoamingAuthenticationMethod {
                                                                                                                                                                                                                                                                                                          confirmed: boolean;
                                                                                                                                                                                                                                                                                                          created_at: string;
                                                                                                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                                                                                                          key_id?: string;
                                                                                                                                                                                                                                                                                                          last_auth_at?: string;
                                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                                          public_key?: string;
                                                                                                                                                                                                                                                                                                          type: "webauthn-roaming";
                                                                                                                                                                                                                                                                                                          usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                      • WebAuthnAuthenticationMethodBase +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                        • WebAuthnRoamingAuthenticationMethod
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      confirmed +created_at +id +key_id? +last_auth_at? +name? +public_key? +type +usage +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      confirmed: boolean
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      created_at: string
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      id: string
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      key_id?: string
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      last_auth_at?: string
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      name?: string
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      public_key?: string
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      type: "webauthn-roaming"
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      usage: ("primary" | "secondary")[]
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      diff --git a/docs/modules.html b/docs/modules.html index 9e5d35e5..f2d864e2 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,4666 +1,55 @@ - - - - - - @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                         - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular

                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - - - -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - HttpMethod -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - ResponseType -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - - - -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - AbstractNavigator -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - Auth0ClientFactory -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - AuthClientConfig -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - AuthenticationError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - AuthGuard -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - AuthHttpInterceptor -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - AuthModule -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - AuthService -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - AuthState -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - ConnectError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - Fetcher -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - GenericError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - InMemoryCache -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - InvalidConfigurationError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - LocalStorageCache -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - MfaChallengeError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - MfaEnrollmentError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - MfaEnrollmentFactorsError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - MfaError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - MfaListAuthenticatorsError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - MfaRequiredError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - MfaVerifyError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - MissingRefreshTokenError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - MissingScopesError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - MyAccountApiError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeyChallengeError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeyError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeyGetTokenError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeyRegisterError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PopupCancelledError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PopupOpenError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PopupTimeoutError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - TimeoutError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - UseDpopNonceError -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - User -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - - - -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - AppState -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - AuthConfig -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - Authenticator -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - AuthorizationParams -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - ChallengeAuthenticatorParams -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - ChallengeResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - EmailAuthenticationMethod -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - EmailEnrollmentChallengeOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - EmailEnrollmentChallengeResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - EmailEnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - EnrollEmailParams -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - EnrollmentFactor -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - EnrollOtpParams -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - EnrollPushParams -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - EnrollSmsParams -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - EnrollVoiceParams -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - Factor -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - GetTokenSilentlyOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - GetTokenWithPopupOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - HttpInterceptorConfig -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - HttpInterceptorRouteConfig -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - ICache -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - IdToken -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - IsFederatedDomainOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - LogoutOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - MyAccountApiClient -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - ObservableMfaApiClient -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - ObservableMyAccountApiClient -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - ObservablePasskeyApiClient -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - OobEnrollmentResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - OtpEnrollmentResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeyApiClient -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeyAuthenticationMethod -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeyCreationOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeyCredentialResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeyEnrollmentChallengeOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeyEnrollmentChallengeResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeyEnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeyErrorResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeyLoginChallengeOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeyLoginChallengeResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeyRequestOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeySignupChallengeResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasswordAuthenticationMethod -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasswordEnrollmentChallengeOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasswordEnrollmentChallengeResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasswordEnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PhoneAuthenticationMethod -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PhoneEnrollmentChallengeOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PhoneEnrollmentChallengeResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PhoneEnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PopupConfigOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PopupLoginOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PushNotificationAuthenticationMethod -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PushNotificationEnrollmentChallengeOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PushNotificationEnrollmentChallengeResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PushNotificationEnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - RecoveryCodeAuthenticationMethod -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - RecoveryCodeEnrollmentChallengeOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - RecoveryCodeEnrollmentChallengeResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - RecoveryCodeEnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - RedirectConnectAccountOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - RedirectLoginOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - TotpAuthenticationMethod -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - TotpEnrollmentChallengeOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - TotpEnrollmentChallengeResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - TotpEnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - UpdateAuthenticationMethodRequest -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - VerifyParams -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - WebAuthnPlatformAuthenticationMethod -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - WebAuthnRoamingAuthenticationMethod -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - - - -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - ApiRouteDefinition -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - AuthenticationMethod -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - AuthenticationMethodType -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - AuthenticatorType -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - Cacheable -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - ConnectAccountRedirectResult -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - ConnectedAccount -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - CustomFetchMinimalOutput -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - CustomTokenExchangeOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - EnrollmentChallengeOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - EnrollmentChallengeResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - EnrollmentResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - EnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - EnrollParams -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - FetcherConfig -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - InteractiveErrorHandler -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - MfaFactorType -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - MfaGrantType -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - OobChannel -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeyLoginOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeySignupChallengeOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - PasskeySignupOptions -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - RefreshTokenMode -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - TokenEndpointResponse -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - - - -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - Auth0ClientService -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - AuthConfigService -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - RefreshTokenMode -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - - - -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - authGuardFn -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - authHttpInterceptorFn -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - isFederatedDomain -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - isHttpInterceptorRouteConfig -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - provideAuth0 -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - -

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - Member Visibility -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                          • - -
                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                          • - -
                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                          • - -
                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - -

                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - Enumerations - - -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - Classes - - -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - Interfaces - -
                                                                                                                                                                                                                                                                                                          - - AppState - AuthConfig - Authenticator - AuthorizationParams - ChallengeAuthenticatorParams - ChallengeResponse - EmailAuthenticationMethod - EmailEnrollmentChallengeOptions - EmailEnrollmentChallengeResponse - EmailEnrollmentVerifyOptions - EnrollEmailParams - EnrollmentFactor - EnrollOtpParams - EnrollPushParams - EnrollSmsParams - EnrollVoiceParams - Factor - GetTokenSilentlyOptions - GetTokenWithPopupOptions - HttpInterceptorConfig - HttpInterceptorRouteConfig - ICache - IdToken - IsFederatedDomainOptions - LogoutOptions - MyAccountApiClient - ObservableMfaApiClient - ObservableMyAccountApiClient - ObservablePasskeyApiClient - OobEnrollmentResponse - OtpEnrollmentResponse - PasskeyApiClient - PasskeyAuthenticationMethod - PasskeyCreationOptions - PasskeyCredentialResponse - PasskeyEnrollmentChallengeOptions - PasskeyEnrollmentChallengeResponse - PasskeyEnrollmentVerifyOptions - PasskeyErrorResponse - PasskeyLoginChallengeOptions - PasskeyLoginChallengeResponse - PasskeyRequestOptions - PasskeySignupChallengeResponse - PasswordAuthenticationMethod - PasswordEnrollmentChallengeOptions - PasswordEnrollmentChallengeResponse - PasswordEnrollmentVerifyOptions - PhoneAuthenticationMethod - PhoneEnrollmentChallengeOptions - PhoneEnrollmentChallengeResponse - PhoneEnrollmentVerifyOptions - PopupConfigOptions - PopupLoginOptions - PushNotificationAuthenticationMethod - PushNotificationEnrollmentChallengeOptions - PushNotificationEnrollmentChallengeResponse - PushNotificationEnrollmentVerifyOptions - RecoveryCodeAuthenticationMethod - RecoveryCodeEnrollmentChallengeOptions - RecoveryCodeEnrollmentChallengeResponse - RecoveryCodeEnrollmentVerifyOptions - RedirectConnectAccountOptions - RedirectLoginOptions - TotpAuthenticationMethod - TotpEnrollmentChallengeOptions - TotpEnrollmentChallengeResponse - TotpEnrollmentVerifyOptions - UpdateAuthenticationMethodRequest - VerifyParams - WebAuthnPlatformAuthenticationMethod - WebAuthnRoamingAuthenticationMethod -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - Type Aliases - - -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - Variables - - -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - Functions - - -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - - +@auth0/auth0-angular
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                              @auth0/auth0-angular

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              HttpMethod
                                                                                                                                                                                                                                                                                                              ResponseType
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              AbstractNavigator
                                                                                                                                                                                                                                                                                                              Auth0ClientFactory
                                                                                                                                                                                                                                                                                                              AuthClientConfig
                                                                                                                                                                                                                                                                                                              AuthenticationError
                                                                                                                                                                                                                                                                                                              AuthGuard
                                                                                                                                                                                                                                                                                                              AuthHttpInterceptor
                                                                                                                                                                                                                                                                                                              AuthModule
                                                                                                                                                                                                                                                                                                              AuthService
                                                                                                                                                                                                                                                                                                              AuthState
                                                                                                                                                                                                                                                                                                              ConnectError
                                                                                                                                                                                                                                                                                                              Fetcher
                                                                                                                                                                                                                                                                                                              GenericError
                                                                                                                                                                                                                                                                                                              InMemoryCache
                                                                                                                                                                                                                                                                                                              InvalidConfigurationError
                                                                                                                                                                                                                                                                                                              LocalStorageCache
                                                                                                                                                                                                                                                                                                              MfaChallengeError
                                                                                                                                                                                                                                                                                                              MfaEnrollmentError
                                                                                                                                                                                                                                                                                                              MfaEnrollmentFactorsError
                                                                                                                                                                                                                                                                                                              MfaError
                                                                                                                                                                                                                                                                                                              MfaListAuthenticatorsError
                                                                                                                                                                                                                                                                                                              MfaRequiredError
                                                                                                                                                                                                                                                                                                              MfaVerifyError
                                                                                                                                                                                                                                                                                                              MissingRefreshTokenError
                                                                                                                                                                                                                                                                                                              MissingScopesError
                                                                                                                                                                                                                                                                                                              MyAccountApiError
                                                                                                                                                                                                                                                                                                              PasskeyChallengeError
                                                                                                                                                                                                                                                                                                              PasskeyError
                                                                                                                                                                                                                                                                                                              PasskeyGetTokenError
                                                                                                                                                                                                                                                                                                              PasskeyRegisterError
                                                                                                                                                                                                                                                                                                              PopupCancelledError
                                                                                                                                                                                                                                                                                                              PopupOpenError
                                                                                                                                                                                                                                                                                                              PopupTimeoutError
                                                                                                                                                                                                                                                                                                              TimeoutError
                                                                                                                                                                                                                                                                                                              UseDpopNonceError
                                                                                                                                                                                                                                                                                                              User
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              AppState
                                                                                                                                                                                                                                                                                                              AuthConfig
                                                                                                                                                                                                                                                                                                              Authenticator
                                                                                                                                                                                                                                                                                                              AuthorizationParams
                                                                                                                                                                                                                                                                                                              ChallengeAuthenticatorParams
                                                                                                                                                                                                                                                                                                              ChallengeResponse
                                                                                                                                                                                                                                                                                                              EmailAuthenticationMethod
                                                                                                                                                                                                                                                                                                              EmailEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                              EmailEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                              EmailEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                              EnrollEmailParams
                                                                                                                                                                                                                                                                                                              EnrollmentFactor
                                                                                                                                                                                                                                                                                                              EnrollOtpParams
                                                                                                                                                                                                                                                                                                              EnrollPushParams
                                                                                                                                                                                                                                                                                                              EnrollSmsParams
                                                                                                                                                                                                                                                                                                              EnrollVoiceParams
                                                                                                                                                                                                                                                                                                              Factor
                                                                                                                                                                                                                                                                                                              GetTokenSilentlyOptions
                                                                                                                                                                                                                                                                                                              GetTokenWithPopupOptions
                                                                                                                                                                                                                                                                                                              HttpInterceptorConfig
                                                                                                                                                                                                                                                                                                              HttpInterceptorRouteConfig
                                                                                                                                                                                                                                                                                                              ICache
                                                                                                                                                                                                                                                                                                              IdToken
                                                                                                                                                                                                                                                                                                              IsFederatedDomainOptions
                                                                                                                                                                                                                                                                                                              LogoutOptions
                                                                                                                                                                                                                                                                                                              MyAccountApiClient
                                                                                                                                                                                                                                                                                                              ObservableMfaApiClient
                                                                                                                                                                                                                                                                                                              ObservableMyAccountApiClient
                                                                                                                                                                                                                                                                                                              ObservablePasskeyApiClient
                                                                                                                                                                                                                                                                                                              OobEnrollmentResponse
                                                                                                                                                                                                                                                                                                              OtpEnrollmentResponse
                                                                                                                                                                                                                                                                                                              PasskeyApiClient
                                                                                                                                                                                                                                                                                                              PasskeyAuthenticationMethod
                                                                                                                                                                                                                                                                                                              PasskeyCreationOptions
                                                                                                                                                                                                                                                                                                              PasskeyCredentialResponse
                                                                                                                                                                                                                                                                                                              PasskeyEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                              PasskeyEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                              PasskeyEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                              PasskeyErrorResponse
                                                                                                                                                                                                                                                                                                              PasskeyLoginChallengeOptions
                                                                                                                                                                                                                                                                                                              PasskeyLoginChallengeResponse
                                                                                                                                                                                                                                                                                                              PasskeyRequestOptions
                                                                                                                                                                                                                                                                                                              PasskeySignupChallengeResponse
                                                                                                                                                                                                                                                                                                              PasswordAuthenticationMethod
                                                                                                                                                                                                                                                                                                              PasswordEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                              PasswordEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                              PasswordEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                              PhoneAuthenticationMethod
                                                                                                                                                                                                                                                                                                              PhoneEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                              PhoneEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                              PhoneEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                              PopupConfigOptions
                                                                                                                                                                                                                                                                                                              PopupLoginOptions
                                                                                                                                                                                                                                                                                                              PushNotificationAuthenticationMethod
                                                                                                                                                                                                                                                                                                              PushNotificationEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                              PushNotificationEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                              PushNotificationEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                              RecoveryCodeAuthenticationMethod
                                                                                                                                                                                                                                                                                                              RecoveryCodeEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                              RecoveryCodeEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                              RecoveryCodeEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                              RedirectConnectAccountOptions
                                                                                                                                                                                                                                                                                                              RedirectLoginOptions
                                                                                                                                                                                                                                                                                                              TotpAuthenticationMethod
                                                                                                                                                                                                                                                                                                              TotpEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                              TotpEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                              TotpEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                              UpdateAuthenticationMethodRequest
                                                                                                                                                                                                                                                                                                              VerifyParams
                                                                                                                                                                                                                                                                                                              WebAuthnPlatformAuthenticationMethod
                                                                                                                                                                                                                                                                                                              WebAuthnRoamingAuthenticationMethod
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              ApiRouteDefinition
                                                                                                                                                                                                                                                                                                              AuthenticationMethod
                                                                                                                                                                                                                                                                                                              AuthenticationMethodType
                                                                                                                                                                                                                                                                                                              AuthenticatorType
                                                                                                                                                                                                                                                                                                              Cacheable
                                                                                                                                                                                                                                                                                                              ConnectAccountRedirectResult
                                                                                                                                                                                                                                                                                                              ConnectedAccount
                                                                                                                                                                                                                                                                                                              CustomFetchMinimalOutput
                                                                                                                                                                                                                                                                                                              CustomTokenExchangeOptions
                                                                                                                                                                                                                                                                                                              EnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                              EnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                              EnrollmentResponse
                                                                                                                                                                                                                                                                                                              EnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                              EnrollParams
                                                                                                                                                                                                                                                                                                              FetcherConfig
                                                                                                                                                                                                                                                                                                              InteractiveErrorHandler
                                                                                                                                                                                                                                                                                                              MfaFactorType
                                                                                                                                                                                                                                                                                                              MfaGrantType
                                                                                                                                                                                                                                                                                                              OobChannel
                                                                                                                                                                                                                                                                                                              PasskeyLoginOptions
                                                                                                                                                                                                                                                                                                              PasskeySignupChallengeOptions
                                                                                                                                                                                                                                                                                                              PasskeySignupOptions
                                                                                                                                                                                                                                                                                                              RefreshTokenMode
                                                                                                                                                                                                                                                                                                              TokenEndpointResponse
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Auth0ClientService
                                                                                                                                                                                                                                                                                                              AuthConfigService
                                                                                                                                                                                                                                                                                                              RefreshTokenMode
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              authGuardFn
                                                                                                                                                                                                                                                                                                              authHttpInterceptorFn
                                                                                                                                                                                                                                                                                                              isFederatedDomain
                                                                                                                                                                                                                                                                                                              isHttpInterceptorRouteConfig
                                                                                                                                                                                                                                                                                                              provideAuth0
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Enumerations +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Classes +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Interfaces +
                                                                                                                                                                                                                                                                                                              AppStateAuthConfigAuthenticatorAuthorizationParamsChallengeAuthenticatorParamsChallengeResponseEmailAuthenticationMethodEmailEnrollmentChallengeOptionsEmailEnrollmentChallengeResponseEmailEnrollmentVerifyOptionsEnrollEmailParamsEnrollmentFactorEnrollOtpParamsEnrollPushParamsEnrollSmsParamsEnrollVoiceParamsFactorGetTokenSilentlyOptionsGetTokenWithPopupOptionsHttpInterceptorConfigHttpInterceptorRouteConfigICacheIdTokenIsFederatedDomainOptionsLogoutOptionsMyAccountApiClientObservableMfaApiClientObservableMyAccountApiClientObservablePasskeyApiClientOobEnrollmentResponseOtpEnrollmentResponsePasskeyApiClientPasskeyAuthenticationMethodPasskeyCreationOptionsPasskeyCredentialResponsePasskeyEnrollmentChallengeOptionsPasskeyEnrollmentChallengeResponsePasskeyEnrollmentVerifyOptionsPasskeyErrorResponsePasskeyLoginChallengeOptionsPasskeyLoginChallengeResponsePasskeyRequestOptionsPasskeySignupChallengeResponsePasswordAuthenticationMethodPasswordEnrollmentChallengeOptionsPasswordEnrollmentChallengeResponsePasswordEnrollmentVerifyOptionsPhoneAuthenticationMethodPhoneEnrollmentChallengeOptionsPhoneEnrollmentChallengeResponsePhoneEnrollmentVerifyOptionsPopupConfigOptionsPopupLoginOptionsPushNotificationAuthenticationMethodPushNotificationEnrollmentChallengeOptionsPushNotificationEnrollmentChallengeResponsePushNotificationEnrollmentVerifyOptionsRecoveryCodeAuthenticationMethodRecoveryCodeEnrollmentChallengeOptionsRecoveryCodeEnrollmentChallengeResponseRecoveryCodeEnrollmentVerifyOptionsRedirectConnectAccountOptionsRedirectLoginOptionsTotpAuthenticationMethodTotpEnrollmentChallengeOptionsTotpEnrollmentChallengeResponseTotpEnrollmentVerifyOptionsUpdateAuthenticationMethodRequestVerifyParamsWebAuthnPlatformAuthenticationMethodWebAuthnRoamingAuthenticationMethod
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Type Aliases +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Variables +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Functions +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/ApiRouteDefinition.html b/docs/types/ApiRouteDefinition.html index 5905ef0c..1a20fe60 100644 --- a/docs/types/ApiRouteDefinition.html +++ b/docs/types/ApiRouteDefinition.html @@ -1,266 +1,38 @@ - - - - - - ApiRouteDefinition | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                 - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                Type Alias ApiRouteDefinition

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - ApiRouteDefinition: - HttpInterceptorRouteConfig - | - string -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                Defines the type for a route config entry. Can either be:

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                • an object of type HttpInterceptorRouteConfig
                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                • a string
                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - Member Visibility -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - - +ApiRouteDefinition | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                  Type Alias ApiRouteDefinition

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  ApiRouteDefinition: HttpInterceptorRouteConfig | string
                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                  Defines the type for a route config entry. Can either be:

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                  • an object of type HttpInterceptorRouteConfig
                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                  • a string
                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/ConnectAccountRedirectResult.html b/docs/types/ConnectAccountRedirectResult.html index 5c6cdc4a..ee7a4d12 100644 --- a/docs/types/ConnectAccountRedirectResult.html +++ b/docs/types/ConnectAccountRedirectResult.html @@ -1,351 +1,59 @@ - - - - - - ConnectAccountRedirectResult | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                                                     - -
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                    Type Alias ConnectAccountRedirectResult<TAppState>

                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    - ConnectAccountRedirectResult: - CompleteResponse - & - {
                                                                                                                                                                                                                                                                                                                        appState?: - TAppState;
                                                                                                                                                                                                                                                                                                                        response_type: - ConnectCode;
                                                                                                                                                                                                                                                                                                                    } -
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                    - The result returned after a successful account connection redirect. -

                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                    - Combines the redirect login result (including any persisted app - state) with the complete response from the My Account API. -

                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                    • - TAppState = - any -
                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      - The type of application state persisted through the - transaction. -

                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                    Type Declaration

                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                      - OptionalappState?: TAppState -
                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      State stored when the redirect request was made

                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                      - response_type: ConnectCode -
                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      - The type of response, for connect account it will be - connect_code -

                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    - - 
                                                                                                                                                                                                                                                                                                                    const result = await auth0.connectAccountWithRedirect(options);
                                                                                                                                                                                                                                                                                                                    console.log(result.appState); // Access persisted app state
                                                                                                                                                                                                                                                                                                                    console.log(result.connection);   // The connection of the account you connected to.
                                                                                                                                                                                                                                                                                                                    console.log(result.response_type === 'connect_code');   // The response type will be 'connect_code'
+ConnectAccountRedirectResult | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular
+
+
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                      
+
+
                                                                                                                                                                                                                                                                                                                      Type Alias ConnectAccountRedirectResult<TAppState>
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                      ConnectAccountRedirectResult: CompleteResponse & {
                                                                                                                                                                                                                                                                                                                          appState?: TAppState;
                                                                                                                                                                                                                                                                                                                          response_type: ConnectCode;
                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                      The result returned after a successful account connection redirect.
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                      Combines the redirect login result (including any persisted app state)
+with the complete response from the My Account API.
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                      Type Parameters
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                      • TAppState = any
+
                                                                                                                                                                                                                                                                                                                        The type of application state persisted through the transaction.
                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                      Type Declaration
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                      • 
+
                                                                                                                                                                                                                                                                                                                        OptionalappState?: TAppState
                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                        State stored when the redirect request was made
                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                        • 
+
                                                                                                                                                                                                                                                                                                                      • 
+
                                                                                                                                                                                                                                                                                                                        response_type: ConnectCode
                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                        The type of response, for connect account it will be connect_code
                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                                                                      const result = await auth0.connectAccountWithRedirect(options);
                                                                                                                                                                                                                                                                                                                      console.log(result.appState); // Access persisted app state
                                                                                                                                                                                                                                                                                                                      console.log(result.connection);   // The connection of the account you connected to.
                                                                                                                                                                                                                                                                                                                      console.log(result.response_type === 'connect_code');   // The response type will be 'connect_code'
 
                                                                                                                                                                                                                                                                                                                      
-          
                                                                                                                                                                                                                                                                                                                      
-        
                                                                                                                                                                                                                                                                                                                      
-        
-      
                                                                                                                                                                                                                                                                                                                      
-      
                                                                                                                                                                                                                                                                                                                      
-        
                                                                                                                                                                                                                                                                                                                      
-          
                                                                                                                                                                                                                                                                                                                      
-            
                                                                                                                                                                                                                                                                                                                      
-              
-                
-                
                                                                                                                                                                                                                                                                                                                      Settings
                                                                                                                                                                                                                                                                                                                      
-                                                                                                                                                                                                                                                                                                                                    
-              
                                                                                                                                                                                                                                                                                                                      
-                
                                                                                                                                                                                                                                                                                                                      
-                  Member Visibility
-                  
                                                                                                                                                                                                                                                                                                                        
-                    
                                                                                                                                                                                                                                                                                                                      • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                        • 
-                    
                                                                                                                                                                                                                                                                                                                      • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                        • 
-                    
                                                                                                                                                                                                                                                                                                                      • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                        • 
-                  
                                                                                                                                                                                                                                                                                                                      
-                
                                                                                                                                                                                                                                                                                                                      
-                
                                                                                                                                                                                                                                                                                                                      
-                  
-                
                                                                                                                                                                                                                                                                                                                      
-              
                                                                                                                                                                                                                                                                                                                      
-            
                                                                                                                                                                                                                                                                                                                      
-          
                                                                                                                                                                                                                                                                                                                      
-        
                                                                                                                                                                                                                                                                                                                      
-        
                                                                                                                                                                                                                                                                                                                      
-          
-        
                                                                                                                                                                                                                                                                                                                      
-      
                                                                                                                                                                                                                                                                                                                      
-    
                                                                                                                                                                                                                                                                                                                      
-    
                                                                                                                                                                                                                                                                                                                      
-    
                                                                                                                                                                                                                                                                                                                      
-  
-
+
+
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/ConnectedAccount.html b/docs/types/ConnectedAccount.html index a9db7f5c..0f4c75b9 100644 --- a/docs/types/ConnectedAccount.html +++ b/docs/types/ConnectedAccount.html @@ -1,269 +1,34 @@ - - - - - - ConnectedAccount | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                                         - -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                        Type Alias ConnectedAccount

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - ConnectedAccount: - Omit<
                                                                                                                                                                                                                                                                                                                            ConnectAccountRedirectResult,
                                                                                                                                                                                                                                                                                                                            "appState"
                                                                                                                                                                                                                                                                                                                            | - "response_type",
                                                                                                                                                                                                                                                                                                                        > -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                        The account that has been connected during the connect flow.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - Member Visibility -
                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - - +ConnectedAccount | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                          Type Alias ConnectedAccount

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          ConnectedAccount: Omit<
                                                                                                                                                                                                                                                                                                                              ConnectAccountRedirectResult,
                                                                                                                                                                                                                                                                                                                              "appState"
                                                                                                                                                                                                                                                                                                                              | "response_type",
                                                                                                                                                                                                                                                                                                                          >
                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          The account that has been connected during the connect flow.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/PasskeySignupChallengeOptions.html b/docs/types/PasskeySignupChallengeOptions.html index ab4df7e2..8d67783f 100644 --- a/docs/types/PasskeySignupChallengeOptions.html +++ b/docs/types/PasskeySignupChallengeOptions.html @@ -1,311 +1,36 @@ - - - - - - PasskeySignupChallengeOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                                                                                             - -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                            Type Alias PasskeySignupChallengeOptions

                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - PasskeySignupChallengeOptions: - PasskeySignupChallengeBaseOptions - & (
                                                                                                                                                                                                                                                                                                                                | - { - email: - string; - phoneNumber?: - string; - username?: - string - }
                                                                                                                                                                                                                                                                                                                                | - { - email?: - string; - phoneNumber: - string; - username?: - string - }
                                                                                                                                                                                                                                                                                                                                | - { - email?: - string; - phoneNumber?: - string; - username: - string - }
                                                                                                                                                                                                                                                                                                                            ) -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                            Options for requesting a passkey signup challenge.

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                            - At least one user identifier (email, - username, or phoneNumber) must be - provided. Which identifiers are accepted depends on what is - configured on your database connection. -

                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - Member Visibility -
                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - - +PasskeySignupChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                              Type Alias PasskeySignupChallengeOptions

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              PasskeySignupChallengeOptions: PasskeySignupChallengeBaseOptions & (
                                                                                                                                                                                                                                                                                                                                  | { email: string; phoneNumber?: string; username?: string }
                                                                                                                                                                                                                                                                                                                                  | { email?: string; phoneNumber: string; username?: string }
                                                                                                                                                                                                                                                                                                                                  | { email?: string; phoneNumber?: string; username: string }
                                                                                                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Options for requesting a passkey signup challenge.

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              At least one user identifier (email, username, or phoneNumber) must be provided. +Which identifiers are accepted depends on what is configured on your database connection.

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/TokenEndpointResponse.html b/docs/types/TokenEndpointResponse.html index 03aaa6f8..94aae053 100644 --- a/docs/types/TokenEndpointResponse.html +++ b/docs/types/TokenEndpointResponse.html @@ -1,636 +1,84 @@ - - - - - - TokenEndpointResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                 - -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                Type Alias TokenEndpointResponse

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - type - TokenEndpointResponse - = - {
                                                                                                                                                                                                                                                                                                                                    access_token: - string;
                                                                                                                                                                                                                                                                                                                                    expires_in: - number;
                                                                                                                                                                                                                                                                                                                                    id_token: - string;
                                                                                                                                                                                                                                                                                                                                    refresh_token?: - string;
                                                                                                                                                                                                                                                                                                                                    scope?: - string;
                                                                                                                                                                                                                                                                                                                                    token_type: - string;
                                                                                                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                - - access_token - - expires_in - - id_token - - refresh_token? - - scope? - - token_type -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                - access_token: - string -
                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                - expires_in: - number -
                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                - id_token: - string -
                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                - refresh_token?: - string -
                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                - scope?: - string -
                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                - token_type: - string -
                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - Member Visibility -
                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - - Properties - - -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - - +TokenEndpointResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                  Type Alias TokenEndpointResponse

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  type TokenEndpointResponse = {
                                                                                                                                                                                                                                                                                                                                      access_token: string;
                                                                                                                                                                                                                                                                                                                                      expires_in: number;
                                                                                                                                                                                                                                                                                                                                      id_token: string;
                                                                                                                                                                                                                                                                                                                                      refresh_token?: string;
                                                                                                                                                                                                                                                                                                                                      scope?: string;
                                                                                                                                                                                                                                                                                                                                      token_type: string;
                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  access_token +expires_in +id_token +refresh_token? +scope? +token_type +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  access_token: string
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  expires_in: number
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  id_token: string
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  refresh_token?: string
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  scope?: string
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  token_type: string
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/variables/Auth0ClientService.html b/docs/variables/Auth0ClientService.html index 7e2ad37e..1b59a84f 100644 --- a/docs/variables/Auth0ClientService.html +++ b/docs/variables/Auth0ClientService.html @@ -1,257 +1,32 @@ - - - - - - Auth0ClientService | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                                                                     - -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                    Variable Auth0ClientServiceConst

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - Auth0ClientService: - InjectionToken<Auth0Client> = ... -
                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - Member Visibility -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - - +Auth0ClientService | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      Variable Auth0ClientServiceConst

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Auth0ClientService: InjectionToken<Auth0Client> = ...
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/variables/AuthConfigService.html b/docs/variables/AuthConfigService.html index 10d9e5b1..22d44313 100644 --- a/docs/variables/AuthConfigService.html +++ b/docs/variables/AuthConfigService.html @@ -1,282 +1,41 @@ - - - - - - AuthConfigService | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                                                         - -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                                        Variable AuthConfigServiceConst

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        - AuthConfigService: - InjectionToken<AuthConfig> = ... -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                        Injection token for accessing configuration.

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                                        - Use the Inject decorator to access the configuration - from a service or component: -

                                                                                                                                                                                                                                                                                                                                        - 
                                                                                                                                                                                                                                                                                                                                        class MyService(@Inject(AuthConfigService) config: AuthConfig) {}
+AuthConfigService | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular
+
+
                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                          
+
+
                                                                                                                                                                                                                                                                                                                                          Variable AuthConfigServiceConst
                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                          AuthConfigService: InjectionToken<AuthConfig> = ...
                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                          Injection token for accessing configuration.
                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                          Use the Inject decorator to access the configuration from a service or component:
                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                          class MyService(@Inject(AuthConfigService) config: AuthConfig) {}
 
                                                                                                                                                                                                                                                                                                                                          
-          
                                                                                                                                                                                                                                                                                                                                          
-        
                                                                                                                                                                                                                                                                                                                                          
-        
-      
                                                                                                                                                                                                                                                                                                                                          
-      
                                                                                                                                                                                                                                                                                                                                          
-        
                                                                                                                                                                                                                                                                                                                                          
-          
                                                                                                                                                                                                                                                                                                                                          
-            
                                                                                                                                                                                                                                                                                                                                          
-              
-                
-                
                                                                                                                                                                                                                                                                                                                                          Settings
                                                                                                                                                                                                                                                                                                                                          
-                                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                          
-                
                                                                                                                                                                                                                                                                                                                                          
-                  Member Visibility
-                  
                                                                                                                                                                                                                                                                                                                                            
-                    
                                                                                                                                                                                                                                                                                                                                          • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                                            • 
-                    
                                                                                                                                                                                                                                                                                                                                          • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                                            • 
-                    
                                                                                                                                                                                                                                                                                                                                          • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                                            • 
-                  
                                                                                                                                                                                                                                                                                                                                          
-                
                                                                                                                                                                                                                                                                                                                                          
-                
                                                                                                                                                                                                                                                                                                                                          
-                  
-                
                                                                                                                                                                                                                                                                                                                                          
-              
                                                                                                                                                                                                                                                                                                                                          
-            
                                                                                                                                                                                                                                                                                                                                          
-          
                                                                                                                                                                                                                                                                                                                                          
-        
                                                                                                                                                                                                                                                                                                                                          
-        
                                                                                                                                                                                                                                                                                                                                          
-          
-        
                                                                                                                                                                                                                                                                                                                                          
-      
                                                                                                                                                                                                                                                                                                                                          
-    
                                                                                                                                                                                                                                                                                                                                          
-    
                                                                                                                                                                                                                                                                                                                                          
-    
                                                                                                                                                                                                                                                                                                                                          
-  
-
+
+
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          diff --git a/projects/auth0-angular/package.json b/projects/auth0-angular/package.json index f7992328..c9cf6d22 100644 --- a/projects/auth0-angular/package.json +++ b/projects/auth0-angular/package.json @@ -1,6 +1,6 @@ { "name": "@auth0/auth0-angular", - "version": "2.12.0", + "version": "2.13.0", "description": "Auth0 SDK for Angular Single Page Applications (SPA)", "keywords": [ "auth0",