From 498767d289c1cd249b4a22f94c64fafd0e914fa5 Mon Sep 17 00:00:00 2001 From: Yogesh Chaudhary Date: Fri, 18 Sep 2026 19:24:15 +0530 Subject: [PATCH] Release v2.27.0 --- .version | 2 +- CHANGELOG.md | 6 + docs/assets/hierarchy.js | 2 +- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/classes/AnonymousSessionError.html | 198 ++++++++++++++++++ docs/classes/AuthenticationError.html | 2 +- docs/classes/ConnectError.html | 2 +- docs/classes/GenericError.html | 2 +- docs/classes/InvalidConfigurationError.html | 2 +- docs/classes/MfaChallengeError.html | 2 +- docs/classes/MfaEnrollmentError.html | 2 +- docs/classes/MfaEnrollmentFactorsError.html | 2 +- docs/classes/MfaError.html | 2 +- docs/classes/MfaListAuthenticatorsError.html | 2 +- docs/classes/MfaRequiredError.html | 2 +- docs/classes/MfaVerifyError.html | 2 +- docs/classes/MissingRefreshTokenError.html | 2 +- docs/classes/MissingScopesError.html | 2 +- docs/classes/MyAccountApiError.html | 2 +- docs/classes/OAuthError.html | 10 +- docs/classes/PasskeyChallengeError.html | 2 +- docs/classes/PasskeyError.html | 2 +- docs/classes/PasskeyGetTokenError.html | 2 +- docs/classes/PasskeyRegisterError.html | 2 +- docs/classes/PopupCancelledError.html | 2 +- docs/classes/PopupOpenError.html | 2 +- docs/classes/PopupTimeoutError.html | 2 +- docs/classes/TimeoutError.html | 2 +- docs/classes/UseDpopNonceError.html | 2 +- docs/classes/User.html | 44 ++-- docs/enums/ResponseType.html | 6 +- docs/functions/Auth0Provider.html | 2 +- docs/functions/useAuth0.html | 2 +- docs/functions/useAuth0Suspense.html | 2 +- docs/functions/useEnterpriseConnect.html | 2 +- docs/functions/withAuth0.html | 2 +- .../functions/withAuthenticationRequired.html | 2 +- docs/hierarchy.html | 44 ++-- docs/interfaces/ActClaim.html | 4 +- docs/interfaces/AnonymousSession.html | 113 ++++++++++ .../interfaces/AnonymousSessionApiClient.html | 130 ++++++++++++ docs/interfaces/AnonymousSessionClaims.html | 112 ++++++++++ docs/interfaces/Auth0ContextInterface.html | 73 ++++--- docs/interfaces/AuthorizationParams.html | 45 +++- docs/interfaces/ClientConfiguration.html | 6 +- .../CreateAnonymousSessionOptions.html | 78 +++++++ docs/interfaces/EnrollEmailParams.html | 2 +- docs/interfaces/EnrollOtpParams.html | 2 +- docs/interfaces/EnrollPushParams.html | 2 +- docs/interfaces/EnrollSmsParams.html | 2 +- docs/interfaces/EnrollVoiceParams.html | 2 +- docs/interfaces/GetTokenSilentlyOptions.html | 10 +- docs/interfaces/GetTokenWithPopupOptions.html | 8 +- docs/interfaces/IdToken.html | 82 ++++---- docs/interfaces/LogoutOptions.html | 10 +- docs/interfaces/LogoutUrlOptions.html | 6 +- docs/interfaces/PopupConfigOptions.html | 8 +- docs/interfaces/PopupLoginOptions.html | 6 +- .../RedirectConnectAccountOptions.html | 14 +- docs/interfaces/RedirectLoginOptions.html | 12 +- .../interfaces/RevokeRefreshTokenOptions.html | 4 +- docs/interfaces/UseEnterpriseConnect.html | 6 +- docs/interfaces/WithAuth0Props.html | 4 +- .../WithAuthenticationRequiredOptions.html | 12 +- docs/modules.html | 4 +- .../AnonymousGetTokenSilentlyOptions.html | 32 +++ docs/types/AnonymousSessionErrorCode.html | 47 +++++ docs/types/AppState.html | 8 +- docs/types/Auth0ProviderOptions.html | 2 +- .../types/Auth0ProviderWithClientOptions.html | 2 +- .../types/Auth0ProviderWithConfigOptions.html | 2 +- docs/types/Auth0SuspenseContextInterface.html | 2 +- docs/types/CacheLocation.html | 2 +- docs/types/ConnectAccountRedirectResult.html | 2 +- docs/types/ConnectedAccount.html | 2 +- docs/types/TokenEndpointResponse.html | 14 +- docs/variables/Auth0Context.html | 2 +- package-lock.json | 4 +- package.json | 2 +- 80 files changed, 1013 insertions(+), 241 deletions(-) create mode 100644 docs/classes/AnonymousSessionError.html create mode 100644 docs/interfaces/AnonymousSession.html create mode 100644 docs/interfaces/AnonymousSessionApiClient.html create mode 100644 docs/interfaces/AnonymousSessionClaims.html create mode 100644 docs/interfaces/CreateAnonymousSessionOptions.html create mode 100644 docs/types/AnonymousGetTokenSilentlyOptions.html create mode 100644 docs/types/AnonymousSessionErrorCode.html diff --git a/.version b/.version index c142102c..6b5c90e6 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.26.0 \ No newline at end of file +v2.27.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 60fbaa88..87ece400 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.27.0](https://github.com/auth0/auth0-react/tree/v2.27.0) (2026-09-18) +[Full Changelog](https://github.com/auth0/auth0-react/compare/v2.26.0...v2.27.0) + +**Added** +- feat(anonymous): expose anonymous session client via useAuth0 [\#1243](https://github.com/auth0/auth0-react/pull/1243) ([yogeshchoudhary147](https://github.com/yogeshchoudhary147)) + ## [v2.26.0](https://github.com/auth0/auth0-react/tree/v2.26.0) (2026-09-17) [Full Changelog](https://github.com/auth0/auth0-react/compare/v2.25.0...v2.26.0) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index 2db737b2..4d8e5c25 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJyVlV9v2yAUxb8Lz3S1scHEb1P2R5PSdWq77aHqAyLXMSoBD+xJU5XvPjlRO2IngzxFcs71757D5foFOWt7j+pHVlBcsBITxp4wctBokL2yxqP6BRHGxh8jtoBq9M12Q7eyG2Vuu4MEo2dl1qgmlGE0OI1qpEwPrhES/PVM/67ttxphJLXwHtWo9+ur8QVXb0Xjn63SawcG1Y+kIk87jEhFgi4+Q/9gn8H8VH27J6Q1c64soacdRgUrgxa+LIVsIQI8iC61XPBitFzwIuCtrBT6vrdObOAYnRP+it4TwF/PxGdbODzYYVRmeUB7UFuwQ//ROev+Bwp1EcaRxbLio8WShJHeNOIOfg3KwToKnmoTDNJiOsdLYSRonYA7IU8gVnxKTM11Jo7TaDbzd9uBSUO9KRM4JNwH74e+BdMrKcabFIWdkCcQKQ2nRHmvzOYOGge+3d/n+LScqUlgczJn30vbgU+lBuo4j2WLcMmY30Kr9dKaRm0Gl5bx2aIEekGPtqwBp2QUGOouWgJZjktS4pIWmGYFpoRhSimmnGCWLTBjGa6yEleMjcuCsSxo7ruHD53tvlojIdrhTByPosrC1bS0xoCM39tQl8A4+rTeNCJl7V0cc7XIMc8Z5mWOOWOYL/IxzmqRH8NXyvfB/bQuYcLPVsXN83xq3jir9RZMPOa5OoFXTvwuW6E1mE18fGbiBNr0aH+AU82fFFSgTOBMT/FfLp+ETD3E00Ux+m73F5JFaDM=" \ No newline at end of file +window.hierarchyData = "eJyVlV1v2yAUhv8L13T1J2DfTdmHJqXr1HbbRdULRI5jVAIekElTlf8+OVE7YieDXEVy3uPnvC+H4xdkjfEOtY+kynBJGlzQ/AkjC50C4aXRDrUvqKD5+KP5BlCLvplhOyzNWurb4SDB6FnqFWqLmmC0tQq1SGoPtuMC3PVM/673G4UwEoo7h1rk3epqfMHVW9H4Zy/VyoJG7WNB6dMOo4LSoIvP4B/MM+if0vd7Qloz58oSetphVJImaOHLgoseIsCD6FLLJWOj5ZKxgLc0gqt7byxfwzE6L9grek8Adz0Tn23h8GCHUZWRgPYgN2C2/qO1xv4PFOoijCOLFStHi1URRnrT8Tv4tZUWVlHwVJtgsGbTOV5wLUCpBNwJeQKRlVNiaq4zcZxWZzN/twPoNNSbMoFThvvg/db3oL0UfLxJUdgJeQKRZOGUSOekXt9BZ8H1+/scn5YzNQlsRufse2EGcKnUQB3nkbwKl4z+zZVcLYzu5Hpr0zI+W5RAr7KjLavBShEFhrqLlkBGcFU0uKoZrjOG6zLHNclwzSgmeYUJqTHNGkxpPi4LQuqgue8OPgxm+Gq0gGiHM3E8CpqFq2lhtAYRv7ehLoFx9Gm96XjK2rs4ZtoQzIocs4pgRnPMGjLGSRtyDF9K54P7aWzChJ+tiptnxdS8tkapDeh4zHN1Aq+a+F30XCnQ6/j4zMQJtOnR/gAruz8pqECZwJme4r9cPnGReoini2L03e4vx7ZobQ==" \ No newline at end of file diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 2758330b..244b17ed 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJytmcty2zYUht+Fa6dxnCZtvdModuoZq/ZIdrrodIGCRyLGJIACoGq1k3fv8CYCxIUS4KV9fvwfAOJ2jv74L1PwqrLrbA2SMyrh6cAhu8g4UkV2nQGtK/lej/1QqKrMLrIXQvPs+ueLDJdIyuw6UzJ/R+Q7eFUgKCqz7xdH70WtCqCKYKQIozdCMDEi2vYg3ztEJuvD1Wm0JaMUsPJg9Gic/1egIAj2+OvROP87uoKKicMS4QJsgBGOJexRSfIlo1uyq0Xoq3ilceR7hlG5UUygHXjGZ0niSKstWhaoLIHuwDM2SxJNuqGClWUF1LfqbM0bsG4RVkzIU5C6NJ7sByX53hOptN0fHJJHG81ew981EZD7iYYimvMNBNke/BQtHskgUhK6W8NWgCye2Av4trRPmcTdYMbB+90sTSTrsMCY1VQtOPGhppI40kOzxjyIMWZ5aw6PSMoXOMydQU5ZXJ97qzAo3f8rqNDqcqmSeGvYEalAhHmGKpLHeM2XiGIoS++B4BAl0B64fx6NeALjiVTAat/FZEniSGFIuv+zhC+c8d8Yxb6dZEmiSW7zSL8FVssSkWr0JFSB2CLcvHn7oGl99enzyc/qyyWjzZ93g6mb41JaUPeLXZ/rieVREd9/Jsi/7aPyEQlUSS9qoosDHk9Zo/MBcqhBYheGnCrMHVSRsJIAVcbb3Y2zdXHA7sF5UyFSBmbVUqXAxtdtgDWKUlAPis+O6qhJAT3WspgljaIU1KaSs6SjJgX0jREMsyhNFQcLLIWUBTA8ZzakBKrKwwNvNol7JB5tGvh3oor+STBPnorj0HeTBF0D3TkS85Nt87aPbt8uFmksbyEHgRTkX1iFCA1NlU8ch75nO1arEM9QhG7eTvgsynm3URTX69UWLTjpDn8nRhdEIrR0LASyZHG4PhkIw6aiSFSbCLRXZuhL2bIE3D3bhVe1pYqDrSEnArDqa6X9twmBgy3SOjE7aJcwtMPWsGcvoJc/wu4eddyonnmOFJi17hWoguVNnQmke8nOtorsjISbBsIFkdB/OjffIQxNcVfNCtz2uiCu780d16Y1j4JxN8SUhPo7KMfZHap+oaUx2yqYYXG+UUhp96s68CbZ6f8/aXv5y08fPl1Nk79HwfYkB2H1svdyaM7ybUbYHZKnECz1+Sz3eepjBY5VN2tTSw60XcKepFlD+cSnkKbb1AWYapy+Eb+vdW7m73h+qv2b3jnk9h2I/iot1DGQ6N38GmTmrZr/EExgGPfVcJOsQdalspABbXIPIO99PdRjfG71LWupWNXVXl9xgegOPPvJr4wfzZhuH0sYHrpf+aZ0u8zixXtqLVH8eexb0rrbdHaiDVkqd3q56zDnvX4G4RYULkB05/sUYQTjGe1xjrAi+65a/CuieamXfjuaRxbPXW1RV4hwHdBGMJ7RZzjul3NHckiSeRuyo44ChQE0NPFE/T2+Yrk1kdN4PKk7H2nOGfFva6co7T4fyvUjao8EaW5Us5xvUj5enTRJo1V4oj6e0d/hZTZStjXF7Xc2n24m4vOPmlEt2yTn0uUxxE5oPrzcQjaDJmwXSI8My5nsyLD9Z0hLXF7H4AkGdt4RcrTVFuLP/wFPNzhf" \ No newline at end of file +window.navigationData = "eJytmU1z2zYQhv8Lz07jOE3a+uZR7NQzVu2R7PTQ6QElVyLGJIACoGq1k//eISmKBPFBaqGjtC/fB8QHsQv88V+i4U0n18kKlOBMwfNeQHKRCKLz5DoBVpXq/TD2Q67LIrlIXinLkuufL5K0IEol14lW2Tuq3sGbBslIkXy/OHrfMM72Ja/UGpSinN1KyWUPaRxAvXfKTN6Hq5nESufANE2JDvBsEY624IxBqj2YYRTn/xUYSJp6/IdRnP89W0LJ5X5B0hxsgBHGEnakoNmCsw3dVjI0Kl4pjvzAU1KsNZdkC573syQ40nJDFjkpCmBb8LybJUGTbpnkRVEC8806W3MG1h1JNZdqDnIoxZP9oCjfB6r0YPUHX8mjRbNX8HdFJWR+oqFAc76BpJu9nzKIIxlUKcq2K9hIUPkzfwXfkvYpo7jrlAvwjpulQbL2N2nKK6ZvBPWhxhIc6bGeYx5EH7O8Bw5PRKlX2E99g5wyXJsPVmFQvP9X0KHZ5VJF8VawpUqDDPMMFZLHRSUWhKVQFN4PgkMUQXsU/n404hGMZ1oCr3wbkyXBkcKQeP8XBV8EF79xlvpWkiVBk9zm2Nw31YuC0LL3pEyD3JC0znkPQdP66tNnVCLvRoxE50HdCLooKDA9i3lUnwfedJmaRW6lSGyl88sFZ/XP+w7hprqUFtRdEA2n8sjyqMC3n0v6b5OzPxFJfH1m63DA4yZmND5ADj0Q2YSuSA5zOxUS1sxpozRy42wdEiiBaBjP8UdRO3p6OPQErhFtUXFbEloEhtZSxcD6CibA6kUxqEctJt/qqIkBPVUqnyT1ohjUulSTpKMmBvSN0xQmUQMVDhaYCjEToEtZ17QApot9aF15tHHg36nOD2nfNHksxqHvR4cwA9C94/Bltm3WtNHt28aQxuoOMpBEQ/aFl4QGP34+MQ79wLe80iGeoQht/63wRRbTbr0I1+rlhoRztaEAiRiU3CGQJcPhDgVfGDYWIVFNsdfs26GRsmURuAe+Dc9qS4WDrSCjElJ9OA8/jE0IHHwirhGTL+0ShlbYCnb8FYZHXGF3jxr3Vi8iq5Mu4z5jCTrnWX2WCMo9ZSefQjZGwW0NEZIqOAydm+8Qhrq4PbEM7PZDAa7t9R7X1FZPkgs3xJSE2tsp+97tTnZDU2PyqWCZ1+Xdk6mF3oth9Tovvbj85acPn67wd34LnoG3CWNhBFuItSbaRh3+dzqP6/AnyXc0A+nrOYfmJN96nNutYg7BUp/Ocu8qPlZgc3Gz1pUSwJqF7Dm/GKB84jmk8cfKBRhrIuaSw828I/dT7fvyU8hNNkz+KizUMRDpXd97mkcIA/8uGMEwdu1uP12BqgptIQPa6BZAdvD1UI/xqdm3qJTmZXvL8JbmhG3Bs578Svzb9IcOx9MkD92vPCvdPvHy4j3HXij+NPactDanmOxoQxbLHac4Q5gzuzmBcAc6zUG23/cxwgjiGc3nnKSa7tp7kV8Jy4rhJUdL88jw3OWGtMcxrg+0EcQzDnWeu35oSQ5JNG9Nt8xxTGMADQ2eOKxKlo6EbRzHk9rvI8sEp/5l7RTF7efdzUmP2hFJ6x3VvFkxKR+vZnVSbxXuqI8ntLfLzHrKpmJpM85m6mYiPv84MKpUU+pdujy62IzHu8wtZNNpwnaBItGwnKgRDdt/uuLM5XUMzjCwq6+Qo622EH/+D7Liats=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 528c24f0..306d49f2 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "eJy1ml1v2zoShv8Lc6uTml9O4rtuTg9QoNgWzdndCyMoVIlOhDiSVpTTFkH++wGpr6E4cihHvQtizsuXnIdDSuIzqYofmmy2z+Qhy1OyoewyInn8qMiGfH5/qO8/VFVRkYgcqj3ZkGQfa630u+Gn8/v6cU+i7heyIeQl6tQkZb1aUuS6rg5J/brcmdsWSEekjCuV1667oUO6YqLvUYVYP+tavamXb6nSSZWVdVbkYT2OImb0zuS679z8vrou8lr9rD/mtap2caJ6A1n3H/0ObXg0d84gkyLPVVK/T5LikNf/y+r7ryrNKpXU8zo7a4XiRuhHVt9XgxA+CfgYp4xWKq7VX6pO7lU115uN3fWxS9g56Lp4/Lt4UPmHn8l9nN/NzM5Zo1AbBTUoLGDNXR1hZvy1Uuv0j0z/keX3qspqlZ5upx2cnau5ttrYuo1dYHbuVK6quFZ/lkX5pSqK3UxLXXxaFmXZxi9iy6xBpbWdpptsr/J6/2u2N7P+lNZ2vvQgsrhBUyi+FOWhfJNDUyXKVmUZi9dFvsvuDlXs1Otgb8kofBlTBrV/F/nc+m0MGcryNnQZMx9Tm8DrfZw96vmGstRmLunCFzB1H+fpXnXbznW833+Pk4eZ1hqRbstJBpEFDGbaNFd5nSVxUwnnOMt0PIr+DUU205+KOM3yu9nm9n3cb7C1L+4yWyuu37xdWilTMH7bvtmbPaWw9fYWrGe9oROPZL2nZU9i++KuOJzgpQlawMDjLp7ZexOxRNe/2pPyXAO/4j5uARtlrPWDmns8GKIWsFCpp+JBfVW7Sun7U852jUDVCCx4wNOnb7h68Q33oGc/rLQhy1Rj+Ej5yS7Bz/bBFN35nQZHHyGhbFecPplqc0QdaxfcyX+0+mCkyirT6rp51MQ6wdqFPwxn+i+VNqf7P4vHOEORnuziLNO7LjztwnGG0OG8tgvc3Hye56ev/1oXp1qBSTAmLHBfqqJEc+y2CJ94c0JaBQqedY3x8YxMHh9JeyrLivyr+v8hq1R6BOBXg2a9dTEr9vRezgaF49MwPcJjuL15Fhr2il5mYZNF/i+1KyrlBr/BbpF/t4LxWHBx410ZnDirB/utHJ2FbVaqPlT538UbHDYS9XThmWOOra4uqBxeOb8vy5s6rof9vf5Vml21/ffs158qHR/rEMGzvvGrZ7nO3uT06rLItfpmejna5bjlqf2N0ol39UrCkF68vLSF9ylLVTUuIm2nSJPjx4Bjfdhny32mcu9cg/TmNX5jv/ZlUWi/sPH8fm8OulS53aDxLwKg26m2s3q9Pr4wxj8f1eajwVyPdr+nuMri7/vRsfio5Frgeek1d4c8sXPtpiJU9KDt3rJC9Lqf5kp1aTki2TWZIT19Knbk5x2KQRc/uuMUotv/NlfML/lH1P3GWHe3EcnyVP0km2fypCptdu8NYef8/IpEZJepfWq+hjZOIpIUj4/KUp0WycH+eds2+68yXydN46b1uxWJtquIr88vGL29jbZdsP3B/qPTGP5jAymJthQLpF4gdQIZibYs4vR8TZkTyLxA5gRyEm051iP3ArkTKEi0FVig8AKFEyhJtJVYoPQCpRO4JtF2jQWuvcC1E3hBou0FFnjhBV44gZdTs3rpBV46gVck2l5iPV55gVcuAIaHK5QAnx06gsfSg3JHEX5cgKjBguLs+QxRFyJq0KAMDfY5oi5I1OBBUQapzxJ1YaIGEYpySH2eqAsUNZhQlEXqM0VdqKhBhaI8Up8r6oJFDS4UZZL6bFEXLmqQoShe1OeLuoAxwwxFCWM+YcwljBlmGEoY8wljoxJlaxRKGEOqlEsYM8wwlDDmE8ZcwphhhqGEMZ8w5hLGDDMMJYz5hDGXMGaYYShhzCeMuYQxwwxDCWM+YcwljNnahRLGfMKYSxgzzDCUMOYTxlzCuGGGoYRxnzDuEsYNM3yF1VzuE8ZdwrhhhqOEcZ8wPtoI7U6IEsaRvdAljBtmOL6P+oRxlzBumOEoYdwnjLuEccMMRwnjPmHcJYwbZjhKGPcJ4y5h3DDDUcK4Txh3CeOGGY4Sxn3CuEuYMMxwlDDhEyZcwoRhRqCECZ8w4RImDDMCJUz4hAmXMGGYEeh5QviEidFxy563UMIEcuJyCRNyesw+YcIlTBhmBH7U8wkTLmHCMCNQPIVPmHAJE4YZgeIpfMKES5gwzAgUT+ETJlzC5GoyVdInTLqESUsYyrb0CZMuYdIShrItfcKkS5g0zEh0f5Y+YdIlTBpmJMq29AmTo0O9nKzbEjnXu4RJw4xES6/0CZMuYdIwI9GFIX3C2n/ZZ78nVdUq/dg8A263JC5L3bwifCbf2kdDQbtH0WciGNk8v7wMj4Kb5xfwNGh+M321HxsGDS4GDS7DNfoX9sDO5SAl6WypbHgJBDTBCMMVy/71CVC6Au5mTFan1b/8B5LQ3Xq+pL3+YV/gYeISiF+cKG7f0mHiayB+GS6u2zc6R1N2AbSvgrSPXbYdhMGEhIHqv+AGLhlwyRsBuQqVHS59D4pgMYbBjywhDvLCw5I+ugw8aAGpMDbRm0iDHkhrmLP2Eu6gAKacNTFh6CH30MGUgRkLU3Mv4Q5KoHyFYYvcnR3UQLmhYVxNXXcFiK2AaBhkkzdUgSokN6wy+ndLgRxIMw1LiXszFEiB5NKw+u/f6QRyoF7TsBIydQ8TiIKyRMMWmneFEqiBVUvDlhlyTQOsDpBbHpZbcIcS+AKrn4atWveTObAEpPgMqcnLksAlWMI0bA2PLzoCMbCCWdgKRm4oguoHFi8LW7zujRcwhWCJ8bAl1l1YBH4AGiwMjUYEySkDE8/CJt7eYQQKcHMIGxK4hAh0QMlgYSWjsKtxvFmBbIUlf+rOBUgbmCUeNkujixFAC9Apwgz29yXBbIGKyMIqYudnankzYIyHGRvdCgCHNJBMEZbM4bM/kAG5FLQJFKGj9W91grGC2s/Car+e2OoYKPwsrPAftPIe5yQYqgxbRp2M7j/oAjlQI2RYAg5aqf7rbNJ9xAXgAoe8TYYMS0ZzlRTMGdhJWNhOYoqpP2mg9siwNPY6ZXN3EIwPHkjDpqwTG6pG1X9HBi6BsAwjZFoY25cBzDxgFm4jUmal2me5Ipvt7cvLP7Cd2BM="; \ No newline at end of file +window.searchData = "eJy1ml1v27gShv8Lc6um4Zdj+64n2wUKFKdFs7vnwggKVaJjIbakI8ppgyD/fUF9DsWRQznqXRBzXr4kHw4paZ5Jkf3UZL15Jg9JGpM1ZcuApOFBkTX58uFY7j4WRVaQgByLPVmTaB9qrfT7/qfLXXnYk6D9hawJeQlaNUlZpxZlqS6LY1S+LndhtwXSAcnDQqWl7a7vkF4x0fWofKxftK3e1Mv3WOmoSPIyyVK/HgcRE3pnctF1bn6/usnSUv0qP6WlKrZhpDoDSfsf/R5teHLtrEGGaZY+HbKjnqZ9AePwIeIjGLERZWmqovJDFGXHtPxfUu6+qTgpVFRO9NUIhbXQz6TcFb3QHEYLFZbqT1VGO1VM9VbFbrvYOewcdZkd/soeVPrxV7QL0/uJkFzUCqVRUL3CDNbsTepnxt2ypY7fJfpdku5UkZQqPt9OM7hqrqbaamLLJnaG2blXqSrCUv2RZ/nXIsu2Ey218XGe5XkTP4stsweV1tU03SZ7lZb7p8nezP5TWlfzpXuR2Q2aRPE1y4/5mxyaLJE3KvNYvMnSbXJ/LELr2PD2Fg3C5zFlUPtvlk49RowhQ1nahM5j5lNcLeDNPkwOU8+ee1UmcbVyURs+g6ldmMZ71R47N+F+/yOMHiZaq0XaIyfqRWYwmGjTXKVlEoV1JpziLNHhIPo3JNlEf87COEnvJ5vbd3G/wdY+u0+qXHHz5uOykjIJ47edm53ZcxJbZ2/GfNYZOvNK1nma9ya2z+6z4xle6qAZDBy24cTe64g5un5qbspTDTyFXdwMNvJQ6wc19XrQR81goVCP2YP6praF0rtz7na1QFELzHjB0+cfuHr2A/eoJz+sNCHzZGP4ZPu52oJfqudj9OS3Gpx8koWybXL6bLLNCXWsnXcnf2v10UjlRaLVTf2oiXWCtfN/Jk/0nyqub/d/ZIcwQZEe7eIi0ds2PG7DcYbQ4bx2Ctzefpnmp8v/WmfnWoGLYExUwH0tshxdY7vFhJchJsZT8KJtjI9nYPL0SJpbWZKl39T/j0mh4hMAvxrkP96o3rHn93LRK5yehvERnsLtzbNQs5d1MjObzNL/qG1WKDv4DXaz9EclGA4FZzfepsGRu7q338LSmdlmocpjkf6VvcFhLVGOJ54p5tjV6prK/s33hzy/LcOyP9/Lp9ycqs2/J21Ek/BUPLzWIYIXXeNX73KtvdHp1XmWavXd9HKyy2HLc/sbLCfe1SsLhvTirEuTeB+TWBXDJNJ0ijQ5fQ041Uf1bLlPVOrca5DenMZv7Ld6WeTbL2w8vd/bo85VWh3Q+IcJ0O1Y20m93pzeGMOfT2rzwWBuBqffY1gk4Y/94Fp8UnIh8HXpNLfHNKrm2l4KX9Gjrs6WK0Sv/WmqVLssJyTbJhOkx2/Flvy0SzHo4md7nUJ0u9+mirkp/4S62xjr7i4gSRqrX2T9TB5Voc3pvSbskl+uSEC2idrH5qNs7SQgUXY4qIrqOIuO1Z93TbN/lPlIahrXrd9fkWBzFfDF5XK5ursLNm1w9UP1j1aj/08VSEmwoVggdQKpFchIsGEBp5fXS2oFMieQWYGcBBuO9cidQG4FChJsBBYonEBhBUoSbCQWKJ1AaQUuSLBZYIELJ3BhBV6TYHONBV47gddW4JIEmyUWuHQCl1bgamw5Vk7gygbA8LBCCXDZoQN4KnpQ7ijCjw0QNVhQnD2XIWpDRA0alKHBLkfUBokaPCjKIHVZojZM1CBCUQ6pyxO1gaIGE4qySF2mqA0VNahQlEfqckVtsKjBhaJMUpctasNFDTIU5ZK6fFEbMGaYoShhzCWM2YQxwwxDCWMuYWyQoqochRLGkCxlE8YMMwwljLmEMZswZphhKGHMJYzZhDHDDEMJYy5hzCaMGWYYShhzCWM2Ycwww1DCmEsYswljhhmGEsZcwphNGKvyF0oYcwljNmHcMMNQwrhLGLcJ44YZjhLGXcK4TRg3zHCK5V3uEsYHB2F1EqKEceQstAnjhhmOn6MuYdwmjBtmOEoYdwnjNmHcMMNRwrhLGLcJ44YZjhLGXcK4TRg3zHCUMO4Sxm3CuGGGo4RxlzBuEyYMMxwlTLiECZswYZgRKGHCJUzYhAnDjEAJEy5hwiZMGGYESphwCROD61Z13+Joz8iNyyZMGGYEfltzCRM2YWIxPmaXMGETJgwzAsVTuIQJmzBhmBEonsIlTNiECcOMQPEULmHCJkwaZgSKp3QJkzZhko4ulXQJkzZhsiIMZVu6hEmbMGmYkSjb0iVM2oRJw4xEz2fpEiYHl/rqVo+yLZF7vU2YXIzmbekSJm3CpGFGoqlXuoRJmzBpmJHoxpAuYc2/qgfHR1WUKv5UP0BuNrA485l8bx4sZfsc+0wkWT+/vPSPkevnF/AkaX4zXYV5ruu3lL2IYL2K4H4y9eN3r8GBE77w1+i+GQA7KzAoNlkq6d9DAU0wQn/FvHuDA2b8CribMFmtVvf9AZgDcyeup0tWFSjVO0RMfAHEl2eKVy8KMfFrIL7yF9fNS6WTS7YEE33lpX2q3rcXBhPiB6r7jh245GAGRC0gqa9sX/7eK9Je0FtnuIU4WBfut+iDeuReC0j5sYkWQ/V6YFn9nDV1wL0CSFesjvFDD6nIB1MGZsxPza4D7pVA+qJ+3CL1u4AHkHCoHxFjNbdAFFLml2NHy2SBKlgZ6jeLboErkANrQv3Stl2eCqTAAUD9Tkq3sBTIgYxN/ZLIWDEoEAWJifptNaeOE6iBfUv9NhpSKwL2B1hb7re2oJAT+AL7n/rtW/u7PbAEpPgEqdGKTeASbGLmt4mH1ZYgX4EdzPx2MFImCfTA5mV+m9cuuwFTCNOe3xZrqyaBH5iQ/dCoRZA1ZWDiud/EV4WUQAEMifkNCVRCAh2QMphfysiq3Tg8rsDq+w1orPADLBuYJeEralVngBsM8Cf86OyKNsFsgYzI/DJi62d0ewNj3M/YoDQBDBI+APgtZl97AGTAzhPN3UP4jtYtLQXTB3I/88v9euSoYyDxM7/Ef9TKeaCTYKjSbxu1Mrr7qgzkQI6Qfgtw1Ep1n4ij9ksy4AM45M1iSL/FqOtZwZyBk4T5nSQmmbqTBnKP9FvGTievCxjB+ACz3G/KWrE+axTdx2zgEghLP0LGhbGNC2DmHrNwF5A8ydU+SRVZb+5eXv4Ff9I0KA=="; \ No newline at end of file diff --git a/docs/classes/AnonymousSessionError.html b/docs/classes/AnonymousSessionError.html new file mode 100644 index 00000000..a8239c08 --- /dev/null +++ b/docs/classes/AnonymousSessionError.html @@ -0,0 +1,198 @@ +AnonymousSessionError | @auth0/auth0-react
+
@auth0/auth0-react + +
    +
    +
    Preparing search index...
    +
    +
    +
    + +

    Class AnonymousSessionError

    +
    +

    Error thrown when an anonymous session operation fails.

    +

    The code field identifies the specific failure reason. Codes session_expired +and invalid_session_token are handled silently by AnonymousSessionClient.getAccessToken +and will never reach the caller from that method. All other codes are surfaced directly.

    +
    +
    +

    Hierarchy

    +
      +
    • Error +
        +
      • AnonymousSessionError
    +
    +
    +
    +
    Index
     +
    +
    + +
    constructor +
    +
    + +
    cause? +code +message +name +stack? +stackTraceLimit +
    +
    + +
    captureStackTrace +prepareStackTrace +
    +
    + +
    +
    + +
      +
    • + +
      +
      +

      Parameters

      +
        +
      • code: string
        • +
      • message: string
        • +
      • Optionalcause: AnonymousSessionApiErrorResponse
      +

      Returns AnonymousSessionError

    +
    + +
    +
    + +
    cause?: AnonymousSessionApiErrorResponse
    +

    The raw error response from Auth0, if available.

    +
    +
    + +
    code: string
    +

    Machine-readable error code identifying the failure reason. +Maps to the error field in the Auth0 API response.

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

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

    +

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

    +

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

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

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

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

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

      +

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

      +

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

      +
      function a() {
        b();
      }

      function b() {
        c();
      }

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

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

      a();
+
      + +
      +
      +

      Parameters

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

      Returns void

    +
    + +
    +
    +
    +
    +
    +

    Settings

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

    On This Page

     +
    +
    Constructors +
    +
    Properties +
    +
    Methods +
    +
    +
    +
    diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index 3694d24f..af8007f2 100644 --- a/docs/classes/AuthenticationError.html +++ b/docs/classes/AuthenticationError.html @@ -14,7 +14,7 @@

    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)

    • GenericError diff --git a/docs/classes/ConnectError.html b/docs/classes/ConnectError.html index 2f3e785f..e855bc3b 100644 --- a/docs/classes/ConnectError.html +++ b/docs/classes/ConnectError.html @@ -14,7 +14,7 @@

      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)

    • GenericError diff --git a/docs/classes/GenericError.html b/docs/classes/GenericError.html index 16bf4f07..b353fac3 100644 --- a/docs/classes/GenericError.html +++ b/docs/classes/GenericError.html @@ -13,7 +13,7 @@

      Class GenericError

      Thrown when network requests to the Auth server fail.

      -
      +

      Hierarchy (View Summary)

      • Error diff --git a/docs/classes/InvalidConfigurationError.html b/docs/classes/InvalidConfigurationError.html index 3a122b44..7807ec57 100644 --- a/docs/classes/InvalidConfigurationError.html +++ b/docs/classes/InvalidConfigurationError.html @@ -14,7 +14,7 @@

        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)

      • GenericError diff --git a/docs/classes/MfaChallengeError.html b/docs/classes/MfaChallengeError.html index e236000d..40867627 100644 --- a/docs/classes/MfaChallengeError.html +++ b/docs/classes/MfaChallengeError.html @@ -19,7 +19,7 @@
      -
      +

      Hierarchy (View Summary)

      • MfaError diff --git a/docs/classes/MfaEnrollmentError.html b/docs/classes/MfaEnrollmentError.html index 0eb7ebf6..aa35f93b 100644 --- a/docs/classes/MfaEnrollmentError.html +++ b/docs/classes/MfaEnrollmentError.html @@ -19,7 +19,7 @@
      -
      +

      Hierarchy (View Summary)

      • MfaError diff --git a/docs/classes/MfaEnrollmentFactorsError.html b/docs/classes/MfaEnrollmentFactorsError.html index 6ab610ac..6e01600b 100644 --- a/docs/classes/MfaEnrollmentFactorsError.html +++ b/docs/classes/MfaEnrollmentFactorsError.html @@ -19,7 +19,7 @@
      -
      +

      Hierarchy (View Summary)

      • MfaError diff --git a/docs/classes/MfaError.html b/docs/classes/MfaError.html index b9ededfe..f7381b43 100644 --- a/docs/classes/MfaError.html +++ b/docs/classes/MfaError.html @@ -14,7 +14,7 @@

        Class MfaError

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

      -
      +

      Hierarchy (View Summary)

      • GenericError diff --git a/docs/classes/MfaListAuthenticatorsError.html b/docs/classes/MfaListAuthenticatorsError.html index a5914ff0..a03eff79 100644 --- a/docs/classes/MfaListAuthenticatorsError.html +++ b/docs/classes/MfaListAuthenticatorsError.html @@ -19,7 +19,7 @@
      -
      +

      Hierarchy (View Summary)

    @@ -71,12 +71,12 @@
    error: string
    +
  • Defined in src/errors.tsx:8
    • error_description?: string
    +
  • Defined in src/errors.tsx:8
    • message: string
    @@ -67,107 +67,107 @@
    act?: ActClaim
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:911
    • address?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:908
    • birthdate?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:903
    • email?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:900
    • email_verified?: boolean
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:901
    • family_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:893
    • gender?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:902
    • given_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:892
    • locale?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:905
    • middle_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:894
    • name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:891
    • nickname?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:895
    • phone_number?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:906
    • phone_number_verified?: boolean
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:907
    • picture?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:898
    • preferred_username?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:896
    • profile?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:897
    • sub?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:910
    • updated_at?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:909
    • website?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:899
    • zoneinfo?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:904
    • diff --git a/docs/enums/ResponseType.html b/docs/enums/ResponseType.html index ab83ee43..223def55 100644 --- a/docs/enums/ResponseType.html +++ b/docs/enums/ResponseType.html @@ -18,7 +18,7 @@

    Enumeration ResponseType

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:502
    • @@ -36,12 +36,12 @@
    Code: "code"
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:503
    • ConnectCode: "connect_code"
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:504
    • diff --git a/docs/functions/Auth0Provider.html b/docs/functions/Auth0Provider.html index b08a09c0..ba7afb41 100644 --- a/docs/functions/Auth0Provider.html +++ b/docs/functions/Auth0Provider.html @@ -34,7 +34,7 @@

    Parameters

  • opts: Auth0ProviderOptions<TUser>

    • Returns Element

    +
  • Defined in src/auth0-provider.tsx:203
    • diff --git a/docs/functions/useAuth0.html b/docs/functions/useAuth0.html index 6e4b2e2b..0ecbca74 100644 --- a/docs/functions/useAuth0.html +++ b/docs/functions/useAuth0.html @@ -31,7 +31,7 @@

    Parameters

  • context: Context<Auth0ContextInterface<User>> = Auth0Context

    • Returns Auth0ContextInterface<TUser>

    +
  • Defined in src/use-auth0.tsx:29
    • diff --git a/docs/functions/useAuth0Suspense.html b/docs/functions/useAuth0Suspense.html index c299a274..fd136e38 100644 --- a/docs/functions/useAuth0Suspense.html +++ b/docs/functions/useAuth0Suspense.html @@ -37,7 +37,7 @@

    Parameters

  • context: Context<Auth0ContextInterface<User>> = Auth0Context

    • Returns Auth0SuspenseContextInterface<TUser>

    +
  • Defined in src/use-auth0-suspense.tsx:43
    • diff --git a/docs/functions/useEnterpriseConnect.html b/docs/functions/useEnterpriseConnect.html index e821ac49..cd885a86 100644 --- a/docs/functions/useEnterpriseConnect.html +++ b/docs/functions/useEnterpriseConnect.html @@ -29,7 +29,7 @@

    Parameters

  • context: Context<Auth0ContextInterface<User>> = Auth0Context

    • Returns UseEnterpriseConnect

    +
  • Defined in src/use-enterprise-connect.tsx:46
    • diff --git a/docs/functions/withAuth0.html b/docs/functions/withAuth0.html index 9f1ae20a..8fe132bd 100644 --- a/docs/functions/withAuth0.html +++ b/docs/functions/withAuth0.html @@ -33,7 +33,7 @@

    Parameters

  • context: Context<Auth0ContextInterface<User>> = Auth0Context

    • Returns ComponentType<Omit<P, "auth0">>

    +
  • Defined in src/with-auth0.tsx:29
    • diff --git a/docs/functions/withAuthenticationRequired.html b/docs/functions/withAuthenticationRequired.html index a63ae1be..5e191230 100644 --- a/docs/functions/withAuthenticationRequired.html +++ b/docs/functions/withAuthenticationRequired.html @@ -32,7 +32,7 @@

    Parameters

  • options: WithAuthenticationRequiredOptions = {}

    • Returns FC<P>

    +
  • Defined in src/with-authentication-required.tsx:103
    • diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 020161f4..cb046adf 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -10,35 +10,35 @@

    @auth0/auth0-react

    Hierarchy Summary

    +
  • MfaListAuthenticatorsError
    • +
  • MfaEnrollmentError
    • +
  • MfaChallengeError
    • +
  • MfaVerifyError
    • +
  • MfaEnrollmentFactorsError
    • +
  • LocalStorageCache
    • +
  • GetTokenWithPopupOptions
    • diff --git a/docs/interfaces/ActClaim.html b/docs/interfaces/ActClaim.html index b574a8e6..544d4601 100644 --- a/docs/interfaces/ActClaim.html +++ b/docs/interfaces/ActClaim.html @@ -26,7 +26,7 @@

    Indexable

  • [key: string]: any
    • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:833
    • @@ -45,7 +45,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:835
    • diff --git a/docs/interfaces/AnonymousSession.html b/docs/interfaces/AnonymousSession.html new file mode 100644 index 00000000..d8b4d848 --- /dev/null +++ b/docs/interfaces/AnonymousSession.html @@ -0,0 +1,113 @@ +AnonymousSession | @auth0/auth0-react
    +
    @auth0/auth0-react + +
      +
      +
      Preparing search index...
      +
      +
      +
      + +

      Interface AnonymousSession

      +
      +

      Represents an active anonymous session.

      +

      Stores both the long-lived session token (used to re-mint access tokens) +and the current short-lived access token (used to call APIs).

      +
      +
      interface AnonymousSession {
          accessToken: string;
          expiresAt: number;
          scope?: string;
          sessionReplaced?: boolean;
          sessionToken: string;
          sessionTokenExpiresAt?: number;
      }
      +
      +
      +
      +
      Index
       +
      +
      + +
      accessToken +expiresAt +scope? +sessionReplaced? +sessionToken +sessionTokenExpiresAt? +
      +
      + +
      +
      + +
      accessToken: string
      +

      Short-lived Bearer token for calling APIs.

      +
      +
      + +
      expiresAt: number
      +

      Unix timestamp (seconds) at which the access token expires.

      +
      +
      + +
      scope?: string
      +

      Scopes granted to this anonymous session.

      +
      +
      + +
      sessionReplaced?: boolean
      +

      true when getAccessToken() was called with a sessionToken that had +expired or been invalidated, and a fresh anonymous identity was silently +created to replace it.

      +

      When true the returned sessionToken belongs to a new identity — +the previous sub, any attached metadata, and any server-side state keyed +to the old identity are permanently gone.

      +

      Absent when createSession() is called directly or when getAccessToken() +is called without a sessionToken.

      +
      +
      + +
      sessionToken: string
      +

      Long-lived handle for the anonymous identity. +Never sent to APIs directly. Used by the SDK to re-mint access tokens.

      +
      +
      + +
      sessionTokenExpiresAt?: number
      +

      Unix timestamp (seconds) at which the session token itself expires.

      +

      The session token is minted once and never reissued, so this value counts +down on every response rather than resetting. Absent when the API response +does not include session_expires_in.

      +

      Use this — not expiresAt — to drive cookie Max-Age or session expiry UI.

      +
      +
      +
      +
      +
      +

      Settings

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

      On This Page

       +
      +
      Properties +
      +
      +
      +
      diff --git a/docs/interfaces/AnonymousSessionApiClient.html b/docs/interfaces/AnonymousSessionApiClient.html new file mode 100644 index 00000000..a6d60a24 --- /dev/null +++ b/docs/interfaces/AnonymousSessionApiClient.html @@ -0,0 +1,130 @@ +AnonymousSessionApiClient | @auth0/auth0-react
      +
      @auth0/auth0-react + +
        +
        +
        Preparing search index...
        +
        +
        +
        + +

        Interface AnonymousSessionApiClient

        +
        +

        Browser-layer wrapper around auth0-auth-js AnonymousSessionClient.

        +

        Adds local session storage (localStorage or memory) so callers never need to +manage the session token themselves. getTokenSilently() returns a cached +access token when still valid and renews it transparently when expired.

        +

        The session token is stored once and shared across all audience/scope slots. +Each slot stores only its own access token and expiry.

        +

        Exposed on Auth0Client as auth0.anonymous.

        +
        +
        interface AnonymousSessionApiClient {
            createSession(
                options?: CreateAnonymousSessionOptions,
            ): Promise<AnonymousSession>;
            getClaims(): null;
            getTokenSilently(
                options?: AnonymousGetTokenSilentlyOptions,
            ): Promise<AnonymousTokenResult>;
            hasSession(): boolean;
            logout(): Promise<void>;
        }
        +
        +
        +
        +
        Index
         +
        +
        + +
        createSession +getClaims +getTokenSilently +hasSession +logout +
        +
        + +
        +
        + +
        +
        + +
          +
        • + +
          +

          Always returns null in EA — session tokens are issued as opaque JWEs and +cannot be decoded client-side. Reserved for future JWT format support.

          +
          +

          Returns null

        +
        + +
          +
        • + +
          +

          Returns a valid anonymous access token, creating or renewing the session as needed.

          +

          If the stored access token is still fresh (more than 60 s remaining), it is +returned directly without a network call. Otherwise the session token is used +to re-mint the access token. If the session token has also expired, auth0-auth-js +silently creates a fresh identity (any previously set metadata is lost).

          +
          +
          +

          Parameters

          +
          +

          Returns Promise<AnonymousTokenResult>

        +
        + +
          +
        • + +
          +

          Returns true if a session token exists in the local cache.

          +
          +

          Returns boolean

        +
        + +
          +
        • + +
          +

          Ends the anonymous session and clears all locally stored tokens.

          +
          +

          Returns Promise<void>

        +
        +
        +
        +
        +

        Settings

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

        On This Page

         +
        +
        Methods +
        +
        +
        +
        diff --git a/docs/interfaces/AnonymousSessionClaims.html b/docs/interfaces/AnonymousSessionClaims.html new file mode 100644 index 00000000..4a57fa76 --- /dev/null +++ b/docs/interfaces/AnonymousSessionClaims.html @@ -0,0 +1,112 @@ +AnonymousSessionClaims | @auth0/auth0-react
        +
        @auth0/auth0-react + +
          +
          +
          Preparing search index...
          +
          +
          +
          + +

          Interface AnonymousSessionClaims

          +
          +

          Decoded claims from an anonymous session token (JWT).

          +

          Not returned by any method in EA. In EA, session tokens are issued as +opaque JWEs — they cannot be decoded client-side and no SDK method currently +returns this type. It is exported for forward compatibility: if session tokens +move to a readable JWT format in a future release, this interface will describe +the claims shape without a breaking change.

          +
          +
          interface AnonymousSessionClaims {
              aud: string | string[];
              exp: number;
              iat: number;
              iss: string;
              metadata?: Record<string, string>;
              sid: string;
              sub: string;
          }
          +
          +
          +
          +
          Index
           +
          +
          + +
          aud +exp +iat +iss +metadata? +sid +sub +
          +
          + +
          +
          + +
          aud: string | string[]
          +

          Audience — the tenant issuer URL.

          +
          +
          + +
          exp: number
          +

          Expiry timestamp (seconds since epoch).

          +
          +
          + +
          iat: number
          +

          Issued-at timestamp (seconds since epoch).

          +
          +
          + +
          iss: string
          +

          Issuer of the token.

          +
          +
          + +
          metadata?: Record<string, string>
          +

          Up to 1KB of key-value metadata set at session creation time.

          +
          +
          + +
          sid: string
          +

          Session ID.

          +
          +
          + +
          sub: string
          +

          Subject — the anonymous identity, e.g. anon@<uuid>.

          +
          +
          +
          +
          +
          +

          Settings

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

          On This Page

           +
          +
          Properties +
          +
          +
          +
          diff --git a/docs/interfaces/Auth0ContextInterface.html b/docs/interfaces/Auth0ContextInterface.html index 38a619bd..6958f8aa 100644 --- a/docs/interfaces/Auth0ContextInterface.html +++ b/docs/interfaces/Auth0ContextInterface.html @@ -13,7 +13,7 @@

          Interface Auth0ContextInterface<TUser>

          Contains the authenticated state and authentication methods provided by the useAuth0 hook.

          -
          interface Auth0ContextInterface<TUser extends User = User> {
              connectAccountWithRedirect: (
                  options: RedirectConnectAccountOptions,
              ) => Promise<void>;
              createFetcher: <TOutput extends CustomFetchMinimalOutput = Response>(
                  config?: FetcherConfig<TOutput>,
              ) => Fetcher<TOutput>;
              customTokenExchange: (
                  options: CustomTokenExchangeOptions,
              ) => Promise<TokenEndpointResponse>;
              error: Error | undefined;
              exchangeToken: (
                  options: CustomTokenExchangeOptions,
              ) => Promise<TokenEndpointResponse>;
              generateDpopProof: (
                  params: {
                      accessToken: string;
                      method: string;
                      nonce?: string;
                      url: string;
                  },
              ) => Promise<string>;
              getAccessTokenSilently: {
                  (
                      options: GetTokenSilentlyOptions & { detailedResponse: true },
                  ): Promise<GetTokenSilentlyVerboseResponse | undefined>;
                  (options?: GetTokenSilentlyOptions): Promise<string | undefined>;
              };
              getAccessTokenWithPopup: (
                  options?: GetTokenWithPopupOptions,
                  config?: PopupConfigOptions,
              ) => Promise<string | undefined>;
              getConfiguration: () => Readonly<ClientConfiguration>;
              getDpopNonce: (id?: string) => Promise<string | undefined>;
              getIdTokenClaims: () => Promise<IdToken | undefined>;
              handleRedirectCallback: (
                  url?: string,
              ) => Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>;
              isAuthenticated: boolean;
              isLoading: boolean;
              loginWithCustomTokenExchange: (
                  options: CustomTokenExchangeOptions,
              ) => Promise<TokenEndpointResponse>;
              loginWithPopup: (
                  options?: PopupLoginOptions,
                  config?: PopupConfigOptions,
              ) => Promise<void>;
              loginWithRedirect: (
                  options?: RedirectLoginOptions<AppState>,
              ) => Promise<void>;
              logout: (options?: LogoutOptions) => Promise<void>;
              mfa: MfaApiClient;
              myAccount: MyAccountApiClient;
              passkey: PasskeyApiClient;
              revokeRefreshToken: (options?: RevokeRefreshTokenOptions) => Promise<void>;
              setDpopNonce: (nonce: string, id?: string) => Promise<void>;
              user: TUser | undefined;
          }
          +
          interface Auth0ContextInterface<TUser extends User = User> {
              anonymous: AnonymousSessionApiClient;
              connectAccountWithRedirect: (
                  options: RedirectConnectAccountOptions,
              ) => Promise<void>;
              createFetcher: <TOutput extends CustomFetchMinimalOutput = Response>(
                  config?: FetcherConfig<TOutput>,
              ) => Fetcher<TOutput>;
              customTokenExchange: (
                  options: CustomTokenExchangeOptions,
              ) => Promise<TokenEndpointResponse>;
              error: Error | undefined;
              exchangeToken: (
                  options: CustomTokenExchangeOptions,
              ) => Promise<TokenEndpointResponse>;
              generateDpopProof: (
                  params: {
                      accessToken: string;
                      method: string;
                      nonce?: string;
                      url: string;
                  },
              ) => Promise<string>;
              getAccessTokenSilently: {
                  (
                      options: GetTokenSilentlyOptions & { detailedResponse: true },
                  ): Promise<GetTokenSilentlyVerboseResponse | undefined>;
                  (options?: GetTokenSilentlyOptions): Promise<string | undefined>;
              };
              getAccessTokenWithPopup: (
                  options?: GetTokenWithPopupOptions,
                  config?: PopupConfigOptions,
              ) => Promise<string | undefined>;
              getConfiguration: () => Readonly<ClientConfiguration>;
              getDpopNonce: (id?: string) => Promise<string | undefined>;
              getIdTokenClaims: () => Promise<IdToken | undefined>;
              handleRedirectCallback: (
                  url?: string,
              ) => Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>;
              isAuthenticated: boolean;
              isLoading: boolean;
              loginWithCustomTokenExchange: (
                  options: CustomTokenExchangeOptions,
              ) => Promise<TokenEndpointResponse>;
              loginWithPopup: (
                  options?: PopupLoginOptions,
                  config?: PopupConfigOptions,
              ) => Promise<void>;
              loginWithRedirect: (
                  options?: RedirectLoginOptions<AppState>,
              ) => Promise<void>;
              logout: (options?: LogoutOptions) => Promise<void>;
              mfa: MfaApiClient;
              myAccount: MyAccountApiClient;
              passkey: PasskeyApiClient;
              revokeRefreshToken: (options?: RevokeRefreshTokenOptions) => Promise<void>;
              setDpopNonce: (nonce: string, id?: string) => Promise<void>;
              user: TUser | undefined;
          }

          Type Parameters

            @@ -25,7 +25,7 @@

            Hierarchy

            • Auth0ContextInterface
          +
        • Defined in src/auth0-context.tsx:34
          • @@ -33,7 +33,8 @@
          Index
          -
          connectAccountWithRedirect +
          anonymous +connectAccountWithRedirect createFetcher customTokenExchange error @@ -62,6 +63,22 @@
          + +
          anonymous: AnonymousSessionApiClient
          +
          const { anonymous } = useAuth0();
          const { accessToken } = await anonymous.getTokenSilently({ audience: 'https://api.example.com' });
+
          + +

          Anonymous session client for pre-authentication identity management.

          +
            +
          • createSession(options?) - Create a new anonymous session
            • +
          • getTokenSilently(options?) - Get or renew an anonymous access token
            • +
          • logout() - End the anonymous session and clear stored tokens
            • +
          • getClaims() - Always returns null in EA
            • +
          +
          +
          connectAccountWithRedirect: (
              options: RedirectConnectAccountOptions,
          ) => Promise<void>
          await 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
            }
          });
@@ -74,7 +91,7 @@
          +
        • Defined in src/auth0-context.tsx:252
          • createFetcher: <TOutput extends CustomFetchMinimalOutput = Response>(
              config?: FetcherConfig<TOutput>,
          ) => Fetcher<TOutput>
          @@ -107,7 +124,7 @@

          Parameters

        • Optionalconfig: FetcherConfig<TOutput>

          • Returns Fetcher<TOutput>

          +
        • Defined in src/auth0-context.tsx:350
          • customTokenExchange: (
              options: CustomTokenExchangeOptions,
          ) => Promise<TokenEndpointResponse>
          @@ -138,13 +155,13 @@

          Parameters

          Returns Promise<TokenEndpointResponse>

          A promise that resolves to the token endpoint response.

          +
        • Defined in src/auth0-context.tsx:165
          • error: Error | undefined
          +
        • Defined in src/auth-state.tsx:7
          • exchangeToken: (
              options: CustomTokenExchangeOptions,
          ) => Promise<TokenEndpointResponse>
          @@ -179,7 +196,7 @@
          +
        • Defined in src/auth0-context.tsx:198
          • generateDpopProof: (
              params: {
                  accessToken: string;
                  method: string;
                  nonce?: string;
                  url: string;
              },
          ) => Promise<string>
          @@ -204,7 +221,7 @@

          Parameters

        • params: { accessToken: string; method: string; nonce?: string; url: string }

          • Returns Promise<string>

          +
        • Defined in src/auth0-context.tsx:340
          • getAccessTokenSilently: {
              (
                  options: GetTokenSilentlyOptions & { detailedResponse: true },
              ): Promise<GetTokenSilentlyVerboseResponse | undefined>;
              (options?: GetTokenSilentlyOptions): Promise<string | undefined>;
          }
          @@ -252,7 +269,7 @@

          Parameters

        • Optionaloptions: GetTokenSilentlyOptions

          • Returns Promise<string | undefined>

          +
        • Defined in src/auth0-context.tsx:62
          • getAccessTokenWithPopup: (
              options?: GetTokenWithPopupOptions,
              config?: PopupConfigOptions,
          ) => Promise<string | undefined>
          @@ -266,7 +283,7 @@
          +
        • Defined in src/auth0-context.tsx:76
          • getConfiguration: () => Readonly<ClientConfiguration>
          @@ -294,7 +311,7 @@
          +
        • Defined in src/auth0-context.tsx:361
          • getDpopNonce: (id?: string) => Promise<string | undefined>
          @@ -334,7 +351,7 @@
          +
        • Defined in src/auth0-context.tsx:320
          • getIdTokenClaims: () => Promise<IdToken | undefined>
          @@ -344,7 +361,7 @@
          +
        • Defined in src/auth0-context.tsx:88
          • handleRedirectCallback: (
              url?: string,
          ) => Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>
          @@ -368,19 +385,19 @@

          Parameters

          Returns Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>

          +
        • Defined in src/auth0-context.tsx:305
          • isAuthenticated: boolean
          +
        • Defined in src/auth-state.tsx:8
          • isLoading: boolean
          +
        • Defined in src/auth-state.tsx:9
          • loginWithCustomTokenExchange: (
              options: CustomTokenExchangeOptions,
          ) => Promise<TokenEndpointResponse>
          @@ -423,7 +440,7 @@

          Returns Promise

          +
        • Defined in src/auth0-context.tsx:138
          • loginWithPopup: (
              options?: PopupLoginOptions,
              config?: PopupConfigOptions,
          ) => Promise<void>
          @@ -439,7 +456,7 @@
          +
        • Defined in src/auth0-context.tsx:229
          • loginWithRedirect: (options?: RedirectLoginOptions<AppState>) => Promise<void>
          @@ -451,7 +468,7 @@
          +
        • Defined in src/auth0-context.tsx:211
          • logout: (options?: LogoutOptions) => Promise<void>
          @@ -464,7 +481,7 @@
          +
        • Defined in src/auth0-context.tsx:266
          • mfa: MfaApiClient
          @@ -488,7 +505,7 @@
          +
        • Defined in src/auth0-context.tsx:415
          • myAccount: MyAccountApiClient
          @@ -515,7 +532,7 @@
          +
        • Defined in src/auth0-context.tsx:467
          • passkey: PasskeyApiClient
          @@ -531,7 +548,7 @@
          +
        • Defined in src/auth0-context.tsx:431
          • revokeRefreshToken: (options?: RevokeRefreshTokenOptions) => Promise<void>
          @@ -568,7 +585,7 @@

          Parameters

          Returns Promise<void>

          +
        • Defined in src/auth0-context.tsx:295
          • setDpopNonce: (nonce: string, id?: string) => Promise<void>
          @@ -607,13 +624,13 @@
          +
        • Defined in src/auth0-context.tsx:332
          • user: TUser | undefined
          +
        • Defined in src/auth-state.tsx:10
          • @@ -630,7 +647,7 @@

          Settings

          On This Page

          Properties -
          +
          anonymousconnectAccountWithRedirectcreateFetchercustomTokenExchangeerrorexchangeTokengenerateDpopProofgetAccessTokenSilentlygetAccessTokenWithPopupgetConfigurationgetDpopNoncegetIdTokenClaimshandleRedirectCallbackisAuthenticatedisLoadingloginWithCustomTokenExchangeloginWithPopuploginWithRedirectlogoutmfamyAccountpasskeyrevokeRefreshTokensetDpopNonceuser
          -
          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 @@
          +
        • 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 -
          +
          acr_valuesaudienceconnectiondisplayexperiment_idid_token_hintinvitationlogin_hintmax_ageorganizationpromptredirect_uriscopescreen_hintsegment_idsession_transfer_tokenui_localesvariation_id
          interface ClientConfiguration {
              clientId: string;
              domain: string;
          }
          +
        • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:428
          • @@ -35,14 +35,14 @@
          +
        • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:436
          • domain: string

          The Auth0 domain that was configured

          +
        • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:432
          • diff --git a/docs/interfaces/CreateAnonymousSessionOptions.html b/docs/interfaces/CreateAnonymousSessionOptions.html new file mode 100644 index 00000000..3e6e4c19 --- /dev/null +++ b/docs/interfaces/CreateAnonymousSessionOptions.html @@ -0,0 +1,78 @@ +CreateAnonymousSessionOptions | @auth0/auth0-react
          +
          @auth0/auth0-react + +
            +
            +
            Preparing search index...
            +
            +
            +
            + +

            Interface CreateAnonymousSessionOptions

            +
            +

            Options for creating a new anonymous session.

            +

            Metadata is set once at creation time and cannot be changed afterwards.

            +
            +
            interface CreateAnonymousSessionOptions {
                audience?: string;
                metadata?: Record<string, string>;
                scope?: string;
            }
            +
            +
            +
            +
            Index
             +
            +
            + +
            audience? +metadata? +scope? +
            +
            + +
            +
            + +
            audience?: string
            +

            The API audience the access token should be scoped to. +Must be a resource server that has allow_anonymous_access enabled.

            +
            +
            + +
            metadata?: Record<string, string>
            +

            Up to 1KB of arbitrary key-value metadata to attach to the anonymous session. +Set once at creation time — cannot be changed after the session is created.

            +
            +
            + +
            scope?: string
            +

            Space-separated list of scopes to request.

            +
            +
            +
            +
            +
            +

            Settings

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

            On This Page

             +
            +
            Properties +
            +
            +
            +
            diff --git a/docs/interfaces/EnrollEmailParams.html b/docs/interfaces/EnrollEmailParams.html index 583a6e5b..22351dd2 100644 --- a/docs/interfaces/EnrollEmailParams.html +++ b/docs/interfaces/EnrollEmailParams.html @@ -14,7 +14,7 @@

            Interface EnrollEmailParams

            Email enrollment parameters

            interface EnrollEmailParams {
                email?: string;
                factorType: "email";
                mfaToken: string;
            }
            -
            +

            Hierarchy

            • EnrollBaseParams diff --git a/docs/interfaces/EnrollOtpParams.html b/docs/interfaces/EnrollOtpParams.html index 7a2ae391..f0907502 100644 --- a/docs/interfaces/EnrollOtpParams.html +++ b/docs/interfaces/EnrollOtpParams.html @@ -14,7 +14,7 @@

              Interface EnrollOtpParams

            OTP (Time-based One-Time Password) enrollment parameters

            interface EnrollOtpParams {
                factorType: "otp";
                mfaToken: string;
            }
            -
            +

            Hierarchy

            • EnrollBaseParams diff --git a/docs/interfaces/EnrollPushParams.html b/docs/interfaces/EnrollPushParams.html index 5691b612..0a346872 100644 --- a/docs/interfaces/EnrollPushParams.html +++ b/docs/interfaces/EnrollPushParams.html @@ -14,7 +14,7 @@

              Interface EnrollPushParams

            Push notification enrollment parameters

            interface EnrollPushParams {
                factorType: "push";
                mfaToken: string;
            }
            -
            +

            Hierarchy

            • EnrollBaseParams diff --git a/docs/interfaces/EnrollSmsParams.html b/docs/interfaces/EnrollSmsParams.html index ae8f61fd..1fb57e09 100644 --- a/docs/interfaces/EnrollSmsParams.html +++ b/docs/interfaces/EnrollSmsParams.html @@ -14,7 +14,7 @@

              Interface EnrollSmsParams

              SMS enrollment parameters

            interface EnrollSmsParams {
                factorType: "sms";
                mfaToken: string;
                phoneNumber: string;
            }
            -
            +

            Hierarchy

            • EnrollBaseParams diff --git a/docs/interfaces/EnrollVoiceParams.html b/docs/interfaces/EnrollVoiceParams.html index 9e600585..dde29718 100644 --- a/docs/interfaces/EnrollVoiceParams.html +++ b/docs/interfaces/EnrollVoiceParams.html @@ -14,7 +14,7 @@

              Interface EnrollVoiceParams

              Voice enrollment parameters

            interface EnrollVoiceParams {
                factorType: "voice";
                mfaToken: string;
                phoneNumber: string;
            }
            -
            +

            Hierarchy

            • EnrollBaseParams diff --git a/docs/interfaces/GetTokenSilentlyOptions.html b/docs/interfaces/GetTokenSilentlyOptions.html index a8a7141a..20bb2aa9 100644 --- a/docs/interfaces/GetTokenSilentlyOptions.html +++ b/docs/interfaces/GetTokenSilentlyOptions.html @@ -12,7 +12,7 @@

              Interface GetTokenSilentlyOptions

              interface GetTokenSilentlyOptions {
                  authorizationParams?: {
                      audience?: string;
                      redirect_uri?: string;
                      scope?: string;
                      [key: string]: any;
                  };
                  cacheMode?: "on"
                  | "off"
                  | "cache-only";
                  detailedResponse?: boolean;
                  timeoutInSeconds?: number;
              }
              +
            • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:554
            @@ -59,7 +59,7 @@
            Optionalscope

            The scope that was used in the authentication request

            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:565
            • cacheMode?: "on" | "off" | "cache-only"
            @@ -69,7 +69,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:561
            • detailedResponse?: boolean
            @@ -78,7 +78,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:599
            • timeoutInSeconds?: number
            @@ -86,7 +86,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:592
            • diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index 7e0d3658..7d98990b 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -11,14 +11,14 @@
          • GetTokenWithPopupOptions

            • Interface GetTokenWithPopupOptions

            interface GetTokenWithPopupOptions {
                authorizationParams?: AuthorizationParams;
                cacheMode?: "on" | "off" | "cache-only";
            }
            -
            +

            Hierarchy (View Summary)

            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:601
            • @@ -40,7 +40,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:163
            • cacheMode?: "on" | "off" | "cache-only"
            @@ -49,7 +49,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:607
            • diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html index 16a3f899..9df61efc 100644 --- a/docs/interfaces/IdToken.html +++ b/docs/interfaces/IdToken.html @@ -17,7 +17,7 @@

            Indexable

          • [key: string]: any
            • +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:838
            • @@ -73,12 +73,12 @@
            __raw: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:839
            • acr?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:870
            • act?: ActClaim
            @@ -87,162 +87,162 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:887
            • address?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:857
            • amr?: string[]
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:871
            • at_hash?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:868
            • aud?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:860
            • auth_time?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:867
            • azp?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:865
            • birthdate?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:852
            • c_hash?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:869
            • cnf?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:873
            • email?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:849
            • email_verified?: boolean
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:850
            • exp?: number
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:861
            • family_name?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:842
            • gender?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:851
            • given_name?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:841
            • iat?: number
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:863
            • iss?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:859
            • jti?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:864
            • locale?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:854
            • middle_name?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:843
            • name?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:840
            • nbf?: number
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:862
            • nickname?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:844
            • nonce?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:866
            • org_id?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:875
            • org_name?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:876
            • phone_number?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:855
            • phone_number_verified?: boolean
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:856
            • picture?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:847
            • preferred_username?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:845
            • profile?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:846
            • session_expiry?: number
            @@ -250,32 +250,32 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:881
            • sid?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:874
            • sub_jwk?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:872
            • updated_at?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:858
            • website?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:848
            • zoneinfo?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:853
            • diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index a4b66a4b..5b3fc70f 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -11,14 +11,14 @@
          • LogoutOptions

            • Interface LogoutOptions

            interface LogoutOptions {
                clientId?: string | null;
                logoutParams?: {
                    federated?: boolean;
                    returnTo?: string;
                    [key: string]: any;
                };
                openUrl?: false
                | ((url: string) => void | Promise<void>);
            }
            -
            +

            Hierarchy

            • Omit<SPALogoutOptions, "onRedirect">
              • LogoutOptions
            +
          • Defined in src/auth0-context.tsx:26
            • @@ -43,7 +43,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:619
            • logoutParams?: { federated?: boolean; returnTo?: string; [key: string]: any }
            @@ -77,7 +77,7 @@
            OptionalreturnT
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:624
            • openUrl?: false | ((url: string) => void | Promise<void>)
            @@ -97,7 +97,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:685
            • diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index e6366da8..d302f074 100644 --- a/docs/interfaces/LogoutUrlOptions.html +++ b/docs/interfaces/LogoutUrlOptions.html @@ -12,7 +12,7 @@

            Interface LogoutUrlOptions

            interface LogoutUrlOptions {
                            clientId?: string | null;
                logoutParams?: {
                    federated?: boolean;
                    returnTo?: string;
                    [key: string]: any;
                };
            }
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:609
            • @@ -35,7 +35,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:619
            • logoutParams?: { federated?: boolean; returnTo?: string; [key: string]: any }
            @@ -68,7 +68,7 @@
            OptionalreturnT

            Read more about how redirecting after logout works

            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:624
            • diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index 747cc860..ac96fa7b 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -12,7 +12,7 @@

            Interface PopupConfigOptions

            interface PopupConfigOptions {
                closePopup?: boolean;
                popup?: any;
                timeoutInSeconds?: number;
            }
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:518
            • @@ -50,7 +50,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:552
            • popup?: any
            @@ -59,7 +59,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:529
            • timeoutInSeconds?: number
            @@ -67,7 +67,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:523
            • diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index fa702b92..5471a899 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -11,7 +11,7 @@
          • PopupLoginOptions

            • Interface PopupLoginOptions

            interface PopupLoginOptions {
                authorizationParams?: AuthorizationParams;
            }
            -
            +

            Hierarchy (View Summary)

            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:516
            • @@ -41,7 +41,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:163
            • diff --git a/docs/interfaces/RedirectConnectAccountOptions.html b/docs/interfaces/RedirectConnectAccountOptions.html index 477ef083..46197b1c 100644 --- a/docs/interfaces/RedirectConnectAccountOptions.html +++ b/docs/interfaces/RedirectConnectAccountOptions.html @@ -16,7 +16,7 @@

            Type Parameters

            • TAppState = any
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:687
            • @@ -46,7 +46,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:727
            • authorization_params?: AuthorizationParams
            @@ -59,14 +59,14 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:713
            • connection: string

            The name of the connection to link (e.g. 'google-oauth2').

            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:691
            • openUrl?: (url: string) => Promise<void>
            @@ -79,14 +79,14 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:737
            • redirectUri?: string

            The URI to redirect back to after connecting the account.

            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:717
            • scopes?: string[]
            @@ -99,7 +99,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:701
            • diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index 19b3043a..714ba816 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -15,14 +15,14 @@

            Interface RedirectLoginOptions<TAppState>

            Type Parameters

             -
            +

            Hierarchy

            • Omit<SPARedirectLoginOptions<TAppState>, "onRedirect">
              • RedirectLoginOptions
            +
          • Defined in src/auth0-context.tsx:28
            • @@ -45,7 +45,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:459
            • authorizationParams?: AuthorizationParams
            @@ -54,7 +54,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:163
            • fragment?: string
            @@ -62,7 +62,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:463
            • openUrl?: (url: string) => void | Promise<void>
            @@ -81,7 +81,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:495
            • diff --git a/docs/interfaces/RevokeRefreshTokenOptions.html b/docs/interfaces/RevokeRefreshTokenOptions.html index 89013053..06892f5c 100644 --- a/docs/interfaces/RevokeRefreshTokenOptions.html +++ b/docs/interfaces/RevokeRefreshTokenOptions.html @@ -15,7 +15,7 @@

            Interface RevokeRefreshTokenOptions

            interface RevokeRefreshTokenOptions {
                            audience?: string;
            }
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:936
            • @@ -34,7 +34,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:938
            • diff --git a/docs/interfaces/UseEnterpriseConnect.html b/docs/interfaces/UseEnterpriseConnect.html index 9647eb29..c2d73fb2 100644 --- a/docs/interfaces/UseEnterpriseConnect.html +++ b/docs/interfaces/UseEnterpriseConnect.html @@ -15,7 +15,7 @@

            Interface UseEnterpriseConnect

            interface UseEnterpriseConnect {
                isFederatedDomain: (
                    emailDomain: string,
                    options?: IsFederatedDomainOptions,
                ) => Promise<boolean>;
                loginWithSSO: (
                    email: string,
                    options?: RedirectLoginOptions<AppState>,
                ) => Promise<void>;
            }
            +
          • Defined in src/use-enterprise-connect.tsx:14
            • @@ -38,7 +38,7 @@
            +
          • Defined in src/use-enterprise-connect.tsx:21
            • loginWithSSO: (
                email: string,
                options?: RedirectLoginOptions<AppState>,
            ) => Promise<void>
            @@ -47,7 +47,7 @@
            +
          • Defined in src/use-enterprise-connect.tsx:30
            • diff --git a/docs/interfaces/WithAuth0Props.html b/docs/interfaces/WithAuth0Props.html index 55d235d5..ef00f1a4 100644 --- a/docs/interfaces/WithAuth0Props.html +++ b/docs/interfaces/WithAuth0Props.html @@ -15,7 +15,7 @@

            Interface WithAuth0Props

            interface WithAuth0Props {
                auth0: Auth0ContextInterface;
            }
            +
          • Defined in src/with-auth0.tsx:7
            • @@ -32,7 +32,7 @@
            auth0: Auth0ContextInterface
            +
          • Defined in src/with-auth0.tsx:8
            • diff --git a/docs/interfaces/WithAuthenticationRequiredOptions.html b/docs/interfaces/WithAuthenticationRequiredOptions.html index 8a3f0679..a03155b5 100644 --- a/docs/interfaces/WithAuthenticationRequiredOptions.html +++ b/docs/interfaces/WithAuthenticationRequiredOptions.html @@ -15,7 +15,7 @@

            Interface WithAuthenticationRequiredOptions

            interface WithAuthenticationRequiredOptions {
                context?: Context<Auth0ContextInterface<User>>;
                loginOptions?: RedirectLoginOptions<AppState>;
                onBeforeAuthentication?: () => Promise<void>;
                onRedirecting?: () => Element;
                returnTo?: string | (() => string);
            }
            +
          • Defined in src/with-authentication-required.tsx:33
            • @@ -40,7 +40,7 @@
            +
          • Defined in src/with-authentication-required.tsx:92
            • loginOptions?: RedirectLoginOptions<AppState>
            @@ -51,7 +51,7 @@
            +
          • Defined in src/with-authentication-required.tsx:86
            • onBeforeAuthentication?: () => Promise<void>
            @@ -61,7 +61,7 @@
            +
          • Defined in src/with-authentication-required.tsx:71
            • onRedirecting?: () => Element
            @@ -71,7 +71,7 @@
            +
          • Defined in src/with-authentication-required.tsx:61
            • returnTo?: string | (() => string)
            @@ -85,7 +85,7 @@
            +
          • Defined in src/with-authentication-required.tsx:51
            • diff --git a/docs/modules.html b/docs/modules.html index 51f9d964..ece97873 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -12,7 +12,7 @@

            @auth0/auth0-react

            ClientConfiguration
            -
            ResponseType
            AuthenticationError
            ConnectError
            GenericError
            InMemoryCache
            InvalidConfigurationError
            LocalStorageCache
            MfaChallengeError
            MfaEnrollmentError
            MfaEnrollmentFactorsError
            MfaError
            MfaListAuthenticatorsError
            MfaRequiredError
            MfaVerifyError
            MissingRefreshTokenError
            MissingScopesError
            MyAccountApiError
            OAuthError
            PasskeyChallengeError
            PasskeyError
            PasskeyGetTokenError
            PasskeyRegisterError
            PopupCancelledError
            PopupOpenError
            PopupTimeoutError
            TimeoutError
            UseDpopNonceError
            User
            ActClaim
            Auth0ContextInterface
            Authenticator
            AuthorizationParams
            ChallengeAuthenticatorParams
            ChallengeResponse
            EnrollEmailParams
            EnrollmentFactor
            EnrollOtpParams
            EnrollPushParams
            EnrollSmsParams
            EnrollVoiceParams
            Factor
            GetTokenSilentlyOptions
            GetTokenWithPopupOptions
            ICache
            IdToken
            IsFederatedDomainOptions
            LogoutOptions
            LogoutUrlOptions
            MfaApiClient
            MyAccountApiClient
            PasskeyApiClient
            PopupConfigOptions
            PopupLoginOptions
            RedirectConnectAccountOptions
            RedirectLoginOptions
            RevokeRefreshTokenOptions
            UpdateAuthenticationMethodRequest
            UseEnterpriseConnect
            VerifyParams
            WithAuth0Props
            WithAuthenticationRequiredOptions
            AppState
            Auth0ProviderOptions
            Auth0ProviderWithClientOptions
            Auth0ProviderWithConfigOptions
            Auth0SuspenseContextInterface
            AuthenticationMethod
            AuthenticationMethodType
            Cacheable
            CacheLocation
            ConnectAccountRedirectResult
            ConnectedAccount
            CustomTokenExchangeOptions
            EnrollmentChallengeOptions
            EnrollmentChallengeResponse
            EnrollmentResponse
            EnrollmentVerifyOptions
            EnrollParams
            FetcherConfig
            InteractiveErrorHandler
            MfaFactorType
            PasskeyLoginOptions
            PasskeySignupOptions
            RefreshTokenMode
            TokenEndpointResponse
            Auth0Context
            RefreshTokenMode
            Auth0Provider
            useAuth0
            useAuth0Suspense
            useEnterpriseConnect
            withAuth0
            withAuthenticationRequired
            +
            ResponseType
            AnonymousSessionError
            AuthenticationError
            ConnectError
            GenericError
            InMemoryCache
            InvalidConfigurationError
            LocalStorageCache
            MfaChallengeError
            MfaEnrollmentError
            MfaEnrollmentFactorsError
            MfaError
            MfaListAuthenticatorsError
            MfaRequiredError
            MfaVerifyError
            MissingRefreshTokenError
            MissingScopesError
            MyAccountApiError
            OAuthError
            PasskeyChallengeError
            PasskeyError
            PasskeyGetTokenError
            PasskeyRegisterError
            PopupCancelledError
            PopupOpenError
            PopupTimeoutError
            TimeoutError
            UseDpopNonceError
            User
            ActClaim
            AnonymousSession
            AnonymousSessionApiClient
            AnonymousSessionClaims
            Auth0ContextInterface
            Authenticator
            AuthorizationParams
            ChallengeAuthenticatorParams
            ChallengeResponse
            CreateAnonymousSessionOptions
            EnrollEmailParams
            EnrollmentFactor
            EnrollOtpParams
            EnrollPushParams
            EnrollSmsParams
            EnrollVoiceParams
            Factor
            GetTokenSilentlyOptions
            GetTokenWithPopupOptions
            ICache
            IdToken
            IsFederatedDomainOptions
            LogoutOptions
            LogoutUrlOptions
            MfaApiClient
            MyAccountApiClient
            PasskeyApiClient
            PopupConfigOptions
            PopupLoginOptions
            RedirectConnectAccountOptions
            RedirectLoginOptions
            RevokeRefreshTokenOptions
            UpdateAuthenticationMethodRequest
            UseEnterpriseConnect
            VerifyParams
            WithAuth0Props
            WithAuthenticationRequiredOptions
            AnonymousGetTokenSilentlyOptions
            AnonymousSessionErrorCode
            AppState
            Auth0ProviderOptions
            Auth0ProviderWithClientOptions
            Auth0ProviderWithConfigOptions
            Auth0SuspenseContextInterface
            AuthenticationMethod
            AuthenticationMethodType
            Cacheable
            CacheLocation
            ConnectAccountRedirectResult
            ConnectedAccount
            CustomTokenExchangeOptions
            EnrollmentChallengeOptions
            EnrollmentChallengeResponse
            EnrollmentResponse
            EnrollmentVerifyOptions
            EnrollParams
            FetcherConfig
            InteractiveErrorHandler
            MfaFactorType
            PasskeyLoginOptions
            PasskeySignupOptions
            RefreshTokenMode
            TokenEndpointResponse
            Auth0Context
            RefreshTokenMode
            Auth0Provider
            useAuth0
            useAuth0Suspense
            useEnterpriseConnect
            withAuth0
            withAuthenticationRequired
            @@ -31,7 +31,7 @@

            On This Page

            Main
            Other -
            ResponseTypeAuthenticationErrorConnectErrorGenericErrorInMemoryCacheInvalidConfigurationErrorLocalStorageCacheMfaChallengeErrorMfaEnrollmentErrorMfaEnrollmentFactorsErrorMfaErrorMfaListAuthenticatorsErrorMfaRequiredErrorMfaVerifyErrorMissingRefreshTokenErrorMissingScopesErrorMyAccountApiErrorOAuthErrorPasskeyChallengeErrorPasskeyErrorPasskeyGetTokenErrorPasskeyRegisterErrorPopupCancelledErrorPopupOpenErrorPopupTimeoutErrorTimeoutErrorUseDpopNonceErrorUserActClaimAuth0ContextInterfaceAuthenticatorAuthorizationParamsChallengeAuthenticatorParamsChallengeResponseEnrollEmailParamsEnrollmentFactorEnrollOtpParamsEnrollPushParamsEnrollSmsParamsEnrollVoiceParamsFactorGetTokenSilentlyOptionsGetTokenWithPopupOptionsICacheIdTokenIsFederatedDomainOptionsLogoutOptionsLogoutUrlOptionsMfaApiClientMyAccountApiClientPasskeyApiClientPopupConfigOptionsPopupLoginOptionsRedirectConnectAccountOptionsRedirectLoginOptionsRevokeRefreshTokenOptionsUpdateAuthenticationMethodRequestUseEnterpriseConnectVerifyParamsWithAuth0PropsWithAuthenticationRequiredOptionsAppStateAuth0ProviderOptionsAuth0ProviderWithClientOptionsAuth0ProviderWithConfigOptionsAuth0SuspenseContextInterfaceAuthenticationMethodAuthenticationMethodTypeCacheableCacheLocationConnectAccountRedirectResultConnectedAccountCustomTokenExchangeOptionsEnrollmentChallengeOptionsEnrollmentChallengeResponseEnrollmentResponseEnrollmentVerifyOptionsEnrollParamsFetcherConfigInteractiveErrorHandlerMfaFactorTypePasskeyLoginOptionsPasskeySignupOptionsRefreshTokenModeTokenEndpointResponseAuth0ContextRefreshTokenModeAuth0ProvideruseAuth0useAuth0SuspenseuseEnterpriseConnectwithAuth0withAuthenticationRequired
            +
            ResponseTypeAnonymousSessionErrorAuthenticationErrorConnectErrorGenericErrorInMemoryCacheInvalidConfigurationErrorLocalStorageCacheMfaChallengeErrorMfaEnrollmentErrorMfaEnrollmentFactorsErrorMfaErrorMfaListAuthenticatorsErrorMfaRequiredErrorMfaVerifyErrorMissingRefreshTokenErrorMissingScopesErrorMyAccountApiErrorOAuthErrorPasskeyChallengeErrorPasskeyErrorPasskeyGetTokenErrorPasskeyRegisterErrorPopupCancelledErrorPopupOpenErrorPopupTimeoutErrorTimeoutErrorUseDpopNonceErrorUserActClaimAnonymousSessionAnonymousSessionApiClientAnonymousSessionClaimsAuth0ContextInterfaceAuthenticatorAuthorizationParamsChallengeAuthenticatorParamsChallengeResponseCreateAnonymousSessionOptionsEnrollEmailParamsEnrollmentFactorEnrollOtpParamsEnrollPushParamsEnrollSmsParamsEnrollVoiceParamsFactorGetTokenSilentlyOptionsGetTokenWithPopupOptionsICacheIdTokenIsFederatedDomainOptionsLogoutOptionsLogoutUrlOptionsMfaApiClientMyAccountApiClientPasskeyApiClientPopupConfigOptionsPopupLoginOptionsRedirectConnectAccountOptionsRedirectLoginOptionsRevokeRefreshTokenOptionsUpdateAuthenticationMethodRequestUseEnterpriseConnectVerifyParamsWithAuth0PropsWithAuthenticationRequiredOptionsAnonymousGetTokenSilentlyOptionsAnonymousSessionErrorCodeAppStateAuth0ProviderOptionsAuth0ProviderWithClientOptionsAuth0ProviderWithConfigOptionsAuth0SuspenseContextInterfaceAuthenticationMethodAuthenticationMethodTypeCacheableCacheLocationConnectAccountRedirectResultConnectedAccountCustomTokenExchangeOptionsEnrollmentChallengeOptionsEnrollmentChallengeResponseEnrollmentResponseEnrollmentVerifyOptionsEnrollParamsFetcherConfigInteractiveErrorHandlerMfaFactorTypePasskeyLoginOptionsPasskeySignupOptionsRefreshTokenModeTokenEndpointResponseAuth0ContextRefreshTokenModeAuth0ProvideruseAuth0useAuth0SuspenseuseEnterpriseConnectwithAuth0withAuthenticationRequired
            +
          • Defined in src/auth0-provider.tsx:52
            • diff --git a/docs/types/Auth0ProviderOptions.html b/docs/types/Auth0ProviderOptions.html index 754b6739..2db01c9c 100644 --- a/docs/types/Auth0ProviderOptions.html +++ b/docs/types/Auth0ProviderOptions.html @@ -20,7 +20,7 @@

            Type Parameters

            +
          • Defined in src/auth0-provider.tsx:122
            • diff --git a/docs/types/Auth0ProviderWithClientOptions.html b/docs/types/Auth0ProviderWithClientOptions.html index 8ebd2ef3..7e5fc80e 100644 --- a/docs/types/Auth0ProviderWithClientOptions.html +++ b/docs/types/Auth0ProviderWithClientOptions.html @@ -18,7 +18,7 @@

            Type Parameters

            +
          • Defined in src/auth0-provider.tsx:113
            • diff --git a/docs/types/Auth0ProviderWithConfigOptions.html b/docs/types/Auth0ProviderWithConfigOptions.html index 4c5c77a9..8ba4dbe0 100644 --- a/docs/types/Auth0ProviderWithConfigOptions.html +++ b/docs/types/Auth0ProviderWithConfigOptions.html @@ -19,7 +19,7 @@

            Type Parameters

            +
          • Defined in src/auth0-provider.tsx:107
            • diff --git a/docs/types/Auth0SuspenseContextInterface.html b/docs/types/Auth0SuspenseContextInterface.html index 7764b15e..4e5f0fb3 100644 --- a/docs/types/Auth0SuspenseContextInterface.html +++ b/docs/types/Auth0SuspenseContextInterface.html @@ -20,7 +20,7 @@

            Type Parameters

            +
          • Defined in src/use-auth0-suspense.tsx:15
            • diff --git a/docs/types/CacheLocation.html b/docs/types/CacheLocation.html index 2d0ec837..81defb2d 100644 --- a/docs/types/CacheLocation.html +++ b/docs/types/CacheLocation.html @@ -14,7 +14,7 @@

            Type Alias CacheLocation

            The possible locations where tokens can be stored

            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:441
            • diff --git a/docs/types/ConnectAccountRedirectResult.html b/docs/types/ConnectAccountRedirectResult.html index 758dd807..26c2a9a5 100644 --- a/docs/types/ConnectAccountRedirectResult.html +++ b/docs/types/ConnectAccountRedirectResult.html @@ -39,7 +39,7 @@
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:752
            • diff --git a/docs/types/ConnectedAccount.html b/docs/types/ConnectedAccount.html index f56d00a8..cb4db454 100644 --- a/docs/types/ConnectedAccount.html +++ b/docs/types/ConnectedAccount.html @@ -14,7 +14,7 @@

            Type Alias ConnectedAccount

            The account that has been connected during the connect flow.

            +
          • Defined in src/auth0-provider.tsx:45
            • diff --git a/docs/types/TokenEndpointResponse.html b/docs/types/TokenEndpointResponse.html index 2ba803c9..54bdc00e 100644 --- a/docs/types/TokenEndpointResponse.html +++ b/docs/types/TokenEndpointResponse.html @@ -12,7 +12,7 @@

            Type Alias TokenEndpointResponse

            type TokenEndpointResponse = {
                access_token: string;
                expires_in: number;
                id_token: string;
                refresh_token?: string;
                scope?: string;
                token_type: string;
            }
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:788
            • @@ -34,32 +34,32 @@
            access_token: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:791
            • expires_in: number
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:793
            • id_token: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:789
            • refresh_token?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:792
            • scope?: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:794
            • token_type: string
            +
          • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:790
            • diff --git a/docs/variables/Auth0Context.html b/docs/variables/Auth0Context.html index 215c5c10..d3ab20fd 100644 --- a/docs/variables/Auth0Context.html +++ b/docs/variables/Auth0Context.html @@ -14,7 +14,7 @@

            Variable Auth0ContextConst

            The Auth0 Context

            +
          • Defined in src/auth0-context.tsx:558
            • diff --git a/package-lock.json b/package-lock.json index ed68ed84..7f55c35c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/auth0-react", - "version": "2.26.0", + "version": "2.27.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@auth0/auth0-react", - "version": "2.26.0", + "version": "2.27.0", "license": "MIT", "dependencies": { "@auth0/auth0-spa-js": "^2.27.0" diff --git a/package.json b/package.json index 7e9e3b8d..125a49e4 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "author": "Auth0", "name": "@auth0/auth0-react", - "version": "2.26.0", + "version": "2.27.0", "description": "Auth0 SDK for React Single Page Applications (SPA)", "keywords": [ "auth0",