{children}; diff --git a/src/index.tsx b/src/index.tsx index 3b860ff1..94efde79 100644 --- a/src/index.tsx +++ b/src/index.tsx @@ -36,6 +36,8 @@ export { PopupTimeoutError, AuthenticationError, MissingRefreshTokenError, - GenericError + GenericError, + UseDpopNonceError, + type FetcherConfig } from '@auth0/auth0-spa-js'; export { OAuthError } from './errors'; From 443d0fddcf1df03b348c128d67e81d5959d794ae Mon Sep 17 00:00:00 2001 From: Gyanesh Gouraw <160731216+gyaneshgouraw-okta@users.noreply.github.com> Date: Wed, 17 Sep 2025 18:02:38 +0530 Subject: [PATCH 8/8] Release v2.5.0 (#895) **Added** - Add support for DPoP [\#869](https://github.com/auth0/auth0-react/pull/869) ([martinml](https://github.com/martinml)) --- .version | 2 +- CHANGELOG.md | 6 ++ docs/assets/hierarchy.js | 2 +- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/classes/AuthenticationError.html | 2 +- docs/classes/GenericError.html | 2 +- docs/classes/MfaRequiredError.html | 2 +- docs/classes/MissingRefreshTokenError.html | 2 +- docs/classes/OAuthError.html | 4 +- docs/classes/PopupCancelledError.html | 2 +- docs/classes/PopupTimeoutError.html | 2 +- docs/classes/TimeoutError.html | 2 +- docs/classes/UseDpopNonceError.html | 16 +++++ docs/classes/User.html | 4 +- docs/functions/Auth0Provider.html | 2 +- docs/functions/useAuth0.html | 2 +- docs/functions/withAuth0.html | 2 +- .../functions/withAuthenticationRequired.html | 2 +- docs/hierarchy.html | 2 +- docs/interfaces/Auth0ContextInterface.html | 65 ++++++++++++++++--- docs/interfaces/Auth0ProviderOptions.html | 53 ++++++++------- docs/interfaces/AuthorizationParams.html | 30 ++++----- docs/interfaces/GetTokenSilentlyOptions.html | 10 +-- docs/interfaces/GetTokenWithPopupOptions.html | 6 +- docs/interfaces/ICache.html | 4 +- docs/interfaces/IdToken.html | 4 +- docs/interfaces/LogoutOptions.html | 8 +-- docs/interfaces/LogoutUrlOptions.html | 6 +- docs/interfaces/PopupConfigOptions.html | 6 +- docs/interfaces/PopupLoginOptions.html | 4 +- docs/interfaces/RedirectLoginOptions.html | 10 +-- docs/interfaces/WithAuth0Props.html | 4 +- .../WithAuthenticationRequiredOptions.html | 12 ++-- docs/modules.html | 2 +- docs/types/AppState.html | 4 +- docs/types/CacheLocation.html | 2 +- docs/types/Cacheable.html | 2 +- docs/types/FetcherConfig.html | 5 ++ docs/variables/Auth0Context.html | 2 +- package-lock.json | 4 +- package.json | 2 +- 42 files changed, 193 insertions(+), 114 deletions(-) create mode 100644 docs/classes/UseDpopNonceError.html create mode 100644 docs/types/FetcherConfig.html diff --git a/.version b/.version index fa49670c..d80b4a81 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.4.0 \ No newline at end of file +v2.5.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 90c5bd11..ed7ba15f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.5.0](https://github.com/auth0/auth0-react/tree/v2.5.0) (2025-09-17) +[Full Changelog](https://github.com/auth0/auth0-react/compare/v2.4.0...v2.5.0) + +**Added** +- Add support for DPoP [\#869](https://github.com/auth0/auth0-react/pull/869) ([martinml](https://github.com/martinml)) + ## [v2.4.0](https://github.com/auth0/auth0-react/tree/v2.4.0) (2025-07-22) [Full Changelog](https://github.com/auth0/auth0-react/compare/v2.3.0...v2.4.0) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index 2bfc7f55..5a7312df 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJyVlF1rgzAUhv/LuU5XjekavRtljEHHRlfYRelFiMcaapMuiVfF/z60bNivmV4J+hyf9+QcPYA1xjvIVoxTQnlCYp6uCVgsKpReGe0gO0DM0/aixQ4hgw+zr/dzs1H6fX9ECGyVziGjk0cCta0gA6U92kJIdOML/qH0uwoIyEo4Bxl4l4/aF4z+itqHpapyixqyVZyydUMgTlkvxQv6pdmi/lK+7AxhYW6VBWRqCFCe9CK8zoQscUB4hO5tOYlo23IS0Z5vbqSoPr2xYoOn6pjyX3VnQDe+gG9GON5obTTq2ZZqh6b2z9Ya+5+ozw04TltMedci60/1rRAL/K6VxXxQfM4GNDil53s8E1piVQXoruABxpSfG0PP9QIetjHaP8un2peovZKi3fBB3xU8wDg5mZ5yTunNAguLruy+s+Ep3qgJcHN68j/QaJUc9PW5u9aVRiRhjCRTShhlhE3YummaH8/hv8o=" \ No newline at end of file +window.hierarchyData = "eJyVlMtOwzAQRf9l1oYmsR252SFACImXCogFYmG508YitYPtrKr+O0oqkPvCYRUpOZMz1zPJGpy1wUP1znNBaD4lRcE/CDhcNKiCtsZDtYai4P3FyBVCBU+27do7u9Tmsd0iBD61mUNV8JJA5xqoQJuAbiEV+skBf16HVQMEVCO9hwqCn5/1Lzj7Leof1rqZOzRQvRc0+9gQKGgWdXGD4cV+onnToR4M45o5VTaipw0Bmk+jFm4vpaoxIdxC/41MqegjUyoi351VsnkO1skl7qrzQvyoBwP6yQF8soXtjd7Gy8j2oldou3DtnHV/iWIu4diJyCgbIop4qvcLOcOvTjucJ8X7bDogy8T+Hl9Ko7BpRuiO4COMlO0bx57rATzCVsZnedGFGk3QSvYbnvQdwUcYpzvT095rs5zhwqGvh+8sPcUTNWk3z8XO/8Cg0yrpi7n/rCvlJaEiIywThJUZYdOMcDasMGfxkF89XrW2fbBGYbKbAzgVe7P5Bo2A5S4=" \ No newline at end of file diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index c8a14767..f25d8eec 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJylll1v0zAUhv+Lr7uxdWxA71CFUKVOq9pNXCAuTHLSWHPtYJ+MFcR/R06W5sMfidzL5rx+Hje2j/P9L0F4RbIgn0vMQSBLKDIpviglFZmRgmJOFiThVGvQ7xyhyxwPnMzIMxMpWVzPP87qNFkQ1OkF0xfwiqAE5eTf7GT7CgIUSzyabjWOvxL3cJDquKRJDragV44zrGVC+Q6lonvwWKxInOk+o1v4VTIFqed9DRORHqY1E/stZAp0/iifwbcNfMk474PZVR5TW7PYHcJGFmWxpCIBzr0vyRGKm28FemQHkCWGXN1InCksOZ//pMHBNU/jeGaxrpZSmJ8rgaAymnTOBWse1Y3ESval89u7IXqj5AtLQT0Upv1oP3kQHANLxf5UHW1DFT34uYOchZ3Y+rA6MTvGQSA/hv6MJ3ue+BvDvNqgU8zDcJx6NeiQHdHK0RknY9Nqjm5uXYsDr+Velhh6P71EaH/VwSfFx2ltKG7WdYeTImP7kMyOnaFbyz0To7ZuKk62hZQpSHDU5wqG1sds8KZnFG5kPzIF1n4jNfdyaMqjo4L9qyh2SLFzuPBYmH719nww9urTh+vbeWd8dfzoT24BTgUnYdKiVQjzFWT+hZPfFOMd3ZukVbxQxczc+zdN33Iz990vLScrRVItQf9e6YPu3ndApYYq6mI0tcDw381ec40/FScA7M0UItppS/HjP4K3Nns=" \ No newline at end of file +window.navigationData = "eJylll1v0zAUhv+LrzvYChvQO1Q+VKljVbuJC8SFcU4Sa64d7JOxgvjvKAlpk/gjkXvZntfP4zj2cb79IQjPSBbkfYk5SOSMIlfyo9ZKkxkpKOZkQZigxoB56Qi9yHEvyIw8cpmQxdX87axJkwVBk1xwcwHPCFpSQf7OjrbPIEFz5tF0q3H8lbyFvdKHJWU52IJeOc6wVoyKHSpNM/BYrEic6TalW/hZcg2JZ72GiUgPN4bLbAupBpPfq0fwbQNfMs57V+0qj+lUs9gdwkYVZbGkkoEQ3kVyhOLmW4Pu+R5UiSFXNxJnCkvO5z8Y+FCo4ouSDDwSKxJtcsMjedW2uFwqWf1cSQSdUtY5gbz9q2lZVrIvnV/fDNEbrZ54AvquqBqd8ZMHwTGw0vx33Ts3VNO9nzvIWdiJTRbrs7njAiSKQ+hhPNnzxF855vVRmGIehuPUq0Ev7ohWjh48GZvUc3Rzm1oceK0yVWJofXqJ0P5qgg9ajNNOobhZN71UyZRnIZkdO0O3VhmXo7ZuKk62hYRrYDjqcwVD76fa4G3PKNzIfmQK7PQ11n4BhKY8OirYv4pihxQ7hwsPRdWv/v8/GHv57s3V9bwzvj5+9IewAMeCkzDppdWI6nuregonvy3GOz4Bshx0s5+Hjl4x3tG9rU6KJ6p5tT7926xveTX33WEnTlpKVr/m/t3VB9287oBKA3XUxWhrgeG/2v3sGn8sTgDYGzZEtNOW4vs/Ayx8aw==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 58631ebd..a27fcf73 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "eJy1mU1v2zgQhv8Lc1VTz9Dft7bYQ4ECLbbF7sEIClViYiKKpJXktEWQ/76gZElDceRQsXszLM7Ll+QzQ0p8EkX2sxTb3ZO412kstoDrQKThgxJb8fndodr/VRRZIQJxKBKxFVESlqUq3/aPrvfVQyKC9onYCvEctGoLwE4tytKyKg5R9bLcld2WSAciDwuVVra7vkOY4bzrUflYv2pbndXL91iVUaHzSmepX4+DiAm942LZdW6ezz5kaaV+VR/TShW3YaQ6A7r9p3zLNjy5diem0kuXmdiqjN/o8o1O96rQlYrpUPmRjNi5U9W7KFJl+S27V+lXnai0Sn5P9HenqrAWqYxI2Yvwa3GGwX91tf+S5Yf8LIc/dbXPjyqXsfgxru19SEL9UE73puPaV9SGX8DUPkzjRP2tYl2oqPoQJsmPMLqfaK0RKY4iUS9yAYO6NM1VWukobAie4kyX4SD6DySHLj9lYazTu8nmki7uD9hKsjv96kyogy+cAJ2hFrfXeir6+MvYyg6v8NIEXcDAoVRTS/0x5DLUOPvblyJ71LEqPteb5XihGrTz392ivU7iQqWTlK9I1IlZH5ofs9DMx0QHXdD5BrLUu+qyXrJ0WsH1tFXe6/w8Y0bhUtYomp/qlDvBpNXgJIxUth3sJ1NdTqhz7bw7MVWvHWrOytst/FPJ7G8zT8GrtjG/FgOTp0dy3FO1wfi/gy5UfGLuXgyaUDrG89avlxeT+OURntrfzp6FZpvLOpkLm8zS9+o2K5QdfIbdLP1RC4ZDwYsbbzNw5KTl7bewdC5ss1DVoUi/ZWc4bCSq7CLmcLZZwaL/KvAuz79WYdW/s1a/c1POj3/7J6IzUEbo5aF0dvpeJLJv210/j2Ghwx/J4IB00vhyzh9wOs3bQxrVM2fva76ih7LOpxmj1z7ylfrZFmFGq3s2VcwF5YS625jr7iYQOo3VL7F9Eo+qKE3ObwVey+uNCMStVklsPnM1TgIRZQ8PZsUDEWfRof55c2z2jzKfnUzjpvXbmQh2s0Di9WINNzfBrg2uH9R/tBr9P3UgiGAHXCA4gWAFogh2GODqer6SViA6gWgFShHsJNejdAKlFTgXwW7OBc6dwLkVuBizunACF1bgUgS7Bdfj0glcWoErEeyWXODKCVxZgWsR7FZc4NoJXFuBGxHs1lzgxgnc2AAYHjYsAS47MICnpoflDhh+bIDAYAE8ey5DYEMEBg1ANtjlCGyQwOABLIPgsgQ2TGAQAZZDcHkCGygwmACLFLhMgQ0VGFSAxQpcrsAGCwwusOKyAFy2wIYLDDLA4gUuX2ADhoYZYAlDlzC0CUPDDLKEoUsYDkpUXaNYwpCpUjZhaJhBljB0CUObMDTMIEsYuoShTRjW9YolDF3C0CYMl6PrjC5haBOGhhlk8USXMLQJQ8MMsniiSxjahKFhBtnKhy5haBMmDTO45sYsXcKkTZisCWPxlC5h0iZM4njPLmFysBHWOyHLtmT2QpswaZiRLNvSJUzahEnDjGTZli5h0iZMGmYkv4O7hEmbMGmYkSzb0iXs+Fd9bnpURaXij835abcTYZ6XzaH8SXw/Hqtw0x7jnoQEsX16fu6PUdunZ3KSMs9MX8fXe6Ihew2c+2t0r8i9lJwRO3KyVPcWRDXnveQEc3l3eCfugLh7hVb3ut1LwqKXhKWXZP+BksgsiczKT4ZexhIlIuSrM1xFWBGRdROHfoM73i4SuAhbTczCX8i+jSULSdbRS23sUrGXJOvoN9LRW8Bekyyq35q6t3e9GFmTtZfY2H1bL7nuJTdeks5FWa9F6hDMPMW6iy2CHikg4Aew/SWMkEeWFP3mf3ifRXzRvMJpYv1FFNEjeQF+DLeXSUSE5AH41bNGhJstMvHoN/FZDcMw4YmOHwdjnwaJN5JI6Ac/d+9BJo6QD37oDz4IEnMkMdFPq1UaJZfAhn6w9Z/QiAwZpZw1gdJPjr+dIRNI0h39lvlQKufkIUkWSL99obnTJE7I8QD8JExOulbonuK3A3Q6eXNdQ2ae7np+2d2K9RlQdB/hiEsyWulX08aFOfKIPnrM5k0gcp2rRKdKbHc3z8//Ay+N4VU="; \ No newline at end of file +window.searchData = "eJy1ml1vnDgUhv+Lc0vT8THzedfN7kqVqm21rXYvRlFFwclYIcAaJm01yn9fGQY4xmcmJkPvIvB5/do859hj58B0/r1km+2BPagsYRsOq4Bl0aNkG/bx3b7a/aF1rlnA9jplGxanUVnK8m3/6npXPaYsaN+wDWPPQas259CpxXlWVnofVy/LXdltkXTAikjLrLLd9R3yGYRdj9LH+lXb6qJeviayjLUqKpVnfj0OIkb0DvNF17l5P7vJs0r+qN5nldR3USw7A6p9Ur4lG579dtYgYy2jSv4pq3gn9Tj9qyb2roulh0qPxOvL+tlwv3NVJm9U+UZlO6lVJZNX27mXmdRRJX8v8uKTzvO7kdba+KTIi+IYP8Es3cvqXRzLsvySP8jss0plVqU/R3urolqkMiJlLzK5wX9VtfuUF/viIoffVbUrjirTWDRf9a88G5tXxpf5oNkxdBoz75N6rm7SSD2W4w2ppJ6kuA2fwNQuypJU/i0TpWVc3URp+i2KH0Zaa0T0USTuRSYwqErTXGaViqMmy8c4U2U0iP4FBUSVH/IoUdn9aHNpF/cLbKX5vXp1WtbBE2djZ6jF7bWedB8/ja18/wovTdAEBsrXV6ly8iq1L0dvEY4h0yDs7I8+6fxJJVJ/rDdbp6vmoN2I3dFOpYmW2SjlKxR1ZtaH5k9ZaOZjpIMu6HIDeea9BJBe8mxc9fe0VT6o4jJjRmEqaxjND3X+n2HSanAWRizbDvaDKXVn1Kl23p2YEtwOtSDl7Rb+qWQW25mn4FXbmP4WA5PnR3Jc4JXB+L+90jI5M3cvBo0oHafz1q+XF5P45RGeW2wvnoVmzc07mYlN5tlv8i7X0g6+wG6efasFo6Hg5MbbDDyx7fP2qy2diW1qWe119iW/wGEjUeWTmIPZesnn/anSu6L4XEVVv+upfhamnB8f+yeiM1BC6OWhdHb6XgTYu5GbQcY/RVpF39LBBums8UVIb3A6zbt9FtczZ69rvqL7ss6nGaHXvvKV+t4WYUKrezdWzAXljLrbmOruNmAqS+QPtjmwJ6lLk/MbBtfies0Cdqdkmphj0sZJwOL88dF88YAlebyv/7w9NvtHmmNL07hp/XbGgu0sEOJ6Pl/e3gbbNrh+UT9oNfondSBnwZZTgdwJ5FYgsGALAayuw3BtBYITCFagYMFWUD0KJ1BYgSELtiEVGDqBoRU4Z8F2TgXOncC5Fbg4NcaFE7iwApcs2C6oHpdO4NIKXLFgu6QCV07gygpcs2C7ogLXTuDaBsDwsCYJcNnhA3hqekjuOMGPDRA3WHCaPZchbkPEDRocyGCXI26DxA0enGSQuyxxGyZuEOEkh9zlidtAcYMJJ1nkLlPchoobVDiJFXe54jZY3ODCSbS4yxa34eIGGU7ixV2+uA0YGGY4SRi4hIFNGBhmgCQMXMJgUKLqGsXJIkVUKZswMMwASRi4hIFNGBhmgCQMXMLAJgwMM0ASBi5hYBMGdc0iCQOXMLAJA8MMkISBSxjYhIFhBkjCwCUMbMLAMAMkYeASBjZhYnbyOwuXMGETJmrCSDyFS5iwCROGGUHiKVzCxGAhrFdCsgAKYi20CROGGUEuTsIlTNiECcOMoBdhlzBhEyYWp3t2CRM2YcIwI0i2hUuYsAkThhlBsi1cwoRNmDDMCJJt4RImbMJCw4wg2Q5dwkKbsNAwI0i2Q5ew46N6r/gkdSWT982ecbtlUVGUzQ+RA/t63EoK0W5dD0zM2ebw/NxvHTeHZ7R7NO9MX8cjjV4Dlr0GrPw1umMBZCdEdpajpbpfflgTSYb+ikX3gwW5myN3IwbaanVHDL0kX6O5m3lJ9oey6BPMkAz3k8H/wIAM9ULeOsOvCEgEoIkTnoOzb+J7TTT1fpgeL9ORK2SqiVn4C9n/C4GQQER4qREX6b3aolfzg//U1XcviXLTj9iTd9W95qrXXPtqohucXgjBz/34cC+IEbooCbgfvKcudZEoTgjwEnXuY5EagpD7AYMuUJEO4o77VTX7kBOlBfoIwm/WhvemyBcqttwvT4kLT6SH0p77pWt7aYlEUFpxv7xqRKjZQgMEvwHmNQ3DaoRY9SP/1KkvqkVIU/ihSl1pocHikulH6+CsF5lDeST8tFqlk+QiOMAPjv50FDlDoxThcbXykytP1DWOqi73K7v0HR4aLMp48Mv4fSmdvZpAuSD8indz840Gh8o/95Mw6e1aQZMU+uVAp1M0l3poetC4wC/HW7E+mXR3VItcotGGfuXxtDAFMdIHj9m8DVihCpmqTLLN9vb5+X+5lFjk"; \ No newline at end of file diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index 5aa0e4ad..564dcefb 100644 --- a/docs/classes/AuthenticationError.html +++ b/docs/classes/AuthenticationError.html @@ -1,6 +1,6 @@ AuthenticationError | @auth0/auth0-react

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
- AuthenticationError

Type Parameters

P extends object

Parameters

Component: ComponentType<P>
options: WithAuthenticationRequiredOptions = {}

Returns FC<P>

diff --git a/docs/hierarchy.html b/docs/hierarchy.html index f1d10527..b622c523 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -@auth0/auth0-react

@auth0/auth0-react

Hierarchy Summary

GenericError

ICache
- LocalStorageCache

PopupLoginOptions
- GetTokenWithPopupOptions

+@auth0/auth0-react

@auth0/auth0-react

Hierarchy Summary

GenericError

ICache
- LocalStorageCache

PopupLoginOptions
- GetTokenWithPopupOptions

diff --git a/docs/interfaces/Auth0ContextInterface.html b/docs/interfaces/Auth0ContextInterface.html index 8e81cbba..a9547c79 100644 --- a/docs/interfaces/Auth0ContextInterface.html +++ b/docs/interfaces/Auth0ContextInterface.html @@ -1,7 +1,10 @@ Auth0ContextInterface | @auth0/auth0-react

Interface Auth0ContextInterface<TUser>

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

interface Auth0ContextInterface<TUser extends User = User> {
    error: undefined | Error;
    getAccessTokenSilently: {
        (
            options: GetTokenSilentlyOptions & { detailedResponse: true },
        ): Promise<GetTokenSilentlyVerboseResponse>;
        (options?: GetTokenSilentlyOptions): Promise<string>;
        (
            options: GetTokenSilentlyOptions,
        ): Promise<string | GetTokenSilentlyVerboseResponse>;
    };
    getAccessTokenWithPopup: (
        options?: GetTokenWithPopupOptions,
        config?: PopupConfigOptions,
    ) => Promise<undefined | string>;
    getIdTokenClaims: () => Promise<undefined | IdToken>;
    handleRedirectCallback: (url?: string) => Promise<RedirectLoginResult<any>>;
    isAuthenticated: boolean;
    isLoading: boolean;
    loginWithPopup: (
        options?: PopupLoginOptions,
        config?: PopupConfigOptions,
    ) => Promise<void>;
    loginWithRedirect: (
        options?: RedirectLoginOptions<AppState>,
    ) => Promise<void>;
    logout: (options?: LogoutOptions) => Promise<void>;
    user: undefined | TUser;
}

Type Parameters

TUser extends User = User

Hierarchy

AuthState<TUser>
- Auth0ContextInterface

Index

Properties

error +

interface Auth0ContextInterface<TUser extends User = User> {
    createFetcher: <TOutput extends CustomFetchMinimalOutput = Response>(
        config?: FetcherConfig<TOutput>,
    ) => Fetcher<TOutput>;
    error: undefined | Error;
    generateDpopProof: (
        params: {
            accessToken: string;
            method: string;
            nonce?: string;
            url: string;
        },
    ) => Promise<string>;
    getAccessTokenSilently: {
        (
            options: GetTokenSilentlyOptions & { detailedResponse: true },
        ): Promise<GetTokenSilentlyVerboseResponse>;
        (options?: GetTokenSilentlyOptions): Promise<string>;
        (
            options: GetTokenSilentlyOptions,
        ): Promise<string | GetTokenSilentlyVerboseResponse>;
    };
    getAccessTokenWithPopup: (
        options?: GetTokenWithPopupOptions,
        config?: PopupConfigOptions,
    ) => Promise<undefined | string>;
    getDpopNonce: (id?: string) => Promise<undefined | string>;
    getIdTokenClaims: () => Promise<undefined | IdToken>;
    handleRedirectCallback: (url?: string) => Promise<RedirectLoginResult<any>>;
    isAuthenticated: boolean;
    isLoading: boolean;
    loginWithPopup: (
        options?: PopupLoginOptions,
        config?: PopupConfigOptions,
    ) => Promise<void>;
    loginWithRedirect: (
        options?: RedirectLoginOptions<AppState>,
    ) => Promise<void>;
    logout: (options?: LogoutOptions) => Promise<void>;
    setDpopNonce: (nonce: string, id?: string) => Promise<void>;
    user: undefined | TUser;
}

Type Parameters

TUser extends User = User

Hierarchy

AuthState<TUser>
- Auth0ContextInterface

Index

Properties

createFetcher +error +generateDpopProof getAccessTokenSilently getAccessTokenWithPopup +getDpopNonce getIdTokenClaims handleRedirectCallback isAuthenticated @@ -9,8 +12,25 @@ loginWithPopup loginWithRedirect logout +setDpopNonce user -

Properties

error

error: undefined | Error

getAccessTokenSilently

getAccessTokenSilently: {
    (
        options: GetTokenSilentlyOptions & { detailedResponse: true },
    ): Promise<GetTokenSilentlyVerboseResponse>;
    (options?: GetTokenSilentlyOptions): Promise<string>;
    (
        options: GetTokenSilentlyOptions,
    ): Promise<string | GetTokenSilentlyVerboseResponse>;
}

const token = await getAccessTokenSilently(options);
+

`Properties`

`createFetcher`

createFetcher: <TOutput extends CustomFetchMinimalOutput = Response>(
    config?: FetcherConfig<TOutput>,
) => Fetcher<TOutput>

Returns a new Fetcher class that will contain a fetchWithAuth() method. +This is a drop-in replacement for the Fetch API's fetch() method, but will +handle certain authentication logic for you, like building the proper auth +headers or managing DPoP nonces and retries automatically.


+Check the EXAMPLES.md file for a deeper look into this method.
+

`Type declaration`

- <TOutput extends CustomFetchMinimalOutput = Response>( config?: FetcherConfig<TOutput>, ): Fetcher<TOutput>
- Returns a new Fetcher class that will contain a fetchWithAuth() method. +This is a drop-in replacement for the Fetch API's fetch() method, but will +handle certain authentication logic for you, like building the proper auth +headers or managing DPoP nonces and retries automatically.
  +Check the EXAMPLES.md file for a deeper look into this method. +
  Type Parameters
  - TOutput extends CustomFetchMinimalOutput = Response
  Parameters
  - Optionalconfig: FetcherConfig<TOutput>
  Returns Fetcher<TOutput>

`error`

error: undefined | Error

`generateDpopProof`

generateDpopProof: (
    params: {
        accessToken: string;
        method: string;
        nonce?: string;
        url: string;
    },
) => Promise<string>

Returns a string to be used to demonstrate possession of the private +key used to cryptographically bind access tokens with DPoP.


+It requires enabling the Auth0ClientOptions.useDpop option.
+

`Type declaration`

- ( params: { accessToken: string; method: string; nonce?: string; url: string; }, ): Promise<string>
- Returns a string to be used to demonstrate possession of the private +key used to cryptographically bind access tokens with DPoP.
  +It requires enabling the Auth0ClientOptions.useDpop option. +
  Parameters
  - params: { accessToken: string; method: string; nonce?: string; url: string }
  Returns Promise<string>

`getAccessTokenSilently`

getAccessTokenSilently: {
    (
        options: GetTokenSilentlyOptions & { detailedResponse: true },
    ): Promise<GetTokenSilentlyVerboseResponse>;
    (options?: GetTokenSilentlyOptions): Promise<string>;
    (
        options: GetTokenSilentlyOptions,
    ): Promise<string | GetTokenSilentlyVerboseResponse>;
}

const token = await getAccessTokenSilently(options);


 
 If there's a valid token stored, return it. Otherwise, opens an
@@ -29,7 +49,7 @@
 back to using an iframe to make the token exchange.
 Note that in all cases, falling back to an iframe requires access to
 the auth0 cookie.
-

`getAccessTokenWithPopup`

getAccessTokenWithPopup: (
    options?: GetTokenWithPopupOptions,
    config?: PopupConfigOptions,
) => Promise<undefined | string>

const token = await getTokenWithPopup(options, config);
+

`getAccessTokenWithPopup`

getAccessTokenWithPopup: (
    options?: GetTokenWithPopupOptions,
    config?: PopupConfigOptions,
) => Promise<undefined | string>

const token = await getTokenWithPopup(options, config);


 
 Get an access token interactively.
@@ -37,16 +57,31 @@
 provided as arguments. Random and secure state and nonce
 parameters will be auto-generated. If the response is successful,
 results will be valid according to their expiration times.
-

`getIdTokenClaims`

getIdTokenClaims: () => Promise<undefined | IdToken>

const claims = await getIdTokenClaims();
+

`getDpopNonce`

getDpopNonce: (id?: string) => Promise<undefined | string>

Returns the current DPoP nonce used for making requests to Auth0.


+It can return undefined because when starting fresh it will not
+be populated until after the first response from the server.
+It requires enabling the Auth0ClientOptions.useDpop option.
+

`Type declaration`

- (id?: string): Promise<undefined | string>
- Returns the current DPoP nonce used for making requests to Auth0.
  +It can return undefined because when starting fresh it will not +be populated until after the first response from the server. +It requires enabling the Auth0ClientOptions.useDpop option. +
  Parameters
  - Optionalid: stringThe identifier of a nonce: if absent, it will get the nonce +used for requests to Auth0. Otherwise, it will be used to +select a specific non-Auth0 nonce. +
  Returns Promise<undefined | string>

`Param: nonce`

The nonce value.

`Param: id`

The identifier of a nonce: if absent, it will get the nonce +used for requests to Auth0. Otherwise, it will be used to +select a specific non-Auth0 nonce.

`getIdTokenClaims`

getIdTokenClaims: () => Promise<undefined | IdToken>

const claims = await getIdTokenClaims();


 
 Returns all claims from the id_token if available.
-

`handleRedirectCallback`

handleRedirectCallback: (url?: string) => Promise<RedirectLoginResult<any>>

After the browser redirects back to the callback page, +

`handleRedirectCallback`

handleRedirectCallback: (url?: string) => Promise<RedirectLoginResult<any>>

After the browser redirects back to the callback page, call handleRedirectCallback to handle success and error responses from Auth0. If the response is successful, results will be valid according to their expiration times.

`Type declaration`

- (url?: string): Promise<RedirectLoginResult<any>>
- Parameters
  - Optionalurl: stringThe URL to that should be used to retrieve the state and code values. Defaults to window.location.href if not given. -
  Returns Promise<RedirectLoginResult<any>>

`isAuthenticated`

isAuthenticated: boolean

`isLoading`

isLoading: boolean

`loginWithPopup`

loginWithPopup: (
    options?: PopupLoginOptions,
    config?: PopupConfigOptions,
) => Promise<void>

await loginWithPopup(options, config);
+

`Returns Promise<RedirectLoginResult<any>>`

`isAuthenticated`

isAuthenticated: boolean

`isLoading`

isLoading: boolean

`loginWithPopup`

loginWithPopup: (
    options?: PopupLoginOptions,
    config?: PopupConfigOptions,
) => Promise<void>

await loginWithPopup(options, config);


 
 Opens a popup with the /authorize URL using the parameters
@@ -56,17 +91,29 @@
 
IMPORTANT: This method has to be called from an event handler
 that was started by the user like a button click, for example,
 otherwise the popup will be blocked in most browsers.
-

`loginWithRedirect`

loginWithRedirect: (options?: RedirectLoginOptions<AppState>) => Promise<void>

await loginWithRedirect(options);
+

`loginWithRedirect`

loginWithRedirect: (options?: RedirectLoginOptions<AppState>) => Promise<void>

await loginWithRedirect(options);


 
 Performs a redirect to /authorize using the parameters
 provided as arguments. Random and secure state and nonce
 parameters will be auto-generated.
-

`logout`

logout: (options?: LogoutOptions) => Promise<void>

auth0.logout({ logoutParams: { returnTo: window.location.origin } });
+

`logout`

logout: (options?: LogoutOptions) => Promise<void>

auth0.logout({ logoutParams: { returnTo: window.location.origin } });


 
 Clears the application session and performs a redirect to /v2/logout, using
 the parameters provided as arguments, to clear the Auth0 session.
 If the logoutParams.federated option is specified, it also clears the Identity Provider session.
 Read more about how Logout works at Auth0.
-

`user`

user: undefined | TUser


+
Defined in src/auth0-context.tsx:133
setDpopNonce
setDpopNonce: (nonce: string, id?: string) => Promise<void>
Sets the current DPoP nonce used for making requests to Auth0.
+It requires enabling the Auth0ClientOptions.useDpop option.
+
Type declaration
(nonce: string, id?: string): Promise<void>
Sets the current DPoP nonce used for making requests to Auth0.
+It requires enabling the Auth0ClientOptions.useDpop option.
+
Parameters
nonce: stringThe nonce value.
+
Optionalid: stringThe identifier of a nonce: if absent, it will set the nonce
+used for requests to Auth0. Otherwise, it will be used to
+select a specific non-Auth0 nonce.
+
Returns Promise<void>
Param: nonce
The nonce value.
+
Param: id
The identifier of a nonce: if absent, it will set the nonce
+used for requests to Auth0. Otherwise, it will be used to
+select a specific non-Auth0 nonce.
+
Defined in src/auth0-context.tsx:170
user
user: undefined | TUser
Inherited from AuthState.user
Defined in src/auth-state.tsx:10
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
createFetchererrorgenerateDpopProofgetAccessTokenSilentlygetAccessTokenWithPopupgetDpopNoncegetIdTokenClaimshandleRedirectCallbackisAuthenticatedisLoadingloginWithPopuploginWithRedirectlogoutsetDpopNonceuser
@auth0/auth0-reactLoading...

diff --git a/docs/interfaces/Auth0ProviderOptions.html b/docs/interfaces/Auth0ProviderOptions.html
index b20023ce..50a221a2 100644
--- a/docs/interfaces/Auth0ProviderOptions.html
+++ b/docs/interfaces/Auth0ProviderOptions.html
@@ -1,5 +1,5 @@
 Auth0ProviderOptions | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
Auth0ProviderOptions
Interface Auth0ProviderOptions<TUser>
The main configuration to instantiate the Auth0Provider.
-
interface Auth0ProviderOptions<TUser extends User = User> {
    auth0Client?: {
        env?: { [key: string]: string };
        name: string;
        version: string;
    };
    authorizationParams?: AuthorizationParams;
    authorizeTimeoutInSeconds?: number;
    cache?: ICache;
    cacheLocation?: CacheLocation;
    children?: ReactNode;
    clientId: string;
    context?: Context<Auth0ContextInterface<TUser>>;
    cookieDomain?: string;
    domain: string;
    httpTimeoutInSeconds?: number;
    issuer?: string;
    leeway?: number;
    legacySameSiteCookie?: boolean;
    nowProvider?: () => number | Promise<number>;
    onRedirectCallback?: (appState?: AppState, user?: TUser) => void;
    sessionCheckExpiryDays?: number;
    skipRedirectCallback?: boolean;
    useCookiesForTransactions?: boolean;
    useFormData?: boolean;
    useRefreshTokens?: boolean;
    useRefreshTokensFallback?: boolean;
    workerUrl?: string;
}
Type Parameters
TUser extends User = User
Hierarchy
Auth0ClientOptionsAuth0ProviderOptions
Defined in src/auth0-provider.tsx:44
Index
Properties
auth0Client?
+
interface Auth0ProviderOptions<TUser extends User = User> {
    auth0Client?: {
        env?: { [key: string]: string };
        name: string;
        version: string;
    };
    authorizationParams?: AuthorizationParams;
    authorizeTimeoutInSeconds?: number;
    cache?: ICache;
    cacheLocation?: CacheLocation;
    children?: ReactNode;
    clientId: string;
    context?: Context<Auth0ContextInterface<TUser>>;
    cookieDomain?: string;
    domain: string;
    httpTimeoutInSeconds?: number;
    issuer?: string;
    leeway?: number;
    legacySameSiteCookie?: boolean;
    nowProvider?: () => number | Promise<number>;
    onRedirectCallback?: (appState?: AppState, user?: TUser) => void;
    sessionCheckExpiryDays?: number;
    skipRedirectCallback?: boolean;
    useCookiesForTransactions?: boolean;
    useDpop?: boolean;
    useFormData?: boolean;
    useRefreshTokens?: boolean;
    useRefreshTokensFallback?: boolean;
    workerUrl?: string;
}
Type Parameters
TUser extends User = User
Hierarchy
Auth0ClientOptionsAuth0ProviderOptions
Defined in src/auth0-provider.tsx:44
Index
Properties
auth0Client?
 authorizationParams?
 authorizeTimeoutInSeconds?
 cache?
@@ -18,22 +18,23 @@
 sessionCheckExpiryDays?
 skipRedirectCallback?
 useCookiesForTransactions?
+useDpop?
 useFormData?
 useRefreshTokens?
 useRefreshTokensFallback?
 workerUrl?
 
Properties
Optional Internalauth0Client
auth0Client?: { env?: { [key: string]: string }; name: string; version: string }
Internal property to send information about the client to the authorization server.
-
Inherited from Auth0ClientOptions.auth0Client
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:178
OptionalauthorizationParams
authorizationParams?: AuthorizationParams
URL parameters that will be sent back to the Authorization Server. This can be known parameters
+
Inherited from Auth0ClientOptions.auth0Client
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:179
OptionalauthorizationParams
authorizationParams?: AuthorizationParams
URL parameters that will be sent back to the Authorization Server. This can be known parameters
 defined by Auth0 or custom parameters that you define.
-
Inherited from Auth0ClientOptions.authorizationParams
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:103
OptionalauthorizeTimeoutInSeconds
authorizeTimeoutInSeconds?: number
A maximum number of seconds to wait before declaring background calls to /authorize as failed for timeout
+
Inherited from Auth0ClientOptions.authorizationParams
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:104
OptionalauthorizeTimeoutInSeconds
authorizeTimeoutInSeconds?: number
A maximum number of seconds to wait before declaring background calls to /authorize as failed for timeout
 Defaults to 60s.
-
Inherited from Auth0ClientOptions.authorizeTimeoutInSeconds
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:169
Optionalcache
cache?: ICache
Specify a custom cache implementation to use for token storage and retrieval. This setting takes precedence over cacheLocation if they are both specified.
-
Inherited from Auth0ClientOptions.cache
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:136
OptionalcacheLocation
cacheLocation?: CacheLocation
The location to use when storing cache data. Valid values are memory or localstorage.
+
Inherited from Auth0ClientOptions.authorizeTimeoutInSeconds
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:170
Optionalcache
cache?: ICache
Specify a custom cache implementation to use for token storage and retrieval. This setting takes precedence over cacheLocation if they are both specified.
+
Inherited from Auth0ClientOptions.cache
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:137
OptionalcacheLocation
cacheLocation?: CacheLocation
The location to use when storing cache data. Valid values are memory or localstorage.
 The default setting is memory.
 Read more about changing storage options in the Auth0 docs
-
Inherited from Auth0ClientOptions.cacheLocation
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:132
Optionalchildren
children?: ReactNode
The child nodes your Provider has wrapped
-
Defined in src/auth0-provider.tsx:48
clientId
clientId: string
The Client ID found on your Application settings page
-
Inherited from Auth0ClientOptions.clientId
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:119
Optionalcontext
context?: Context<Auth0ContextInterface<TUser>>
Context to be used when creating the Auth0Provider, defaults to the internally created context.
+
Inherited from Auth0ClientOptions.cacheLocation
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:133
Optionalchildren
children?: ReactNode
The child nodes your Provider has wrapped
+
Defined in src/auth0-provider.tsx:48
clientId
clientId: string
The Client ID found on your Application settings page
+
Inherited from Auth0ClientOptions.clientId
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:120
Optionalcontext
context?: Context<Auth0ContextInterface<TUser>>
Context to be used when creating the Auth0Provider, defaults to the internally created context.
 This allows multiple Auth0Providers to be nested within the same application, the context value can then be
 passed to useAuth0, withAuth0, or withAuthenticationRequired to use that specific Auth0Provider to access
 auth state and methods specifically tied to the provider that the context belongs to.
@@ -46,51 +47,55 @@
 used to store data is different
 
 For a sample on using multiple Auth0Providers review the React Account Linking Sample
-
Defined in src/auth0-provider.tsx:86
OptionalcookieDomain
cookieDomain?: string
The domain the cookie is accessible from. If not set, the cookie is scoped to
+
Defined in src/auth0-provider.tsx:86
OptionalcookieDomain
cookieDomain?: string
The domain the cookie is accessible from. If not set, the cookie is scoped to
 the current domain, including the subdomain.
 Note: setting this incorrectly may cause silent authentication to stop working
 on page load.
 To keep a user logged in across multiple subdomains set this to your
 top-level domain and prefixed with a . (eg: .example.com).
-
Inherited from Auth0ClientOptions.cookieDomain
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:222
domain
domain: string
Your Auth0 account domain such as 'example.auth0.com',
+
Inherited from Auth0ClientOptions.cookieDomain
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:223
domain
domain: string
Your Auth0 account domain such as 'example.auth0.com',
 'example.eu.auth0.com' or , 'example.mycompany.com'
 (when using custom domains)
-
Inherited from Auth0ClientOptions.domain
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:111
OptionalhttpTimeoutInSeconds
httpTimeoutInSeconds?: number
Specify the timeout for HTTP calls using fetch. The default is 10 seconds.
-
Inherited from Auth0ClientOptions.httpTimeoutInSeconds
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:173
Optionalissuer
issuer?: string
The issuer to be used for validation of JWTs, optionally defaults to the domain above
-
Inherited from Auth0ClientOptions.issuer
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:115
Optionalleeway
leeway?: number
The value in seconds used to account for clock skew in JWT expirations.
+
Inherited from Auth0ClientOptions.domain
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:112
OptionalhttpTimeoutInSeconds
httpTimeoutInSeconds?: number
Specify the timeout for HTTP calls using fetch. The default is 10 seconds.
+
Inherited from Auth0ClientOptions.httpTimeoutInSeconds
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:174
Optionalissuer
issuer?: string
The issuer to be used for validation of JWTs, optionally defaults to the domain above
+
Inherited from Auth0ClientOptions.issuer
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:116
Optionalleeway
leeway?: number
The value in seconds used to account for clock skew in JWT expirations.
 Typically, this value is no more than a minute or two at maximum.
 Defaults to 60s.
-
Inherited from Auth0ClientOptions.leeway
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:125
OptionallegacySameSiteCookie
legacySameSiteCookie?: boolean
Sets an additional cookie with no SameSite attribute to support legacy browsers
+
Inherited from Auth0ClientOptions.leeway
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:126
OptionallegacySameSiteCookie
legacySameSiteCookie?: boolean
Sets an additional cookie with no SameSite attribute to support legacy browsers
 that are not compatible with the latest SameSite changes.
 This will log a warning on modern browsers, you can disable the warning by setting
 this to false but be aware that some older useragents will not work,
 See https://www.chromium.org/updates/same-site/incompatible-clients
 Defaults to true
-
Inherited from Auth0ClientOptions.legacySameSiteCookie
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:193
OptionalnowProvider
nowProvider?: () => number | Promise<number>
Modify the value used as the current time during the token validation.
+
Inherited from Auth0ClientOptions.legacySameSiteCookie
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:194
OptionalnowProvider
nowProvider?: () => number | Promise<number>
Modify the value used as the current time during the token validation.
 Note: Using this improperly can potentially compromise the token validation.
-
Inherited from Auth0ClientOptions.nowProvider
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:235
OptionalonRedirectCallback
onRedirectCallback?: (appState?: AppState, user?: TUser) => void
By default this removes the code and state parameters from the url when you are redirected from the authorize page.
+
Inherited from Auth0ClientOptions.nowProvider
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:236
OptionalonRedirectCallback
onRedirectCallback?: (appState?: AppState, user?: TUser) => void
By default this removes the code and state parameters from the url when you are redirected from the authorize page.
 It uses window.history but you might want to overwrite this if you are using a custom router, like react-router-dom
 See the EXAMPLES.md for more info.
-
Defined in src/auth0-provider.tsx:54
OptionalsessionCheckExpiryDays
sessionCheckExpiryDays?: number
Number of days until the cookie auth0.is.authenticated will expire
+
Defined in src/auth0-provider.tsx:54
OptionalsessionCheckExpiryDays
sessionCheckExpiryDays?: number
Number of days until the cookie auth0.is.authenticated will expire
 Defaults to 1.
-
Inherited from Auth0ClientOptions.sessionCheckExpiryDays
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:210
OptionalskipRedirectCallback
skipRedirectCallback?: boolean
By default, if the page url has code/state params, the SDK will treat them as Auth0's and attempt to exchange the
+
Inherited from Auth0ClientOptions.sessionCheckExpiryDays
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:211
OptionalskipRedirectCallback
skipRedirectCallback?: boolean
By default, if the page url has code/state params, the SDK will treat them as Auth0's and attempt to exchange the
 code for a token. In some cases the code might be for something else (another OAuth SDK perhaps). In these
 instances you can instruct the client to ignore them eg
 <Auth0Provider
  clientId={clientId}
  domain={domain}
  skipRedirectCallback={window.location.pathname === '/stripe-oauth-callback'}
>
 
 
-
Defined in src/auth0-provider.tsx:68
OptionaluseCookiesForTransactions
useCookiesForTransactions?: boolean
If true, the SDK will use a cookie when storing information about the auth transaction while
+
Defined in src/auth0-provider.tsx:68
OptionaluseCookiesForTransactions
useCookiesForTransactions?: boolean
If true, the SDK will use a cookie when storing information about the auth transaction while
 the user is going through the authentication flow on the authorization server.
 The default is false, in which case the SDK will use session storage.
 
Notes
You might want to enable this if you rely on your users being able to authenticate using flows that
 may end up spanning across multiple tabs (e.g. magic links) or you cannot otherwise rely on session storage being available.
-
Inherited from Auth0ClientOptions.useCookiesForTransactions
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:205
OptionaluseFormData
useFormData?: boolean
If true, data to the token endpoint is transmitted as x-www-form-urlencoded data, if false it will be transmitted as JSON. The default setting is true.
+
Inherited from Auth0ClientOptions.useCookiesForTransactions
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:206
OptionaluseDpop
useDpop?: boolean
If true, DPoP (OAuth 2.0 Demonstrating Proof of Possession, RFC9449)
+will be used to cryptographically bind tokens to this specific browser
+so they can't be used from a different device in case of a leak.
+The default setting is false.
+
Inherited from Auth0ClientOptions.useDpop
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:253
OptionaluseFormData
useFormData?: boolean
If true, data to the token endpoint is transmitted as x-www-form-urlencoded data, if false it will be transmitted as JSON. The default setting is true.
 Note: Setting this to false may affect you if you use Auth0 Rules and are sending custom, non-primitive data. If you disable this,
 please verify that your Auth0 Rules continue to work as intended.
-
Inherited from Auth0ClientOptions.useFormData
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:229
OptionaluseRefreshTokens
useRefreshTokens?: boolean
If true, refresh tokens are used to fetch new access tokens from the Auth0 server. If false, the legacy technique of using a hidden iframe and the authorization_code grant with prompt=none is used.
+
Inherited from Auth0ClientOptions.useFormData
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:230
OptionaluseRefreshTokens
useRefreshTokens?: boolean
If true, refresh tokens are used to fetch new access tokens from the Auth0 server. If false, the legacy technique of using a hidden iframe and the authorization_code grant with prompt=none is used.
 The default setting is false.
 Note: Use of refresh tokens must be enabled by an administrator on your Auth0 client application.
-
Inherited from Auth0ClientOptions.useRefreshTokens
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:143
OptionaluseRefreshTokensFallback
useRefreshTokensFallback?: boolean
If true, fallback to the technique of using a hidden iframe and the authorization_code grant with prompt=none when unable to use refresh tokens. If false, the iframe fallback is not used and
+
Inherited from Auth0ClientOptions.useRefreshTokens
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:144
OptionaluseRefreshTokensFallback
useRefreshTokensFallback?: boolean
If true, fallback to the technique of using a hidden iframe and the authorization_code grant with prompt=none when unable to use refresh tokens. If false, the iframe fallback is not used and
 errors relating to a failed refresh_token grant should be handled appropriately. The default setting is false.
 Note: There might be situations where doing silent auth with a Web Message response from an iframe is not possible,
 like when you're serving your application from the file system or a custom protocol (like in a Desktop or Native app).
@@ -99,9 +104,9 @@
 
Example
let token: string;
try {
  token = await auth0.getTokenSilently();
} catch (e) {
  if (e.error === 'missing_refresh_token' || e.error === 'invalid_grant') {
    auth0.loginWithRedirect();
  }
}
 
 
-
Inherited from Auth0ClientOptions.useRefreshTokensFallback
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:164
OptionalworkerUrl
workerUrl?: string
If provided, the SDK will load the token worker from this URL instead of the integrated blob. An example of when this is useful is if you have strict
+
Inherited from Auth0ClientOptions.useRefreshTokensFallback
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:165
OptionalworkerUrl
workerUrl?: string
If provided, the SDK will load the token worker from this URL instead of the integrated blob. An example of when this is useful is if you have strict
 Content-Security-Policy (CSP) and wish to avoid needing to set worker-src: blob:. We recommend either serving the worker, which you can find in the module
 at <module_path>/dist/auth0-spa-js.worker.production.js, from the same host as your application or using the Auth0 CDN
 https://cdn.auth0.com/js/auth0-spa-js/<version>/auth0-spa-js.worker.production.js.
 Note: The worker is only used when useRefreshTokens: true, cacheLocation: 'memory', and the cache is not custom.
-
Inherited from Auth0ClientOptions.workerUrl
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:244
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
auth0ClientauthorizationParamsauthorizeTimeoutInSecondscachecacheLocationchildrenclientIdcontextcookieDomaindomainhttpTimeoutInSecondsissuerleewaylegacySameSiteCookienowProvideronRedirectCallbacksessionCheckExpiryDaysskipRedirectCallbackuseCookiesForTransactionsuseFormDatauseRefreshTokensuseRefreshTokensFallbackworkerUrl
@auth0/auth0-reactLoading...

+
Inherited from Auth0ClientOptions.workerUrl
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:245
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
auth0ClientauthorizationParamsauthorizeTimeoutInSecondscachecacheLocationchildrenclientIdcontextcookieDomaindomainhttpTimeoutInSecondsissuerleewaylegacySameSiteCookienowProvideronRedirectCallbacksessionCheckExpiryDaysskipRedirectCallbackuseCookiesForTransactionsuseDpopuseFormDatauseRefreshTokensuseRefreshTokensFallbackworkerUrl
@auth0/auth0-reactLoading...

diff --git a/docs/interfaces/AuthorizationParams.html b/docs/interfaces/AuthorizationParams.html
index a40c5611..9e852fb2 100644
--- a/docs/interfaces/AuthorizationParams.html
+++ b/docs/interfaces/AuthorizationParams.html
@@ -1,6 +1,6 @@
 AuthorizationParams | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
AuthorizationParams
Interface AuthorizationParams
interface AuthorizationParams {
    acr_values?: string;
    audience?: string;
    connection?: string;
    display?: "page" | "popup" | "touch" | "wap";
    id_token_hint?: string;
    invitation?: string;
    login_hint?: string;
    max_age?: string | number;
    organization?: string;
    prompt?: "none" | "login" | "consent" | "select_account";
    redirect_uri?: string;
    scope?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: string]: any;
}
Indexable
[key: string]: any
If you need to send custom parameters to the Authorization Server,
 make sure to use the original parameter name.
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:2
Index
Properties
acr_values?
+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:3
Index
Properties
acr_values?
 audience?
 connection?
 display?
@@ -14,26 +14,26 @@
 scope?
 screen_hint?
 ui_locales?
-
Properties
Optionalacr_values
acr_values?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:48
Optionalaudience
audience?: string
The default audience to be used for requesting API access.
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:61
Optionalconnection
connection?: string
The name of the connection configured for your application.
+
Properties
Optionalacr_values
acr_values?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:49
Optionalaudience
audience?: string
The default audience to be used for requesting API access.
+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:62
Optionalconnection
connection?: string
The name of the connection configured for your application.
 If null, it will redirect to the Auth0 Login Page and show
 the Login Widget.
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:67
Optionaldisplay
display?: "page" | "popup" | "touch" | "wap"

+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:68
Optionaldisplay
display?: "page" | "popup" | "touch" | "wap"

 'page': displays the UI with a full page view
 'popup': displays the UI with a popup window
 'touch': displays the UI in a way that leverages a touch interface
 'wap': displays the UI with a "feature phone" type interface
 
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:9
Optionalid_token_hint
id_token_hint?: string
Previously issued ID Token.
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:31
Optionalinvitation
invitation?: string
The Id of an invitation to accept. This is available from the user invitation URL that is given when participating in a user invitation flow.
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:83
Optionallogin_hint
login_hint?: string
The user's email address or other identifier. When your app knows
+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:10
Optionalid_token_hint
id_token_hint?: string
Previously issued ID Token.
+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:32
Optionalinvitation
invitation?: string
The Id of an invitation to accept. This is available from the user invitation URL that is given when participating in a user invitation flow.
+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:84
Optionallogin_hint
login_hint?: string
The user's email address or other identifier. When your app knows
 which user is trying to authenticate, you can provide this parameter
 to pre-fill the email box or select the right session for sign-in.
 This currently only affects the classic Lock experience.
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:47
Optionalmax_age
max_age?: string | number
Maximum allowable elapsed time (in seconds) since authentication.
+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:48
Optionalmax_age
max_age?: string | number
Maximum allowable elapsed time (in seconds) since authentication.
 If the last time the user authenticated is greater than this value,
 the user must be reauthenticated.
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:22
Optionalorganization
organization?: string
The organization to log in to.
+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:23
Optionalorganization
organization?: string
The organization to log in to.
 This will specify an organization parameter in your user's login request.
 
 If you provide an Organization ID (a string with the prefix org_), it will be validated against the org_id claim of your user's ID Token. The validation is case-sensitive.
@@ -41,25 +41,25 @@
 To use an Organization Name you must have "Allow Organization Names in Authentication API" switched on in your Auth0 settings dashboard.
 More information is available on the Auth0 documentation portal
 
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:79
Optionalprompt
prompt?: "none" | "login" | "consent" | "select_account"

+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:80
Optionalprompt
prompt?: "none" | "login" | "consent" | "select_account"

 'none': do not prompt user for login or consent on reauthentication
 'login': prompt user for reauthentication
 'consent': prompt user for consent before processing request
 'select_account': prompt user to select an account
 
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:16
Optionalredirect_uri
redirect_uri?: string
The default URL where Auth0 will redirect your browser to with
+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:17
Optionalredirect_uri
redirect_uri?: string
The default URL where Auth0 will redirect your browser to with
 the authentication result. It must be whitelisted in
 the "Allowed Callback URLs" field in your Auth0 Application's
 settings. If not provided here, it should be provided in the other
 methods that provide authentication.
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:91
Optionalscope
scope?: string
The default scope to be used on authentication requests.
+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:92
Optionalscope
scope?: string
The default scope to be used on authentication requests.
 This defaults to profile email if not set. If you are setting extra scopes and require
 profile and email to be included then you must include them in the provided scope.
 Note: The openid scope is always applied regardless of this setting.
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:57
Optionalscreen_hint
screen_hint?: string
Provides a hint to Auth0 as to what flow should be displayed.
+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:58
Optionalscreen_hint
screen_hint?: string
Provides a hint to Auth0 as to what flow should be displayed.
 The default behavior is to show a login page but you can override
 this by passing 'signup' to show the signup page instead.
 This only affects the New Universal Login Experience.
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:39
Optionalui_locales
ui_locales?: string
The space-separated list of language tags, ordered by preference.
+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:40
Optionalui_locales
ui_locales?: string
The space-separated list of language tags, ordered by preference.
 For example: 'fr-CA fr en'.
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:27
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
acr_valuesaudienceconnectiondisplayid_token_hintinvitationlogin_hintmax_ageorganizationpromptredirect_uriscopescreen_hintui_locales
@auth0/auth0-reactLoading...

+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:28
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
acr_valuesaudienceconnectiondisplayid_token_hintinvitationlogin_hintmax_ageorganizationpromptredirect_uriscopescreen_hintui_locales
@auth0/auth0-reactLoading...

diff --git a/docs/interfaces/GetTokenSilentlyOptions.html b/docs/interfaces/GetTokenSilentlyOptions.html
index ace8ec54..64eeff87 100644
--- a/docs/interfaces/GetTokenSilentlyOptions.html
+++ b/docs/interfaces/GetTokenSilentlyOptions.html
@@ -1,4 +1,4 @@
-GetTokenSilentlyOptions | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
GetTokenSilentlyOptions
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:326
Index
Properties
authorizationParams?
+GetTokenSilentlyOptions | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
GetTokenSilentlyOptions
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:335
Index
Properties
authorizationParams?
 cacheMode?
 detailedResponse?
 timeoutInSeconds?
@@ -13,13 +13,13 @@
 It must be whitelisted in the "Allowed Web Origins" in your
 Auth0 Application's settings.
 
Optionalscope?: string
The scope that was used in the authentication request
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:337
OptionalcacheMode
cacheMode?: "on" | "off" | "cache-only"
When off, ignores the cache and always sends a
+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:346
OptionalcacheMode
cacheMode?: "on" | "off" | "cache-only"
When off, ignores the cache and always sends a
 request to Auth0.
 When cache-only, only reads from the cache and never sends a request to Auth0.
 Defaults to on, where it both reads from the cache and sends a request to Auth0 as needed.
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:333
OptionaldetailedResponse
detailedResponse?: boolean
If true, the full response from the /oauth/token endpoint (or the cache, if the cache was used) is returned
+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:342
OptionaldetailedResponse
detailedResponse?: boolean
If true, the full response from the /oauth/token endpoint (or the cache, if the cache was used) is returned
 (minus refresh_token if one was issued). Otherwise, just the access token is returned.
 The default is false.
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:371
OptionaltimeoutInSeconds
timeoutInSeconds?: number
A maximum number of seconds to wait before declaring the background /authorize call as failed for timeout
+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:380
OptionaltimeoutInSeconds
timeoutInSeconds?: number
A maximum number of seconds to wait before declaring the background /authorize call as failed for timeout
 Defaults to 60s.
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:364
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
authorizationParamscacheModedetailedResponsetimeoutInSeconds
@auth0/auth0-reactLoading...

+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:373
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
authorizationParamscacheModedetailedResponsetimeoutInSeconds
@auth0/auth0-reactLoading...

diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html
index 5b79dc30..5c651601 100644
--- a/docs/interfaces/GetTokenWithPopupOptions.html
+++ b/docs/interfaces/GetTokenWithPopupOptions.html
@@ -1,8 +1,8 @@
-GetTokenWithPopupOptions | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
GetTokenWithPopupOptions
Interface GetTokenWithPopupOptions
interface GetTokenWithPopupOptions {
    authorizationParams?: AuthorizationParams;
    cacheMode?: "on" | "off" | "cache-only";
}
Hierarchy (View Summary)
PopupLoginOptionsGetTokenWithPopupOptions
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:373
Index
Properties
authorizationParams?
+GetTokenWithPopupOptions | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
GetTokenWithPopupOptions
Interface GetTokenWithPopupOptions
interface GetTokenWithPopupOptions {
    authorizationParams?: AuthorizationParams;
    cacheMode?: "on" | "off" | "cache-only";
}
Hierarchy (View Summary)
PopupLoginOptionsGetTokenWithPopupOptions
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:382
Index
Properties
authorizationParams?
 cacheMode?
 
Properties
OptionalauthorizationParams
authorizationParams?: AuthorizationParams
URL parameters that will be sent back to the Authorization Server. This can be known parameters
 defined by Auth0 or custom parameters that you define.
-
Inherited from PopupLoginOptions.authorizationParams
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:103
OptionalcacheMode
cacheMode?: "on" | "off" | "cache-only"
When off, ignores the cache and always sends a request to Auth0.
+
Inherited from PopupLoginOptions.authorizationParams
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:104
OptionalcacheMode
cacheMode?: "on" | "off" | "cache-only"
When off, ignores the cache and always sends a request to Auth0.
 When cache-only, only reads from the cache and never sends a request to Auth0.
 Defaults to on, where it both reads from the cache and sends a request to Auth0 as needed.
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:379
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
authorizationParamscacheMode
@auth0/auth0-reactLoading...

+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:388
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
authorizationParamscacheMode
@auth0/auth0-reactLoading...

diff --git a/docs/interfaces/ICache.html b/docs/interfaces/ICache.html
index 1cf931f8..fcc029e7 100644
--- a/docs/interfaces/ICache.html
+++ b/docs/interfaces/ICache.html
@@ -1,5 +1,5 @@
-ICache | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
ICache
Interface ICache
interface ICache {
    allKeys(): MaybePromise<string[]>;
    get<T = Cacheable>(key: string): MaybePromise<undefined | T>;
    remove(key: string): MaybePromise<void>;
    set<T = Cacheable>(key: string, entry: T): MaybePromise<void>;
}
Implemented by
LocalStorageCache
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/cache/shared.d.ts:62
Index
Methods
allKeys?
+ICache | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
ICache
Interface ICache
interface ICache {
    allKeys(): MaybePromise<string[]>;
    get<T = Cacheable>(key: string): MaybePromise<undefined | T>;
    remove(key: string): MaybePromise<void>;
    set<T = Cacheable>(key: string, entry: T): MaybePromise<void>;
}
Implemented by
LocalStorageCache
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/cache/shared.d.ts:63
Index
Methods
allKeys?
 get
 remove
 set
-
Methods
OptionalallKeys
allKeys(): MaybePromise<string[]>
Returns MaybePromise<string[]>
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/cache/shared.d.ts:66
get
get<T = Cacheable>(key: string): MaybePromise<undefined | T>
Type Parameters
T = Cacheable
Parameters
key: string
Returns MaybePromise<undefined | T>
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/cache/shared.d.ts:64
remove
remove(key: string): MaybePromise<void>
Parameters
key: string
Returns MaybePromise<void>
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/cache/shared.d.ts:65
set
set<T = Cacheable>(key: string, entry: T): MaybePromise<void>
Type Parameters
T = Cacheable
Parameters
key: string
entry: T
Returns MaybePromise<void>
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/cache/shared.d.ts:63
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Methods
allKeysgetremoveset
@auth0/auth0-reactLoading...

+
Methods
OptionalallKeys
allKeys(): MaybePromise<string[]>
Returns MaybePromise<string[]>
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/cache/shared.d.ts:67
get
get<T = Cacheable>(key: string): MaybePromise<undefined | T>
Type Parameters
T = Cacheable
Parameters
key: string
Returns MaybePromise<undefined | T>
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/cache/shared.d.ts:65
remove
remove(key: string): MaybePromise<void>
Parameters
key: string
Returns MaybePromise<void>
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/cache/shared.d.ts:66
set
set<T = Cacheable>(key: string, entry: T): MaybePromise<void>
Type Parameters
T = Cacheable
Parameters
key: string
entry: T
Returns MaybePromise<void>
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/cache/shared.d.ts:64
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Methods
allKeysgetremoveset
@auth0/auth0-reactLoading...

diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html
index 13b8f880..ff027416 100644
--- a/docs/interfaces/IdToken.html
+++ b/docs/interfaces/IdToken.html
@@ -1,4 +1,4 @@
-IdToken | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
IdToken
Interface IdToken
interface IdToken {
    __raw: string;
    acr?: string;
    address?: string;
    amr?: string[];
    at_hash?: string;
    aud?: string;
    auth_time?: string;
    azp?: string;
    birthdate?: string;
    c_hash?: string;
    cnf?: string;
    email?: string;
    email_verified?: boolean;
    exp?: number;
    family_name?: string;
    gender?: string;
    given_name?: string;
    iat?: number;
    iss?: string;
    jti?: string;
    locale?: string;
    middle_name?: string;
    name?: string;
    nbf?: number;
    nickname?: string;
    nonce?: string;
    org_id?: string;
    org_name?: string;
    phone_number?: string;
    phone_number_verified?: boolean;
    picture?: string;
    preferred_username?: string;
    profile?: string;
    sid?: string;
    sub_jwk?: string;
    updated_at?: string;
    website?: string;
    zoneinfo?: string;
    [key: string]: any;
}
Indexable
[key: string]: any
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:516
Index
Properties
__raw
+IdToken | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
IdToken
Interface IdToken
interface IdToken {
    __raw: string;
    acr?: string;
    address?: string;
    amr?: string[];
    at_hash?: string;
    aud?: string;
    auth_time?: string;
    azp?: string;
    birthdate?: string;
    c_hash?: string;
    cnf?: string;
    email?: string;
    email_verified?: boolean;
    exp?: number;
    family_name?: string;
    gender?: string;
    given_name?: string;
    iat?: number;
    iss?: string;
    jti?: string;
    locale?: string;
    middle_name?: string;
    name?: string;
    nbf?: number;
    nickname?: string;
    nonce?: string;
    org_id?: string;
    org_name?: string;
    phone_number?: string;
    phone_number_verified?: boolean;
    picture?: string;
    preferred_username?: string;
    profile?: string;
    sid?: string;
    sub_jwk?: string;
    updated_at?: string;
    website?: string;
    zoneinfo?: string;
    [key: string]: any;
}
Indexable
[key: string]: any
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:527
Index
Properties
__raw
 acr?
 address?
 amr?
@@ -36,4 +36,4 @@
 updated_at?
 website?
 zoneinfo?
-
Properties
__raw
__raw: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:517
Optionalacr
acr?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:548
Optionaladdress
address?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:535
Optionalamr
amr?: string[]
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:549
Optionalat_hash
at_hash?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:546
Optionalaud
aud?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:538
Optionalauth_time
auth_time?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:545
Optionalazp
azp?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:543
Optionalbirthdate
birthdate?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:530
Optionalc_hash
c_hash?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:547
Optionalcnf
cnf?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:551
Optionalemail
email?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:527
Optionalemail_verified
email_verified?: boolean
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:528
Optionalexp
exp?: number
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:539
Optionalfamily_name
family_name?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:520
Optionalgender
gender?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:529
Optionalgiven_name
given_name?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:519
Optionaliat
iat?: number
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:541
Optionaliss
iss?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:537
Optionaljti
jti?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:542
Optionallocale
locale?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:532
Optionalmiddle_name
middle_name?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:521
Optionalname
name?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:518
Optionalnbf
nbf?: number
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:540
Optionalnickname
nickname?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:522
Optionalnonce
nonce?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:544
Optionalorg_id
org_id?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:553
Optionalorg_name
org_name?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:554
Optionalphone_number
phone_number?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:533
Optionalphone_number_verified
phone_number_verified?: boolean
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:534
Optionalpicture
picture?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:525
Optionalpreferred_username
preferred_username?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:523
Optionalprofile
profile?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:524
Optionalsid
sid?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:552
Optionalsub_jwk
sub_jwk?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:550
Optionalupdated_at
updated_at?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:536
Optionalwebsite
website?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:526
Optionalzoneinfo
zoneinfo?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:531
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
__rawacraddressamrat_hashaudauth_timeazpbirthdatec_hashcnfemailemail_verifiedexpfamily_namegendergiven_nameiatissjtilocalemiddle_namenamenbfnicknamenonceorg_idorg_namephone_numberphone_number_verifiedpicturepreferred_usernameprofilesidsub_jwkupdated_atwebsitezoneinfo
@auth0/auth0-reactLoading...

+
Properties
__raw
__raw: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:528
Optionalacr
acr?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:559
Optionaladdress
address?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:546
Optionalamr
amr?: string[]
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:560
Optionalat_hash
at_hash?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:557
Optionalaud
aud?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:549
Optionalauth_time
auth_time?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:556
Optionalazp
azp?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:554
Optionalbirthdate
birthdate?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:541
Optionalc_hash
c_hash?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:558
Optionalcnf
cnf?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:562
Optionalemail
email?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:538
Optionalemail_verified
email_verified?: boolean
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:539
Optionalexp
exp?: number
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:550
Optionalfamily_name
family_name?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:531
Optionalgender
gender?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:540
Optionalgiven_name
given_name?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:530
Optionaliat
iat?: number
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:552
Optionaliss
iss?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:548
Optionaljti
jti?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:553
Optionallocale
locale?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:543
Optionalmiddle_name
middle_name?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:532
Optionalname
name?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:529
Optionalnbf
nbf?: number
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:551
Optionalnickname
nickname?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:533
Optionalnonce
nonce?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:555
Optionalorg_id
org_id?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:564
Optionalorg_name
org_name?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:565
Optionalphone_number
phone_number?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:544
Optionalphone_number_verified
phone_number_verified?: boolean
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:545
Optionalpicture
picture?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:536
Optionalpreferred_username
preferred_username?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:534
Optionalprofile
profile?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:535
Optionalsid
sid?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:563
Optionalsub_jwk
sub_jwk?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:561
Optionalupdated_at
updated_at?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:547
Optionalwebsite
website?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:537
Optionalzoneinfo
zoneinfo?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:542
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
__rawacraddressamrat_hashaudauth_timeazpbirthdatec_hashcnfemailemail_verifiedexpfamily_namegendergiven_nameiatissjtilocalemiddle_namenamenbfnicknamenonceorg_idorg_namephone_numberphone_number_verifiedpicturepreferred_usernameprofilesidsub_jwkupdated_atwebsitezoneinfo
@auth0/auth0-reactLoading...

diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html
index a05e1792..73cfe7be 100644
--- a/docs/interfaces/LogoutOptions.html
+++ b/docs/interfaces/LogoutOptions.html
@@ -1,11 +1,11 @@
-LogoutOptions | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
LogoutOptions
Interface LogoutOptions
interface LogoutOptions {
    clientId?: null | string;
    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:18
Index
Properties
clientId?
+LogoutOptions | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
LogoutOptions
Interface LogoutOptions
interface LogoutOptions {
    clientId?: null | string;
    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:19
Index
Properties
clientId?
 logoutParams?
 openUrl?
 
Properties
OptionalclientId
clientId?: null | string
The clientId of your application.
 If this property is not set, then the clientId that was used during initialization of the SDK is sent to the logout endpoint.
 If this property is set to null, then no client ID value is sent to the logout endpoint.
 Read more about how redirecting after logout works
-
Inherited from Omit.clientId
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:391
OptionallogoutParams
logoutParams?: { federated?: boolean; returnTo?: string; [key: string]: any }
Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters
+
Inherited from Omit.clientId
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:400
OptionallogoutParams
logoutParams?: { federated?: boolean; returnTo?: string; [key: string]: any }
Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters
 you wish to provide.
 
Type declaration
[key: string]: any
If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.
 
Optionalfederated?: boolean
When supported by the upstream identity provider,
@@ -20,7 +20,7 @@
 returnTo URL must be listed in the "Allowed Logout URLs" at
 the account level in the Auth0 dashboard.
 Read more about how redirecting after logout works
-
Inherited from Omit.logoutParams
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:396
OptionalopenUrl
openUrl?: false | ((url: string) => void | Promise<void>)
Used to control the redirect and not rely on the SDK to do the actual redirect.
+
Inherited from Omit.logoutParams
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:405
OptionalopenUrl
openUrl?: false | ((url: string) => void | Promise<void>)
Used to control the redirect and not rely on the SDK to do the actual redirect.
 Set to false to disable the redirect, or provide a function to handle the actual redirect yourself.
 
Example
await auth0.logout({
  openUrl(url) {
    window.location.replace(url);
  }
});
 
@@ -28,4 +28,4 @@
 
Example
import { Browser } from '@capacitor/browser';

await auth0.logout({
  async openUrl(url) {
    await Browser.open({ url });
  }
});
 
 
-
Inherited from Omit.openUrl
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:457
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
clientIdlogoutParamsopenUrl
@auth0/auth0-reactLoading...

+Inherited from Omit.openUrl
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:466
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
clientIdlogoutParamsopenUrl
@auth0/auth0-reactLoading...

diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html
index 8a7ca5cc..f5181c56 100644
--- a/docs/interfaces/LogoutUrlOptions.html
+++ b/docs/interfaces/LogoutUrlOptions.html
@@ -1,10 +1,10 @@
-LogoutUrlOptions | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
LogoutUrlOptions
Interface LogoutUrlOptions
interface LogoutUrlOptions {
    clientId?: null | string;
    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    };
}
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:381
Index
Properties
clientId?
+LogoutUrlOptions | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
LogoutUrlOptions
Interface LogoutUrlOptions
interface LogoutUrlOptions {
    clientId?: null | string;
    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    };
}
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:390
Index
Properties
clientId?
 logoutParams?
 
Properties
OptionalclientId
clientId?: null | string
The clientId of your application.
 If this property is not set, then the clientId that was used during initialization of the SDK is sent to the logout endpoint.
 If this property is set to null, then no client ID value is sent to the logout endpoint.
 Read more about how redirecting after logout works
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:391
OptionallogoutParams
logoutParams?: { federated?: boolean; returnTo?: string; [key: string]: any }
Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters
+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:400
OptionallogoutParams
logoutParams?: { federated?: boolean; returnTo?: string; [key: string]: any }
Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters
 you wish to provide.
 
Type declaration
[key: string]: any
If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.
 
Optionalfederated?: boolean
When supported by the upstream identity provider,
@@ -19,4 +19,4 @@
 returnTo URL must be listed in the "Allowed Logout URLs" at
 the account level in the Auth0 dashboard.
 Read more about how redirecting after logout works
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:396
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
clientIdlogoutParams
@auth0/auth0-reactLoading...

+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:405
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
clientIdlogoutParams
@auth0/auth0-reactLoading...

diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html
index d02c2248..28d208cc 100644
--- a/docs/interfaces/PopupConfigOptions.html
+++ b/docs/interfaces/PopupConfigOptions.html
@@ -1,8 +1,8 @@
-PopupConfigOptions | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
PopupConfigOptions
Interface PopupConfigOptions
interface PopupConfigOptions {
    popup?: any;
    timeoutInSeconds?: number;
}
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:313
Index
Properties
popup?
+PopupConfigOptions | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
PopupConfigOptions
Interface PopupConfigOptions
interface PopupConfigOptions {
    popup?: any;
    timeoutInSeconds?: number;
}
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:322
Index
Properties
popup?
 timeoutInSeconds?
 
Properties
Optionalpopup
popup?: any
Accepts an already-created popup window to use. If not specified, the SDK
 will create its own. This may be useful for platforms like iOS that have
 security restrictions around when popups can be invoked (e.g. from a user click event)
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:324
OptionaltimeoutInSeconds
timeoutInSeconds?: number
The number of seconds to wait for a popup response before
+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:333
OptionaltimeoutInSeconds
timeoutInSeconds?: number
The number of seconds to wait for a popup response before
 throwing a timeout error. Defaults to 60s
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:318
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
popuptimeoutInSeconds
@auth0/auth0-reactLoading...

+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:327
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
popuptimeoutInSeconds
@auth0/auth0-reactLoading...

diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html
index af2eb17d..942c0782 100644
--- a/docs/interfaces/PopupLoginOptions.html
+++ b/docs/interfaces/PopupLoginOptions.html
@@ -1,4 +1,4 @@
-PopupLoginOptions | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
PopupLoginOptions
Interface PopupLoginOptions
interface PopupLoginOptions {
    authorizationParams?: AuthorizationParams;
}
Hierarchy (View Summary)
BaseLoginOptionsPopupLoginOptionsGetTokenWithPopupOptions
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:311
Index
Properties
authorizationParams?
+PopupLoginOptions | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
PopupLoginOptions
Interface PopupLoginOptions
interface PopupLoginOptions {
    authorizationParams?: AuthorizationParams;
}
Hierarchy (View Summary)
BaseLoginOptionsPopupLoginOptionsGetTokenWithPopupOptions
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:320
Index
Properties
authorizationParams?
 
Properties
OptionalauthorizationParams
authorizationParams?: AuthorizationParams
URL parameters that will be sent back to the Authorization Server. This can be known parameters
 defined by Auth0 or custom parameters that you define.
-
Inherited from BaseLoginOptions.authorizationParams
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:103
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
authorizationParams
@auth0/auth0-reactLoading...

+
Inherited from BaseLoginOptions.authorizationParams
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:104
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
authorizationParams
@auth0/auth0-reactLoading...

diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html
index e314e32b..ed6ca603 100644
--- a/docs/interfaces/RedirectLoginOptions.html
+++ b/docs/interfaces/RedirectLoginOptions.html
@@ -1,16 +1,16 @@
-RedirectLoginOptions | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
RedirectLoginOptions
Interface RedirectLoginOptions<TAppState>
interface RedirectLoginOptions<TAppState = AppState> {
    appState?: TAppState;
    authorizationParams?: AuthorizationParams;
    fragment?: string;
    openUrl?: (url: string) => void | Promise<void>;
}
Type Parameters
TAppState = AppState
Hierarchy
Omit<SPARedirectLoginOptions<TAppState>, "onRedirect">RedirectLoginOptions
Defined in src/auth0-context.tsx:20
Index
Properties
appState?
+RedirectLoginOptions | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
RedirectLoginOptions
Interface RedirectLoginOptions<TAppState>
interface RedirectLoginOptions<TAppState = AppState> {
    appState?: TAppState;
    authorizationParams?: AuthorizationParams;
    fragment?: string;
    openUrl?: (url: string) => void | Promise<void>;
}
Type Parameters
TAppState = AppState
Hierarchy
Omit<SPARedirectLoginOptions<TAppState>, "onRedirect">RedirectLoginOptions
Defined in src/auth0-context.tsx:21
Index
Properties
appState?
 authorizationParams?
 fragment?
 openUrl?
 
Properties
OptionalappState
appState?: TAppState
Used to store state before doing the redirect
-
Inherited from Omit.appState
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:267
OptionalauthorizationParams
authorizationParams?: AuthorizationParams
URL parameters that will be sent back to the Authorization Server. This can be known parameters
+
Inherited from Omit.appState
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:276
OptionalauthorizationParams
authorizationParams?: AuthorizationParams
URL parameters that will be sent back to the Authorization Server. This can be known parameters
 defined by Auth0 or custom parameters that you define.
-
Inherited from Omit.authorizationParams
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:103
Optionalfragment
fragment?: string
Used to add to the URL fragment before redirecting
-
Inherited from Omit.fragment
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:271
OptionalopenUrl
openUrl?: (url: string) => void | Promise<void>
Used to control the redirect and not rely on the SDK to do the actual redirect.
+
Inherited from Omit.authorizationParams
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:104
Optionalfragment
fragment?: string
Used to add to the URL fragment before redirecting
+
Inherited from Omit.fragment
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:280
OptionalopenUrl
openUrl?: (url: string) => void | Promise<void>
Used to control the redirect and not rely on the SDK to do the actual redirect.
 
Example
const client = new Auth0Client({
  openUrl(url) {
    window.location.replace(url);
  }
});
 
 
 
Example
import { Browser } from '@capacitor/browser';

const client = new Auth0Client({
  async openUrl(url) {
    await Browser.open({ url });
  }
});
 
 
-
Inherited from Omit.openUrl
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:303
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
appStateauthorizationParamsfragmentopenUrl
@auth0/auth0-reactLoading...

+
Inherited from Omit.openUrl
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:312
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
appStateauthorizationParamsfragmentopenUrl
@auth0/auth0-reactLoading...

diff --git a/docs/interfaces/WithAuth0Props.html b/docs/interfaces/WithAuth0Props.html
index d80f2eb4..6d19b90d 100644
--- a/docs/interfaces/WithAuth0Props.html
+++ b/docs/interfaces/WithAuth0Props.html
@@ -1,3 +1,3 @@
 WithAuth0Props | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
WithAuth0Props
Interface WithAuth0Props
Components wrapped in withAuth0 will have an additional auth0 prop
-
interface WithAuth0Props {
    auth0: Auth0ContextInterface;
}
Defined in src/with-auth0.tsx:7
Index
Properties
auth0
-
Properties
auth0
auth0: Auth0ContextInterface
Defined in src/with-auth0.tsx:8
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
auth0
@auth0/auth0-reactLoading...

+
interface WithAuth0Props {
    auth0: Auth0ContextInterface;
}
Defined in src/with-auth0.tsx:7
Index
Properties
auth0
+
Properties
auth0
auth0: Auth0ContextInterface
Defined in src/with-auth0.tsx:8
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
auth0
@auth0/auth0-reactLoading...

diff --git a/docs/interfaces/WithAuthenticationRequiredOptions.html b/docs/interfaces/WithAuthenticationRequiredOptions.html
index be3c8c0d..886555c4 100644
--- a/docs/interfaces/WithAuthenticationRequiredOptions.html
+++ b/docs/interfaces/WithAuthenticationRequiredOptions.html
@@ -1,5 +1,5 @@
 WithAuthenticationRequiredOptions | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
WithAuthenticationRequiredOptions
Interface WithAuthenticationRequiredOptions
Options for the withAuthenticationRequired Higher Order Component
-
interface WithAuthenticationRequiredOptions {
    context?: Context<Auth0ContextInterface<User>>;
    loginOptions?: RedirectLoginOptions<AppState>;
    onBeforeAuthentication?: () => Promise<void>;
    onRedirecting?: () => Element;
    returnTo?: string | (() => string);
}
Defined in src/with-authentication-required.tsx:27
Index
Properties
context?
+
interface WithAuthenticationRequiredOptions {
    context?: Context<Auth0ContextInterface<User>>;
    loginOptions?: RedirectLoginOptions<AppState>;
    onBeforeAuthentication?: () => Promise<void>;
    onRedirecting?: () => Element;
    returnTo?: string | (() => string);
}
Defined in src/with-authentication-required.tsx:27
Index
Properties
context?
 loginOptions?
 onBeforeAuthentication?
 onRedirecting?
@@ -7,20 +7,20 @@
 
Properties
Optionalcontext
context?: Context<Auth0ContextInterface<User>>
The context to be used when calling useAuth0, this should only be provided if you are using multiple Auth0Providers
 within your application and you wish to tie a specific component to a Auth0Provider other than the Auth0Provider
 associated with the default Auth0Context.
-
Defined in src/with-authentication-required.tsx:86
OptionalloginOptions
loginOptions?: RedirectLoginOptions<AppState>
withAuthenticationRequired(Profile, {
  loginOptions: {
    appState: {
      customProp: 'foo'
    }
  }
})
+
Defined in src/with-authentication-required.tsx:86
OptionalloginOptions
loginOptions?: RedirectLoginOptions<AppState>
withAuthenticationRequired(Profile, {
  loginOptions: {
    appState: {
      customProp: 'foo'
    }
  }
})
 

 
 Pass additional login options, like extra appState to the login page.
 This will be merged with the returnTo option used by the onRedirectCallback handler.
-
Defined in src/with-authentication-required.tsx:80
OptionalonBeforeAuthentication
onBeforeAuthentication?: () => Promise<void>
withAuthenticationRequired(Profile, {
  onBeforeAuthentication: () => { analyticsLibrary.track('login_triggered'); }
})
+
Defined in src/with-authentication-required.tsx:80
OptionalonBeforeAuthentication
onBeforeAuthentication?: () => Promise<void>
withAuthenticationRequired(Profile, {
  onBeforeAuthentication: () => { analyticsLibrary.track('login_triggered'); }
})
 

 
 Allows executing logic before the user is redirected to the login page.
-
Defined in src/with-authentication-required.tsx:65
OptionalonRedirecting
onRedirecting?: () => Element
withAuthenticationRequired(Profile, {
  onRedirecting: () => <div>Redirecting you to the login...</div>
})
+
Defined in src/with-authentication-required.tsx:65
OptionalonRedirecting
onRedirecting?: () => Element
withAuthenticationRequired(Profile, {
  onRedirecting: () => <div>Redirecting you to the login...</div>
})
 

 
 Render a message to show that the user is being redirected to the login.
-
Defined in src/with-authentication-required.tsx:55
OptionalreturnTo
returnTo?: string | (() => string)
withAuthenticationRequired(Profile, {
  returnTo: '/profile'
})
+
Defined in src/with-authentication-required.tsx:55
OptionalreturnTo
returnTo?: string | (() => string)
withAuthenticationRequired(Profile, {
  returnTo: '/profile'
})
 

 
 or
@@ -28,4 +28,4 @@
 
 
 Add a path for the onRedirectCallback handler to return the user to after login.
-
Defined in src/with-authentication-required.tsx:45
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
contextloginOptionsonBeforeAuthenticationonRedirectingreturnTo
@auth0/auth0-reactLoading...

+
Defined in src/with-authentication-required.tsx:45
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
contextloginOptionsonBeforeAuthenticationonRedirectingreturnTo
@auth0/auth0-reactLoading...

diff --git a/docs/modules.html b/docs/modules.html
index 37915723..892db9f4 100644
--- a/docs/modules.html
+++ b/docs/modules.html
@@ -1 +1 @@
-@auth0/auth0-react@auth0/auth0-react
Preparing search index...
@auth0/auth0-react
Classes
AuthenticationError
GenericError
InMemoryCache
LocalStorageCache
MfaRequiredError
MissingRefreshTokenError
OAuthError
PopupCancelledError
PopupTimeoutError
TimeoutError
User
Interfaces
Auth0ContextInterface
Auth0ProviderOptions
AuthorizationParams
GetTokenSilentlyOptions
GetTokenWithPopupOptions
ICache
IdToken
LogoutOptions
LogoutUrlOptions
PopupConfigOptions
PopupLoginOptions
RedirectLoginOptions
WithAuth0Props
WithAuthenticationRequiredOptions
Type Aliases
AppState
Cacheable
CacheLocation
Variables
Auth0Context
Functions
Auth0Provider
useAuth0
withAuth0
withAuthenticationRequired
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Classes
AuthenticationErrorGenericErrorInMemoryCacheLocalStorageCacheMfaRequiredErrorMissingRefreshTokenErrorOAuthErrorPopupCancelledErrorPopupTimeoutErrorTimeoutErrorUser
Interfaces
Auth0ContextInterfaceAuth0ProviderOptionsAuthorizationParamsGetTokenSilentlyOptionsGetTokenWithPopupOptionsICacheIdTokenLogoutOptionsLogoutUrlOptionsPopupConfigOptionsPopupLoginOptionsRedirectLoginOptionsWithAuth0PropsWithAuthenticationRequiredOptions
Type Aliases
AppStateCacheableCacheLocation
Variables
Auth0Context
Functions
Auth0ProvideruseAuth0withAuth0withAuthenticationRequired
@auth0/auth0-reactLoading...

+@auth0/auth0-react@auth0/auth0-react
Preparing search index...
@auth0/auth0-react
Classes
AuthenticationError
GenericError
InMemoryCache
LocalStorageCache
MfaRequiredError
MissingRefreshTokenError
OAuthError
PopupCancelledError
PopupTimeoutError
TimeoutError
UseDpopNonceError
User
Interfaces
Auth0ContextInterface
Auth0ProviderOptions
AuthorizationParams
GetTokenSilentlyOptions
GetTokenWithPopupOptions
ICache
IdToken
LogoutOptions
LogoutUrlOptions
PopupConfigOptions
PopupLoginOptions
RedirectLoginOptions
WithAuth0Props
WithAuthenticationRequiredOptions
Type Aliases
AppState
Cacheable
CacheLocation
FetcherConfig
Variables
Auth0Context
Functions
Auth0Provider
useAuth0
withAuth0
withAuthenticationRequired
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Classes
AuthenticationErrorGenericErrorInMemoryCacheLocalStorageCacheMfaRequiredErrorMissingRefreshTokenErrorOAuthErrorPopupCancelledErrorPopupTimeoutErrorTimeoutErrorUseDpopNonceErrorUser
Interfaces
Auth0ContextInterfaceAuth0ProviderOptionsAuthorizationParamsGetTokenSilentlyOptionsGetTokenWithPopupOptionsICacheIdTokenLogoutOptionsLogoutUrlOptionsPopupConfigOptionsPopupLoginOptionsRedirectLoginOptionsWithAuth0PropsWithAuthenticationRequiredOptions
Type Aliases
AppStateCacheableCacheLocationFetcherConfig
Variables
Auth0Context
Functions
Auth0ProvideruseAuth0withAuth0withAuthenticationRequired
@auth0/auth0-reactLoading...

diff --git a/docs/types/AppState.html b/docs/types/AppState.html
index 9967e928..29512f1d 100644
--- a/docs/types/AppState.html
+++ b/docs/types/AppState.html
@@ -1,3 +1,3 @@
 AppState | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
AppState
Type Alias AppState
The state of the application before the user was redirected to the login page.
-
type AppState = {
    returnTo?: string;
    [key: string]: any;
}
Indexable
[key: string]: any
Defined in src/auth0-provider.tsx:36
Index
Properties
returnTo?
-
Properties
OptionalreturnTo
returnTo?: string
Defined in src/auth0-provider.tsx:37
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
returnTo
@auth0/auth0-reactLoading...

+
type AppState = {
    returnTo?: string;
    [key: string]: any;
}
Indexable
[key: string]: any
Defined in src/auth0-provider.tsx:36
Index
Properties
returnTo?
+
Properties
OptionalreturnTo
returnTo?: string
Defined in src/auth0-provider.tsx:37
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
returnTo
@auth0/auth0-reactLoading...

diff --git a/docs/types/CacheLocation.html b/docs/types/CacheLocation.html
index 53cf383d..08b27564 100644
--- a/docs/types/CacheLocation.html
+++ b/docs/types/CacheLocation.html
@@ -1,2 +1,2 @@
 CacheLocation | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
CacheLocation
Type Alias CacheLocation
CacheLocation: "memory" | "localstorage"
The possible locations where tokens can be stored
-
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:249
Settings
Member VisibilityProtected
Inherited
External
Theme
@auth0/auth0-reactLoading...

+
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:258
Settings
Member VisibilityProtected
Inherited
External
Theme
@auth0/auth0-reactLoading...

diff --git a/docs/types/Cacheable.html b/docs/types/Cacheable.html
index 30262fa8..4378e1b3 100644
--- a/docs/types/Cacheable.html
+++ b/docs/types/Cacheable.html
@@ -1 +1 @@
-Cacheable | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
Cacheable
Type Alias Cacheable
Cacheable: WrappedCacheEntry | KeyManifestEntry
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/cache/shared.d.ts:60
Settings
Member VisibilityProtected
Inherited
External
Theme
@auth0/auth0-reactLoading...

+Cacheable | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
Cacheable
Type Alias Cacheable
Cacheable: WrappedCacheEntry | KeyManifestEntry
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/cache/shared.d.ts:61
Settings
Member VisibilityProtected
Inherited
External
Theme
@auth0/auth0-reactLoading...

diff --git a/docs/types/FetcherConfig.html b/docs/types/FetcherConfig.html
new file mode 100644
index 00000000..62625832
--- /dev/null
+++ b/docs/types/FetcherConfig.html
@@ -0,0 +1,5 @@
+FetcherConfig | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
FetcherConfig
Type Alias FetcherConfig<TOutput>
type FetcherConfig<TOutput extends CustomFetchMinimalOutput> = {
    baseUrl?: string;
    dpopNonceId?: string;
    fetch?: CustomFetchImpl<TOutput>;
    getAccessToken?: AccessTokenFactory;
}
Type Parameters
TOutput extends CustomFetchMinimalOutput
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/fetcher.d.ts:10
Index
Properties
baseUrl?
+dpopNonceId?
+fetch?
+getAccessToken?
+
Properties
OptionalbaseUrl
baseUrl?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/fetcher.d.ts:12
OptionaldpopNonceId
dpopNonceId?: string
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/fetcher.d.ts:14
Optionalfetch
fetch?: CustomFetchImpl<TOutput>
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/fetcher.d.ts:13
OptionalgetAccessToken
getAccessToken?: AccessTokenFactory
Defined in node_modules/@auth0/auth0-spa-js/dist/typings/fetcher.d.ts:11
Settings
Member VisibilityProtected
Inherited
External
Theme
On This Page
Properties
baseUrldpopNonceIdfetchgetAccessToken
@auth0/auth0-reactLoading...

diff --git a/docs/variables/Auth0Context.html b/docs/variables/Auth0Context.html
index c07ff85c..9407eeb1 100644
--- a/docs/variables/Auth0Context.html
+++ b/docs/variables/Auth0Context.html
@@ -1,2 +1,2 @@
 Auth0Context | @auth0/auth0-react@auth0/auth0-react
Preparing search index...
Auth0Context
Variable Auth0ContextConst
Auth0Context: Context<Auth0ContextInterface<User>> = ...
The Auth0 Context
-
Defined in src/auth0-context.tsx:171
Settings
Member VisibilityProtected
Inherited
External
Theme
@auth0/auth0-reactLoading...

+
Defined in src/auth0-context.tsx:221
Settings
Member VisibilityProtected
Inherited
External
Theme
@auth0/auth0-reactLoading...

diff --git a/package-lock.json b/package-lock.json
index 1ed60ce7..a011eee2 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
   "name": "@auth0/auth0-react",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@auth0/auth0-react",
-      "version": "2.4.0",
+      "version": "2.5.0",
       "license": "MIT",
       "dependencies": {
         "@auth0/auth0-spa-js": "^2.4.1"
diff --git a/package.json b/package.json
index 1f0b471a..53be7cc5 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
   "author": "Auth0",
   "name": "@auth0/auth0-react",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Auth0 SDK for React Single Page Applications (SPA)",
   "keywords": [
     "auth0",

v8.42.0

8.42.0 (2025-09-02)

🚀 Features

🩹 Fixes

❤️ Thank You

v8.41.0

8.41.0 (2025-08-25)

🚀 Features

❤️ Thank You

v8.40.0

8.40.0 (2025-08-18)

🩹 Fixes

❤️ Thank You

v8.39.1

8.39.1 (2025-08-11)

8.42.0 (2025-09-02)

8.41.0 (2025-08-25)

8.40.0 (2025-08-18)

8.39.1 (2025-08-11)

8.39.0 (2025-08-04)

🚀 Features

❤️ Thank You

8.38.0 (2025-07-21)

v4.0.4 - 2025-07-16

Commits

v4.0.3 - 2025-06-05

Fixed

Commits

v4.0.2 - 2025-02-14

Merged

Fixed

Commits

v15.4.7

Core Changes

Credits

v15.4.6

Core Changes

Credits

v15.4.5

Core Changes

Credits

v15.4.4

Core Changes

Class AuthenticationError

Hierarchy (View Summary)

Index

Constructors

Hierarchy (View Summary)

Index

Constructors

Properties

Class GenericError

Hierarchy (View Summary)

Index

Constructors

Hierarchy (View Summary)

Index

Constructors

Properties

Class MfaRequiredError

Hierarchy (View Summary)

Index

Constructors

Hierarchy (View Summary)

Index

Constructors

Properties

Class MissingRefreshTokenError

Hierarchy (View Summary)

Index

Constructors

Hierarchy (View Summary)

Index

Constructors

Properties

Class OAuthError

Hierarchy

Index

Constructors

Hierarchy

`Optional`error_description

`Optional`stack

`Static` `Optional`prepareStackTrace

`Optional`error_description

`Optional`stack

`Static` `Optional`prepareStackTrace

`Static`stackTraceLimit

`Static`captureStackTrace