From a953afa028ee22e2092f2f770e4a4eb1a9b4f9e0 Mon Sep 17 00:00:00 2001 From: Yogesh Chaudhary Date: Fri, 22 May 2026 18:25:47 +0530 Subject: [PATCH] Release v2.17.0 --- .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/ConnectError.html | 2 +- docs/classes/GenericError.html | 2 +- docs/classes/MfaChallengeError.html | 2 +- docs/classes/MfaEnrollmentError.html | 2 +- docs/classes/MfaEnrollmentFactorsError.html | 2 +- docs/classes/MfaError.html | 2 +- docs/classes/MfaListAuthenticatorsError.html | 2 +- docs/classes/MfaRequiredError.html | 2 +- docs/classes/MfaVerifyError.html | 2 +- docs/classes/MissingRefreshTokenError.html | 2 +- docs/classes/OAuthError.html | 4 +- docs/classes/PopupCancelledError.html | 2 +- docs/classes/PopupOpenError.html | 2 +- docs/classes/PopupTimeoutError.html | 2 +- docs/classes/TimeoutError.html | 2 +- docs/classes/UseDpopNonceError.html | 2 +- docs/classes/User.html | 7 +-- 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/ActClaim.html | 7 +++ docs/interfaces/Auth0ContextInterface.html | 47 ++++++++++++------- docs/interfaces/EnrollEmailParams.html | 2 +- docs/interfaces/EnrollOtpParams.html | 2 +- docs/interfaces/EnrollPushParams.html | 2 +- docs/interfaces/EnrollSmsParams.html | 2 +- docs/interfaces/EnrollVoiceParams.html | 2 +- docs/interfaces/GetTokenWithPopupOptions.html | 2 +- docs/interfaces/IdToken.html | 8 +++- docs/interfaces/LogoutOptions.html | 2 +- docs/interfaces/PopupLoginOptions.html | 2 +- docs/interfaces/RedirectLoginOptions.html | 2 +- docs/interfaces/WithAuth0Props.html | 4 +- .../WithAuthenticationRequiredOptions.html | 12 ++--- docs/modules.html | 2 +- docs/types/AppState.html | 4 +- docs/types/Auth0ProviderOptions.html | 2 +- .../types/Auth0ProviderWithClientOptions.html | 2 +- .../types/Auth0ProviderWithConfigOptions.html | 2 +- docs/types/ConnectedAccount.html | 2 +- docs/types/CustomTokenExchangeOptions.html | 34 ++++++++++---- docs/variables/Auth0Context.html | 2 +- package.json | 2 +- 51 files changed, 130 insertions(+), 85 deletions(-) create mode 100644 docs/interfaces/ActClaim.html diff --git a/.version b/.version index b71174af..fd595728 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.16.2 \ No newline at end of file +v2.17.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index cbea6192..f03a42e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.17.0](https://github.com/auth0/auth0-react/tree/v2.17.0) (2026-05-22) +[Full Changelog](https://github.com/auth0/auth0-react/compare/v2.16.2...v2.17.0) + +**Added** +- feat: CTE delegation and impersonation support [\#1109](https://github.com/auth0/auth0-react/pull/1109) ([yogeshchoudhary147](https://github.com/yogeshchoudhary147)) + ## [v2.16.2](https://github.com/auth0/auth0-react/tree/v2.16.2) (2026-04-17) [Full Changelog](https://github.com/auth0/auth0-react/compare/v2.16.1...v2.16.2) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index 9e7c18f6..ab497ff5 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJyVlMtu2zAQRf+Fa6YBHyIV7Qr3gQJOU6RpuwiyIOSxRYQmVZJeFIH/vZCNJpRkl/RKgHRH597hDF+Qdy4G1DxWnGJGOab05gkjD2sDbdTOBtS8IEpvhodVW0AN+ub6Xb90G23v+qMEo2dtV6ihlcBo5w1qkLYR/Fq1EK5n+ndd3BqEUWtUCKhBMayuhh9cvRYNHzttVh4sah4pq572GFFWJS4+Q3xwz2B/6dgdCGVmzpUVeNpjxChPLHxZqLaDDPAoujQy42yIzDhLeEvXKvM9Oq82MEYTWv9DHwgQrmfisxaOLwaaIAntQW/B7eJH753/HyjVZRijiJzVh4h12tLbtbqH3zvtYZUFT7X5gJyw6RwvlG3BmALcCXkBkdVTYmlfZ+ICmpjlu+vBlqFelQWcWiSc97vYgY26VcMmZWEn5HliRdLdv9UhaLu5h7WH0B32OT8tZ2oK2JyO7h0LXrdZXqq7ZC2YIJjVHHPCMBcM81rgilS4EhILQrAQdFibSsjE1I8AH3rXf3W2hayzmTjfAkHSm2HhrIU2P8GproAh6PgiKLkALm6vqCWWhGLJJJaCYlnLoZ2ilmP4UoeYTKrzocTOmap8eEmm4a13xmzB5ts8Vxfw2CTvolPGgN3kx2cmLqBNj/YneL3+U4JKlAWc6Sm+9eWTaksP8XRRjr7f/wVIEBU1" \ No newline at end of file +window.hierarchyData = "eJyVlMtu2zAQRf+Fa6aR+RBt7Qr3gQJuU6RpuwiyIOixRYQmVZJeFIH/vbCMppRkl/RKgHRHZ+68XpB3LgbUPHI+w5RSTGj9hJGHjQEVtbMBNS+I0Pr4sHIHqEFfXbfvVm6r7V13kmD0rO0aNYTXGO29QQ3SNoLfSAXhdqJ/08adQRgpI0NADYphfXP8wc1r0PFjq83ag0XNI2Hk6YARYSTJ4iPEB/cM9qeObU8oS+ZSWEFOB4wopUkKn5ZStZABnkTXWqa8t0x5annllDTfovNyC0P0jMz/onsChNuJ+GIKpxdHmqgS2oPegdvH9947/z9QqsswBhYZE73FRVrSzxt5D7/22sM6Cx5r8wYZIeM5XkqrwJgC3Bl5AZGJMbG0rhNxAU1M/N11YMtQr8oCzoInnLf72IKNWsnjJmVhZ+R5IicsnRIdgrbbe9h4CG2/z/lpuRBTwOazwd2x4LXK8lLdNWtBRYXpgmJGCGaCYLbgmBOGuahxTSpci35tuEhP8vcA7zrXfXFWQTaziThfgpqkl2HprAWVn+BUV8AQYngISg7A1eUVFcGCCCw4wUIIPK/6QysqMoSvdIjJpDofStK5EJU3L8jYvPXOmB3YfJmn6gIeH/ldttIYsNv8+EzEBbRxa3+A15vfJahEmefMx138V5cPUpU28XxQjn44/AHvIBUb" \ No newline at end of file diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 6c498a95..f5cf2b99 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJytmcty2yAUht9F66S5tElb7zJukmYmqT12ki46XVB0bDFBoAJK43b67h1JlgTmIgd1GZ+f/wMEhwP59idR8KKSSbIAWXAm4X5TQHKQFEhlySQBVubySI+9yVROk4PkibA0mXw4SDBFUiaTRMn0kMhDeFEgGKLJ34PO+6JUGTBFMFKEs0shuOgRdXuQRw6RyTo53Y825YwBVh6MHo3zvwYGgmCPvx6N879hd5BzsZkinIENMMJxhFuOEV0qLtAaPBRLEke6W6FphigFtgbPhFmSaNIlE5zSHJjv29ua/8C6QlhxIfdB6tJ4sh80yveWSKXtweCQPNpo9gJ+lkRA6icaimjOIwiy2vgpWjySQaQkbL2AlQCZ3fMn8KU7nzKOO6u+hofUxyxvzWHOi7KYIoaBUu+HcIji+lsbzQrv7JjxEYx7kgMvfQnBksSRwpDx/g8SPhW8+MIZ9mVRSxJNcptH+lVL73jKWfXnDVMgVghrpw1pf2qOf0tpQk/Pzt1FhT4hO5adwrLau/9ckN91TTJHAuXSi9rRxQG7o9DofIAcajCyC23ZF+a2qkgYJcDUlLMVWZeinj43ztbFAZvT+DJHhAZm1VKNgfVHf4DVi8agZqoYHFWnGQOalzIbJPWiMahlLgdJnWYM6JETDIMoTRUHuwZVH/dLQoEpupkV1Wp2Iz3aceCvRGXbA3aYvCuOQ9/sXDM00I3jerG3bVr30e3bxOKMb/malyo0P4YidE41wgdBh916UVyv71booiBNqnRidEEcoqkA6zQcGo8tG4G75WvCBmm6Kg62gJQIwGr7RHCBMS9ZcBEEW4zrxOCgXcLQOmzuNoH0pgvi+l7lirqOmwteuCGmJNTfVtm/CbV3wNCsDLYKlpRFsVRIaXlKbYqqutv+vtP2+OP7k7PT3Wp3LvgzSUFYvdx6OTSv8q1G2OzgfQiW+vUs92b3sQJ73mLVmR/9oNaEdwGnw36FZWVRvWKZJaXm3wZHMIxt327IBciSKgsZ0I7uAaRbXw+1iw9+kVIqnjevES84Q2wNni/vV8aPpq+E7atHQ7UVY2m7CVHnOHPhKwhXoHAGotkTuwgjGM+o78oIK/Lc3Ps/I5ZS/RLf0DyyeO7dCjXXFfMfBg3NCMYzmtXF0oIT/5JwiuKZ+jtEj3pGglT5yHynMClvvWm091mVDNebxMycptH5O82olPXN/tjl0cYCzX+1562rfRfcw8A+UEOOttpCfP8HxJUsow==" \ No newline at end of file +window.navigationData = "eJytmcty0zAUht/F65ZeoAWy64S2dKYhmfTCgmEh5JNYU1kyklwaGN6dsR3bUnRxKrNsz6//08U6OlK+/UkUvKhkkixBFpxJuN8UkBwkBVJZMkmAlbk80mNvMpXT5CB5IixNJh8OEkyRlMkkUTI9JPIQXhQIhmjy96DzvihVBkwRjBTh7FIILnpE3R7kkUNksk5O96NNOWOAlQejR+P8r4GBINjjr0fj/G/YDHIuNlOEM7ABRjiOcMsxoneKC7QGD8WSxJFmKzTNEKXA1uCZMEsSTbpkglOaA/Otva35D6wrhBUXch+kLo0n+0GjfG+JVNoeDA7Jo41mL+FnSQSkfqKhiOY8giCrjZ+ixSMZRErC1ktYCZDZPX8CX7rzKeO482o1PKQ+ZnlrDgtelMUUMQyUehfCIYrrb200L7yzY8ZHMO5JDrz0JQRLEkcKQ8b7P0j4VPDiC2fYl0UtSTTJbR7pd4HVlCKS956EKRArhKsTfxs0rU/PzvcuKo6nnFV/3rSmbo5LaUHd9Yo+1zuWnSK+/1yQ33W5s0AC5dKL2tHFAbtT1uh8gBxqMLILbUUZ5raqSBglwNSUsxVZl6KePjfO1sUBm4P+MkeEBmbVUo2B9VVFgNWLxqDmqhgcVacZA1qUMhsk9aIxqLtcDpI6zRjQIycYBlGaKg52DaquJO4IBaboZl5UX7Mb6dGOA38lKtue3cPkXXEc+mbnBqOBbhw3l71t07qPbt8mFmd8y9e8VKH5MRShc6oRPgg67NaL4no9W6GLgjSp0onRBXGIpris03BoPLZsBO6WrwkbpOmqONgSUiIAq+3rwwXGvGTBjyDYYlwnBgftEoa+w+baFEhvuiCu71WuqOu4heCFG2JKQv1tlf1zU3u9DM3KYKtgSVkUdwopLU+pTVFVd9v/77Q9/vj+5Ox0t9pdCP5MUhBWL7deDs2rfKsRNjt4H4Klfj3Lvdl9rMCet1h15kc/qDXhXcDpsF9hWVlUD2RmSan5t8ERDGPbtxtyCbKkykIGtKN7AOnW10Pt4oMrUkrF8+ah4wVniK3Bs/J+Zfxo+krYvno0VFsxlrabEHWOMxe+gnAFCmcgmj2xizCC8Yz6roywIs/Nk8JnxFKqvw80NI8snjtboea6Yv4W0dCMYDyj+bpYWnDi/ySconim/g7Ro56RIFU+Mt8pTMpbbxrtfVYlw/UmMTOnaXT+TjMqZX2zP3Z5tLFA81/teetq3wX3MLAP1JCjrbYQ3/8BDxlK8A==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 4637618c..ef3cdb78 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "eJy1mttu2zgQht+FuVVT82DH9l032wUKFNuiLXYvjKBQJToWqohaHXpAkHdfkDoNxbFKOeqdYXF+/iK/GVISH0mhvpdkf3gkX5MsJnvKtgHJwgdJ9uTdq7o6vS4KVZCA1EVK9iRKw7KU5cvh0vWpekhJ0F0he0Kegk5tTVmvFqmsrIo6qn4td2W3BdIBycNCZpXtbuiQrpjoe5Q+1q+6Vs/q5XMsy6hI8ipRmV+Po4gZvbP1pu9cX1/dqqySP6o3WSWLYxjJ3kDS/VO+RBtOzp11k5HKMhlVr6JI1Vn1b1KdPsg4KWRUzevsqhUKG6HvSXUqBiF8EPB7PGe0kGEl/5JVdJLFXG8m9tjHLmDHRtDPhgtkVcYvkvJFkp1kkVQyvtzOj+gUZvfyk/oqs7m22tiqjV1gdO5lJouwkn/mKn9fKHWcaamLj3OV5238IrY06LIszTB9TFKZVenP2d405LIszXiVg8jiBnU2vld5nT/LoU7FvFVZxuKtyo7JfV2EVlH09haNwpcxpVH7W2Vzi6Q2pCnL2tBlzLyJzQTepmHyUM43lMRm5qIufAFTpzCLU9nV9tswTb+E0deZ1hqRrq5Hg8gCBpNSN5dZlURhUwnnOEvKcBT9G4psUr5VYZxk97PNpX3cb7CVqvvE1IrbuqzUgyHvdVvTZzo1UrpgREbKUCgHqQWmuTd7SWHr7S1Yz3pDF+57ek/LbndSda/qC7w0QQsYeDiGM3tvIhboury8mpeLV/O6nL3dbEOWSXX4UPDWzO8782iBLitWg8mHACjbkf9WozyhjrXz7kSnmLnX94XKUXm7hf8jjK78K0/Bq64xTsbI5PSdtKtNorIP8r86KWQ8MXa/DJr1yKZhubyXq0FhehjO3+FUMX32KDQ1VfUyC5tU2R/yqAppBz/Drsq+GMFwLLi48S4Dz+xBvP0Wls7CNgtZ1UX2ST3DYSNRqUXMsdXuhq6H91Wv8vxjFVbD0lL9zHVBb/+e/e5Exu3bkynBq75x2Dc+szp19s4Ob5mrrJSfdS+TXY5bXtrfaDrxrn4xYUgvzry0hfdbEstiXETaTpEm0yvQVB9mz5wmMnOWVKQ3p/Ez+zUPwb79wsaz+r2dRnR8eVKbj27ndrQOfQuLJPySjvZGk5IbgY9Qr3mss8jctT0ovqJ1aar8CtHrLvlKfe+2BohWf22umFu+JtTdxlh3dwFJslj+IPtH8k0WpV6J9oRd8+sdCcgxkWmsPws0TgISqYcHabiIVVSbn3dts3+kfk2vGzetX65IcFgFXFxvN+LuLjh0weaC+aPTGP4xgZQEB4oFUieQWoGMBAcWsN31zXptBTInkFmBnAQHjvXInUBuBQoSHAQWKJxAYQWuSXBYY4FrJ3BtBW5IcNhggRsncGMF3pwbnBsn8MYK3JLgcIP1uHUCt1bgjgSHLRa4cwJ3NgCahx1KgMsOHcFj6EG5owg/NkBUY0Fx9lyGqA0R1WhQhga7HFEbJKrxoCiD1GWJ2jBRjQhFOaQuT9QGimpMKMoidZmiNlRUo0JRHqnLFbXBohoXiqJFXbaoDRfVyFAUL+ryRW3AmGaGooQxlzBmE8Y0MwwljLmEsVGJMjUKJYwhVcomjGlmGEoYcwljNmFMM8NQwphLGLMJY5oZhhLGXMKYTRjTzDCUMOYSxmzCmKlbKGHMJYzZhDHNDEMJYy5hzCaMaWYYShhzCWM2YVwzw1DCuEsYtwnjmhmOEsZdwrhNGNfMcJQw7hLGRwuhWQlRwjiyFtqEcc0M59gaw13CuE0Y18xwlDDuEsZtwrhmhq/Rnl3CuE0Y18xwlDDuEsZtwvj2/D27hHGbMK6Z4Sie3CWM24QJzQxH8RQuYcImTBjCUDyFS5iwCRPs7GgLlzBhEyY0MwJlW7iEidF2y+y3ULYFsuOyCROaGYGyLVzChE2Y0MwItHoKlzBhEyY0MwLfJ7qEtX+Znfk3WVQyftPs0A8HEuZ52byMeCSf24077x8UHglfk/3j09OwUd8/PoG9ur6m+2pfaw4a7GbQYFt/jf7V4CAlVoOU4LOl+rc/liaQ9FfM+8dDoESB1AVa/WtGMP5g7PhuvqT5gGZeFWDiW+B3daG4eR+Aie+AOPUSnzq3MwivB10/IN3XXcAlUOObRkAwX9nh/NigCBjwvusx5gyMHfebmNG5okFrM0htvJTao0HADUjfJubGX8g+ggYGHtyhn5p9NGhQAhniV1yQEz2DGkgJv3Q7dwZnkASTSf0m8+ypGYAZqITUDzT3vAuQg9j68W+fVgFSgBfqN7fuORMgB0ihfkX13NkQIAqKPvWrIs6xDqAGigj1SzJwDgPogFylfjlmf54C6QXw4H54TB+4AC5BwlG/jBsflgBiIN+oX8IhpxyAHkg25pds3UkFUPDA4DHvwVM1tsYyQBrzI80cXgAKIDWZX2oqg+q4joO78huZcx8TAWbAG/f0Zn/xA1qgbnC/utEpncsCBhKT+SXm6EMVsAeSk/sl5/AlCsjAhU80gdwvi8ozBZfBBdpv4OpSOtt0AWSEH6nN6RLgBNwc86vVOpFdK0BH+M1br5M3ZzqAKTBxzG/iOrEB+qL/JgJcwieH5wpj9ILayDxq411A8iSXaZJJsj/cPT39D0IndvA="; \ No newline at end of file +window.searchData = "eJy1mm2PmzgQx7+L9y3dxg9JNnnX2+tJlapr1VZ3L6JVRcHZoLKYA9IHRfvdTzZPYzyhJqHvouD5zzD+zdiAT6RQ30uy3Z3I1ySLyZayu4Bk4ZMkW/Lu1bE6vC4KVZCAHIuUbEmUhmUpy5f9pdtD9ZSSoL1CtoQ8B63akrJOLVJZWRXHqPq13I09FkgHJA8LmVV2dL1DumCi8yh9Qr9pR13l5XMsy6hI8ipRmZ/HgcUE72y56pzr64t7lVXyR/Umq2SxDyPZBZC0/5Qv0YGjc2fdZKSyTEbVqyhSx6z6N6kOH2ScFDKqpjm7aYTCWuh7Uh2KXghPAn6P5wItZFjJv2QVHWQxNTZju+9s5wjnWFbq6ZP6KrPXP6JDmD1OnJ2bWqHSCrJXmCE0uzr8gnFrpSrjF0n5IskOskgqGV8eTnNzJldTw2psq8Z2huw8ykwWYSX/zFX+vlBqPzGk1j7OVZ439rOEpWtQlqVJ08cklVmV/pwcm64/WZYmX2UvMnuAulG8V/kxvypC3SXyRmWeEO9Vtk8ej0Vo9Wvv2KKB+TxBadT+VtnU/q0D0pRljek8wbyJzQTep2HyVE4PKInNzEWt+QxBHcIsTmW77NyHafoljL5ODK0WaZecqBeZIcCk1MNlViVRWHfCKZElZTiw/g1NNinfqjBOssfJwaWd3W8IK1WPiekV91cvl0ZKN4zftm52wV7S2LrwZuxnXUAXbsm6mObdiaXqUR0viKU2miGAp3040XttMYPr8vJuXs7ezY/l5J1wYzJPqcPnlbdmft+Zpx50WbEGjD6fQNmW/Lca5RF1bJy3E11i5l7fFypH5e0R/k9XuvMvPAVv2sE4GYMgx++kWW0SlX2Q/x2TQsYjuful0aSnSQ3L5V5ueoXxNJy/w7FmenUW6p6qOpmZg1TZH3KvCmkbXxGuyr4YwXAoOHvgbQWe2YN4x1tYOjOHWcjqWGSf1BUR1hKVmiU4ttis6bJ/lfYqzz9WYdUvLdXPXDf05u/Jr3Vk3LzYGRO86QaH3eAzq1Mb3tn0lrnKSvlZexl1ORx5qb/BdOKufjFhiBdnXprG+y2JZTFsIo1TZMj4CjTmw+yZ00RmzpKKeHMGX+nXPAT7+oWDJ/m9H0d0eHlUmw9u536wDn0LiyT8kg72RqOSK4FnqNPcH7PI3LWdFF/RY2m6/ALRay/5Sn1vtwaIVndtqpjbvkbU3cGYu4eAJFksf5DtiXyTRalXoi1ht/x2QwKyT2Qa6y8WdSQBidTTkzRcxCo6mp8PzbB/pP6CoAfXo18uSLBbBHx5u1itHh6CXWtsLpg/Wo3+H2NISbCjmCF1DKllyEiwYwHb3G6Wa8uQOYbMMuQk2HHMI3cMuWUoSLATmKFwDIVluCTBbokZLh3DpWW4IsFuhRmuHMOVZbgmwW6NGa4dw7VleHcuq3eO4Z1luCHB7g7zuHEMNzYAmocNSoDLDh3AY+hBuaMIPzZAVGNBcfZchqgNEdVoUIYauxxRGySq8aAog9RlidowUY0IRTmkLk/UBopqTCjKInWZojZUVKNCUR6pyxW1waIaF4oySV22qA0X1chQFC/q8kVtwJhmhqKEMZcwZhPGNDMMJYy5hLFBizI9CiWMIV3KJoxpZhhKGHMJYzZhTDPDUMKYSxizCWOaGYYSxlzCmE0Y08wwlDDmEsZswphmhqGEMZcwZhPGTO9CCWMuYcwmjGlmGEoYcwljNmFcM8NQwrhLGLcJ45oZjhLGXcK4TRjXzHCUMO4SxgcLoVkJUcI4shbahHHNDMfXUZcwbhPGNTNcYOsMdwnjNmFcM8NRwrhLGLcJ45oZvkI9u4RxmzCumeEoYdwljNuE8c35e3YJ4zZhQjPDUTyFS5iwCROGMBRP4RImbMKEZkageAqXMGETJvjZbAuXMDHYbpn9Fsq2QHZcNmFCMyNQtoVLmLAJE5oZgbItXMKETZjQzAh8n+gSJmzChGZGoGwLl7DmL7Ot/yaLSsZv6u39bkfCPC/rNxkn8rnZ9fNl+5RxInxFtqfn536Xvz09g42+vqZ9Ne9Ee43+FNOJsI2/RvdesZcStJcSYrJU9+rI0gSS/op592wJlBiQWk7X6t5RgvyD3InFdEnz9c28Z8DEN0CcXihuXiYg4mIBxJmX+Nh5pF4YEOmXY/ddGUjBCvC9rgUE95Xtz8X1ioBQv5QimHOQO+6pYp+X6rXADfrVL/qxttdb93prL73mnBLoB6Ad1DZ3/kL2UT2QMpAxPzX7nFKvBCrOr1khx4t6NVBi1K9+z50IAogBPKgfHmcP8QBVSK5fwbrHb4AcmGbqNyX24RkgBSaX+vVo99gLkAMdn/q1kHNHVYAoaEvUr9CcUyZADVQt9SszcCwE6IBqpX5VZn8tAwUG8OB+eIyf/wBRgpKjfjU3PLsBxEDFMb+KQw5dgG4Fio35FVt7cAKIgOQx7+SpI7ZqM0Aa8yPNnKUACrAD+5WmMqgOOzlIjV+mz33bBJiB2LhnbPYHSKAFFwW/vtEqnasCBgqT+RXm4LsZCA8UJ/crzv7DGJAB7Ywva0PuV0XlmYbLQOKYX+KOpXQ2/gLICD9S68MuIBJwc8yvV+tCdkOBu3y/eet08vqICQgKTBzzm7hWrIe+6D7RgChBaYtrhTF6QW/kHhX7EJA8yWWaZJJsdw/Pz/8DKTrbBQ=="; \ No newline at end of file diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index f97d0d86..a0eab8ee 100644 --- a/docs/classes/AuthenticationError.html +++ b/docs/classes/AuthenticationError.html @@ -1,6 +1,6 @@ AuthenticationError | @auth0/auth0-react
@auth0/auth0-react
    Preparing search index...

    Class AuthenticationError

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

    -

    Hierarchy (View Summary)

    Index

    Constructors

    constructor +

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    appState error error_description diff --git a/docs/classes/ConnectError.html b/docs/classes/ConnectError.html index 37d94323..a5c0f293 100644 --- a/docs/classes/ConnectError.html +++ b/docs/classes/ConnectError.html @@ -1,6 +1,6 @@ ConnectError | @auth0/auth0-react
    @auth0/auth0-react
      Preparing search index...

      Class ConnectError

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

      -

      Hierarchy (View Summary)

      Index

      Constructors

      constructor +

      Hierarchy (View Summary)

      Index

      Constructors

      constructor

      Properties

      appState connection error diff --git a/docs/classes/GenericError.html b/docs/classes/GenericError.html index 25667ab5..cbabf28f 100644 --- a/docs/classes/GenericError.html +++ b/docs/classes/GenericError.html @@ -1,5 +1,5 @@ GenericError | @auth0/auth0-react
      @auth0/auth0-react
        Preparing search index...

        Class GenericError

        Thrown when network requests to the Auth server fail.

        -

        Hierarchy (View Summary)

        Index

        Constructors

        constructor +

        Hierarchy (View Summary)

        Index

        Constructors

        constructor

        Properties

        error error_description message diff --git a/docs/classes/MfaChallengeError.html b/docs/classes/MfaChallengeError.html index cffa0f6c..87502aa9 100644 --- a/docs/classes/MfaChallengeError.html +++ b/docs/classes/MfaChallengeError.html @@ -2,7 +2,7 @@ 
        try {
          const challenge = await mfa.challenge({
            mfaToken: mfaToken,
            challengeType: 'otp',
            authenticatorId: 'otp|dev_123'
          });
        } catch (error) {
          if (error instanceof MfaChallengeError) {
            console.log(error.error); // 'too_many_attempts'
            console.log(error.error_description); // 'Rate limit exceeded'
          }
        }
        -

        Hierarchy (View Summary)

        Index

        Constructors

        constructor +

        Hierarchy (View Summary)

        Index

        Constructors

        constructor

        Properties

        error error_description message diff --git a/docs/classes/MfaEnrollmentError.html b/docs/classes/MfaEnrollmentError.html index ac293d1e..87ef6f15 100644 --- a/docs/classes/MfaEnrollmentError.html +++ b/docs/classes/MfaEnrollmentError.html @@ -2,7 +2,7 @@ 
        try {
          const enrollment = await mfa.enroll({
            authenticator_types: ['otp']
          });
        } catch (error) {
          if (error instanceof MfaEnrollmentError) {
            console.log(error.error); // 'invalid_phone_number'
            console.log(error.error_description); // 'Invalid phone number format'
          }
        }
        -

        Hierarchy (View Summary)

        Index

        Constructors

        constructor +

        Hierarchy (View Summary)

        Index

        Constructors

        constructor

        Properties

        error error_description message diff --git a/docs/classes/MfaEnrollmentFactorsError.html b/docs/classes/MfaEnrollmentFactorsError.html index 5f44b2b0..d48e4f6c 100644 --- a/docs/classes/MfaEnrollmentFactorsError.html +++ b/docs/classes/MfaEnrollmentFactorsError.html @@ -2,7 +2,7 @@ 
        try {
          const factors = await mfa.getEnrollmentFactors(mfaToken);
        } catch (error) {
          if (error instanceof MfaEnrollmentFactorsError) {
            console.log(error.error); // 'mfa_context_not_found'
            console.log(error.error_description); // 'MFA context not found...'
          }
        }
        -

        Hierarchy (View Summary)

        Index

        Constructors

        constructor +

        Hierarchy (View Summary)

        Index

        Constructors

        constructor

        Properties

        error error_description message diff --git a/docs/classes/MfaError.html b/docs/classes/MfaError.html index d76e85c8..7a3733e4 100644 --- a/docs/classes/MfaError.html +++ b/docs/classes/MfaError.html @@ -1,6 +1,6 @@ MfaError | @auth0/auth0-react
        @auth0/auth0-react
          Preparing search index...

          Class MfaError

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

          -

          Hierarchy (View Summary)

          Index

          Constructors

          constructor +

          Hierarchy (View Summary)

          Index

          Constructors

          constructor

          Properties

          error error_description message diff --git a/docs/classes/MfaListAuthenticatorsError.html b/docs/classes/MfaListAuthenticatorsError.html index 7cfe3809..bebad1f4 100644 --- a/docs/classes/MfaListAuthenticatorsError.html +++ b/docs/classes/MfaListAuthenticatorsError.html @@ -2,7 +2,7 @@ 
          try {
            const authenticators = await mfa.getAuthenticators();
          } catch (error) {
            if (error instanceof MfaListAuthenticatorsError) {
              console.log(error.error); // 'access_denied'
              console.log(error.error_description); // 'Unauthorized'
            }
          }
          -

          Hierarchy (View Summary)

          Index

          Constructors

          constructor +

          Hierarchy (View Summary)

          Index

          Constructors

          constructor

          Properties

          error error_description message diff --git a/docs/classes/MfaRequiredError.html b/docs/classes/MfaRequiredError.html index 219afc78..eeb6644d 100644 --- a/docs/classes/MfaRequiredError.html +++ b/docs/classes/MfaRequiredError.html @@ -1,5 +1,5 @@ MfaRequiredError | @auth0/auth0-react
          @auth0/auth0-react
            Preparing search index...

            Class MfaRequiredError

            Error thrown when the token exchange results in a mfa_required error

            -

            Hierarchy (View Summary)

            Index

            Constructors

            constructor +

            Hierarchy (View Summary)

            Index

            Constructors

            constructor

            Properties

            error error_description message diff --git a/docs/classes/MfaVerifyError.html b/docs/classes/MfaVerifyError.html index de20e40f..c3ab2b85 100644 --- a/docs/classes/MfaVerifyError.html +++ b/docs/classes/MfaVerifyError.html @@ -2,7 +2,7 @@ 
            try {
              const tokens = await mfa.verify({
                mfaToken: mfaToken,
                grant_type: 'http://auth0.com/oauth/grant-type/mfa-otp',
                otp: '123456'
              });
            } catch (error) {
              if (error instanceof MfaVerifyError) {
                console.log(error.error); // 'invalid_otp' or 'context_not_found'
                console.log(error.error_description); // Error details
              }
            }
            -

            Hierarchy (View Summary)

            Index

            Constructors

            constructor +

            Hierarchy (View Summary)

            Index

            Constructors

            constructor

            Properties

            error error_description message diff --git a/docs/classes/MissingRefreshTokenError.html b/docs/classes/MissingRefreshTokenError.html index a732e480..a54b0922 100644 --- a/docs/classes/MissingRefreshTokenError.html +++ b/docs/classes/MissingRefreshTokenError.html @@ -1,5 +1,5 @@ MissingRefreshTokenError | @auth0/auth0-react
            @auth0/auth0-react
              Preparing search index...

              Class MissingRefreshTokenError

              Error thrown when there is no refresh token to use

              -

              Hierarchy (View Summary)

              Index

              Constructors

              constructor +

              Hierarchy (View Summary)

              Index

              Constructors

              constructor

              Properties

              audience error error_description diff --git a/docs/classes/OAuthError.html b/docs/classes/OAuthError.html index 71ee6d12..bbbe6457 100644 --- a/docs/classes/OAuthError.html +++ b/docs/classes/OAuthError.html @@ -1,7 +1,7 @@ OAuthError | @auth0/auth0-react
              @auth0/auth0-react
                Preparing search index...

                Class OAuthError

                An OAuth2 error will come from the authorization server and will have at least an error property which will be the error code. And possibly an error_description property

                See: https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.3.1.2.6

                -

                Hierarchy

                • Error
                  • OAuthError
                Index

                Constructors

                constructor +

                Hierarchy

                • Error
                  • OAuthError
                Index

                Constructors

                constructor

                Properties

                error error_description? message @@ -10,7 +10,7 @@ stackTraceLimit

                Methods

                captureStackTrace prepareStackTrace -

                Constructors

                • Parameters

                  • error: string
                  • Optionalerror_description: string

                  Returns OAuthError

                Properties

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

                The Error.stackTraceLimit property specifies the number of stack frames +

                Constructors

                • Parameters

                  • error: string
                  • Optionalerror_description: string

                  Returns OAuthError

                Properties

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

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

                The default value is 10 but may be set to any valid JavaScript number. Changes diff --git a/docs/classes/PopupCancelledError.html b/docs/classes/PopupCancelledError.html index b67cafea..62c043c1 100644 --- a/docs/classes/PopupCancelledError.html +++ b/docs/classes/PopupCancelledError.html @@ -1,5 +1,5 @@ PopupCancelledError | @auth0/auth0-react

                @auth0/auth0-react
                  Preparing search index...

                  Class PopupCancelledError

                  Thrown when network requests to the Auth server fail.

                  -

                  Hierarchy (View Summary)

                  Index

                  Constructors

                  constructor +

                  Hierarchy (View Summary)

                  Index

                  Constructors

                  constructor

                  Properties

                  error error_description message diff --git a/docs/classes/PopupOpenError.html b/docs/classes/PopupOpenError.html index acb1273e..a7ae7b11 100644 --- a/docs/classes/PopupOpenError.html +++ b/docs/classes/PopupOpenError.html @@ -1,5 +1,5 @@ PopupOpenError | @auth0/auth0-react
                  @auth0/auth0-react
                    Preparing search index...

                    Class PopupOpenError

                    Thrown when network requests to the Auth server fail.

                    -

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor +

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor

                    Properties

                    error error_description message diff --git a/docs/classes/PopupTimeoutError.html b/docs/classes/PopupTimeoutError.html index 6ba2ef98..fcafbfef 100644 --- a/docs/classes/PopupTimeoutError.html +++ b/docs/classes/PopupTimeoutError.html @@ -1,5 +1,5 @@ PopupTimeoutError | @auth0/auth0-react
                    @auth0/auth0-react
                      Preparing search index...

                      Class PopupTimeoutError

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

                      -

                      Hierarchy (View Summary)

                      Index

                      Constructors

                      constructor +

                      Hierarchy (View Summary)

                      Index

                      Constructors

                      constructor

                      Properties

                      error error_description message diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html index de62f5c1..4a1778ff 100644 --- a/docs/classes/TimeoutError.html +++ b/docs/classes/TimeoutError.html @@ -1,6 +1,6 @@ TimeoutError | @auth0/auth0-react
                      @auth0/auth0-react
                        Preparing search index...

                        Class TimeoutError

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

                        -

                        Hierarchy (View Summary)

                        Index

                        Constructors

                        constructor +

                        Hierarchy (View Summary)

                        Index

                        Constructors

                        constructor

                        Properties

                        error error_description message diff --git a/docs/classes/UseDpopNonceError.html b/docs/classes/UseDpopNonceError.html index 4c145284..043d595e 100644 --- a/docs/classes/UseDpopNonceError.html +++ b/docs/classes/UseDpopNonceError.html @@ -1,5 +1,5 @@ UseDpopNonceError | @auth0/auth0-react
                        @auth0/auth0-react
                          Preparing search index...

                          Class UseDpopNonceError

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

                          -

                          Hierarchy (View Summary)

                          Index

                          Constructors

                          constructor +

                          Hierarchy (View Summary)

                          Index

                          Constructors

                          constructor

                          Properties

                          error error_description message diff --git a/docs/classes/User.html b/docs/classes/User.html index 9f5c711c..dc706deb 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -1,5 +1,6 @@ -User | @auth0/auth0-react
                          @auth0/auth0-react
                            Preparing search index...

                            Class User

                            Indexable

                            • [key: string]: any
                            Index

                            Constructors

                            constructor -

                            Properties

                            address? +User | @auth0/auth0-react
                            @auth0/auth0-react
                              Preparing search index...

                              Class User

                              Indexable

                              • [key: string]: any
                              Index

                              Constructors

                              constructor +

                              Properties

                              act? +address? birthdate? email? email_verified? @@ -19,4 +20,4 @@ updated_at? website? zoneinfo? -

                              Constructors

                              Properties

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

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Properties
                              +

                              Constructors

                              Properties

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

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Properties
                              diff --git a/docs/functions/Auth0Provider.html b/docs/functions/Auth0Provider.html index 66a9e188..34e39bf0 100644 --- a/docs/functions/Auth0Provider.html +++ b/docs/functions/Auth0Provider.html @@ -2,4 +2,4 @@

                              Provides the Auth0Context to its child components.

                              -

                              Type Parameters

                              Parameters

                              Returns Element

                              Settings

                              Member Visibility
                              +

                              Type Parameters

                              Parameters

                              Returns Element

                              Settings

                              Member Visibility
                              diff --git a/docs/functions/useAuth0.html b/docs/functions/useAuth0.html index 35e4b839..296ba294 100644 --- a/docs/functions/useAuth0.html +++ b/docs/functions/useAuth0.html @@ -3,4 +3,4 @@

                              Use the useAuth0 hook in your components to access the auth state and methods.

                              TUser is an optional type param to provide a type to the user field.

                              -

                              Type Parameters

                              Parameters

                              Returns Auth0ContextInterface<TUser>

                              Settings

                              Member Visibility
                              +

                              Type Parameters

                              Parameters

                              Returns Auth0ContextInterface<TUser>

                              Settings

                              Member Visibility
                              diff --git a/docs/functions/withAuth0.html b/docs/functions/withAuth0.html index 3099a34e..ec2a9f35 100644 --- a/docs/functions/withAuth0.html +++ b/docs/functions/withAuth0.html @@ -4,4 +4,4 @@

                              Wrap your class components in this Higher Order Component to give them access to the Auth0Context.

                              Providing a context as the second argument allows you to configure the Auth0Provider the Auth0Context should come from f you have multiple within your application.

                              -

                              Type Parameters

                              Parameters

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

                              Settings

                              Member Visibility
                              +

                              Type Parameters

                              Parameters

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

                              Settings

                              Member Visibility
                              diff --git a/docs/functions/withAuthenticationRequired.html b/docs/functions/withAuthenticationRequired.html index 52314b5c..6d2da429 100644 --- a/docs/functions/withAuthenticationRequired.html +++ b/docs/functions/withAuthenticationRequired.html @@ -3,4 +3,4 @@

                              When you wrap your components in this Higher Order Component and an anonymous user visits your component they will be redirected to the login page; after login they will be returned to the page they were redirected from.

                              -

                              Type Parameters

                              • P extends object

                              Parameters

                              Returns FC<P>

                              Settings

                              Member Visibility
                              +

                              Type Parameters

                              • P extends object

                              Parameters

                              Returns FC<P>

                              Settings

                              Member Visibility
                              diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 0b13870d..d1cf91f8 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -@auth0/auth0-react
                              @auth0/auth0-react
                                Preparing search index...

                                @auth0/auth0-react

                                Hierarchy Summary

                                Settings

                                Member Visibility
                                +@auth0/auth0-react
                                @auth0/auth0-react
                                  Preparing search index...

                                  @auth0/auth0-react

                                  Hierarchy Summary

                                  Settings

                                  Member Visibility
                                  diff --git a/docs/interfaces/ActClaim.html b/docs/interfaces/ActClaim.html new file mode 100644 index 00000000..5bf51018 --- /dev/null +++ b/docs/interfaces/ActClaim.html @@ -0,0 +1,7 @@ +ActClaim | @auth0/auth0-react
                                  @auth0/auth0-react
                                    Preparing search index...

                                    Interface ActClaim

                                    Represents the actor claim (act) in an ID token returned via a token exchange response.

                                    +

                                    The act claim identifies the acting party — the entity that has been delegated authority +to act on behalf of the subject. It is set via Auth0 Actions using the setActor command.

                                    +

                                    RFC 8693 Section 4.1

                                    +
                                    interface ActClaim {
                                        sub?: string;
                                        [key: string]: any;
                                    }

                                    Indexable

                                    • [key: string]: any
                                    Index

                                    Properties

                                    sub? +

                                    Properties

                                    sub?: string

                                    The identifier of the acting party.

                                    +

                                    Settings

                                    Member Visibility

                                    On This Page

                                    Properties
                                    diff --git a/docs/interfaces/Auth0ContextInterface.html b/docs/interfaces/Auth0ContextInterface.html index 0c3b4d30..9e4223f5 100644 --- a/docs/interfaces/Auth0ContextInterface.html +++ b/docs/interfaces/Auth0ContextInterface.html @@ -1,6 +1,7 @@ Auth0ContextInterface | @auth0/auth0-react
                                    @auth0/auth0-react
                                      Preparing search index...

                                      Interface Auth0ContextInterface<TUser>

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

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

                                      Type Parameters

                                      Hierarchy

                                      • AuthState<TUser>
                                        • Auth0ContextInterface
                                      Index

                                      Properties

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

                                      Type Parameters

                                      Hierarchy

                                      • AuthState<TUser>
                                        • Auth0ContextInterface
                                      Index

                                      Properties

                                      connectAccountWithRedirect createFetcher +customTokenExchange error exchangeToken generateDpopProof @@ -27,7 +28,7 @@ where the user can authenticate and authorize the account to be connected.

                                      If connecting the account is successful onRedirectCallback will be called with the details of the connected account.

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

                                      Returns a new Fetcher class that will contain a fetchWithAuth() method. +

                                      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.

                                      @@ -37,7 +38,19 @@ 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

                                      Returns Fetcher<TOutput>

                                      error: Error | undefined
                                      exchangeToken: (
                                          options: CustomTokenExchangeOptions,
                                      ) => Promise<TokenEndpointResponse>

                                      Type Declaration

                                      customTokenExchange: (
                                          options: CustomTokenExchangeOptions,
                                      ) => Promise<TokenEndpointResponse>
                                      const tokenResponse = await customTokenExchange({
                                        subject_token: 'ey...',
                                        subject_token_type: 'urn:acme:legacy-system-token',
                                        actor_token: 'ey...',
                                        actor_token_type: 'https://idp.example.com/token-type/agent',
                                      });
+
                                      + +

                                      Exchanges an external subject token for Auth0 tokens without affecting the current session.

                                      +

                                      Unlike loginWithCustomTokenExchange, this method has no side effects — it does not cache +tokens, does not update the authenticated session, and does not affect isAuthenticated +or user. Use this for delegation or impersonation scenarios where you need a downstream +API token without changing who the current user is.

                                      +

                                      When actor_token is present Auth0 suppresses refresh token issuance; a missing +refresh_token in the response is expected and will not cause an error.

                                      +

                                      Type Declaration

                                      error: Error | undefined
                                      exchangeToken: (
                                          options: CustomTokenExchangeOptions,
                                      ) => Promise<TokenEndpointResponse>

                                      Type Declaration

                                      Use loginWithCustomTokenExchange() instead. This method will be removed in the next major version.

                                      const tokenResponse = await exchangeToken({
                                        subject_token: 'external_token_value',
                                        subject_token_type: 'urn:acme:legacy-system-token',
                                        scope: 'openid profile email'
                                      });
@@ -51,13 +64,13 @@
 
                                      // Instead of:
                                      const tokens = await exchangeToken(options);

                                      // Use:
                                      const tokens = await loginWithCustomTokenExchange(options);
 
                                      
 
-
                                      generateDpopProof: (
                                          params: {
                                              accessToken: string;
                                              method: string;
                                              nonce?: string;
                                              url: string;
                                          },
                                      ) => Promise<string>

                                      Returns a string to be used to demonstrate possession of the private +

                                      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: {
                                          (
                                              options: GetTokenSilentlyOptions & { detailedResponse: true },
                                          ): Promise<GetTokenSilentlyVerboseResponse>;
                                          (options?: GetTokenSilentlyOptions): Promise<string>;
                                          (
                                              options: GetTokenSilentlyOptions,
                                          ): Promise<string | GetTokenSilentlyVerboseResponse>;
                                      }
                                      const token = await getAccessTokenSilently(options);
+

                                      Parameters

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

                                      Returns Promise<string>

                                      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 @@ -76,7 +89,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: (
                                          options?: GetTokenWithPopupOptions,
                                          config?: PopupConfigOptions,
                                      ) => Promise<string | undefined>
                                      const token = await getTokenWithPopup(options, config);
+
                                      getAccessTokenWithPopup: (
                                          options?: GetTokenWithPopupOptions,
                                          config?: PopupConfigOptions,
                                      ) => Promise<string | undefined>
                                      const token = await getTokenWithPopup(options, config);

                                      Get an access token interactively.

                                      @@ -84,7 +97,7 @@ 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.

                                      -
                                      getConfiguration: () => Readonly<ClientConfiguration>
                                      const config = getConfiguration();
                                      // { domain: 'tenant.auth0.com', clientId: 'abc123' }
+
                                      getConfiguration: () => Readonly<ClientConfiguration>
                                      const config = getConfiguration();
                                      // { domain: 'tenant.auth0.com', clientId: 'abc123' }

                                      Returns a readonly copy of the initialization configuration @@ -94,7 +107,7 @@ 

                                      const auth0 = new Auth0Client({
                                        domain: 'tenant.auth0.com',
                                        clientId: 'abc123'
                                      });

                                      const config = auth0.getConfiguration();
                                      // { domain: 'tenant.auth0.com', clientId: 'abc123' }
                                      -
                                      getDpopNonce: (id?: string) => Promise<string | undefined>

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

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

                                      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.

                                      @@ -109,16 +122,16 @@

                                      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: () => Promise<IdToken | undefined>
                                      const claims = await getIdTokenClaims();
+
                                      getIdTokenClaims: () => Promise<IdToken | undefined>
                                      const claims = await getIdTokenClaims();

                                      Returns all claims from the id_token if available.

                                      -
                                      handleRedirectCallback: (
                                          url?: string,
                                      ) => Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>

                                      After the browser redirects back to the callback page, +

                                      handleRedirectCallback: (
                                          url?: string,
                                      ) => Promise<ConnectAccountRedirectResult | 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<ConnectAccountRedirectResult | RedirectLoginResult<any>>

                                        • Parameters

                                          • Optionalurl: string

                                            The URL to that should be used to retrieve the state and code values. Defaults to window.location.href if not given.

                                            -

                                          Returns Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>

                                      isAuthenticated: boolean
                                      isLoading: boolean
                                      loginWithCustomTokenExchange: (
                                          options: CustomTokenExchangeOptions,
                                      ) => Promise<TokenEndpointResponse>
                                      await loginWithCustomTokenExchange(options);
+

                                      Returns Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>

                                      isAuthenticated: boolean
                                      isLoading: boolean
                                      loginWithCustomTokenExchange: (
                                          options: CustomTokenExchangeOptions,
                                      ) => Promise<TokenEndpointResponse>
                                      await loginWithCustomTokenExchange(options);

                                      Exchanges an external subject token for Auth0 tokens and logs the user in. @@ -142,7 +155,7 @@ 

                                      const options = {
                                        subject_token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...',
                                        subject_token_type: 'urn:acme:legacy-system-token',
                                        scope: 'openid profile email',
                                        audience: 'https://api.example.com',
                                        organization: 'org_12345'
                                      };

                                      try {
                                        const tokenResponse = await loginWithCustomTokenExchange(options);
                                        console.log('Access token:', tokenResponse.access_token);

                                        // User is now logged in - access user info
                                        const user = await getUser();
                                        console.log('Logged in user:', user);
                                      } catch (error) {
                                        console.error('Token exchange failed:', error);
                                      }
                                      -
                                      loginWithPopup: (
                                          options?: PopupLoginOptions,
                                          config?: PopupConfigOptions,
                                      ) => Promise<void>
                                      await loginWithPopup(options, config);
+
                                      loginWithPopup: (
                                          options?: PopupLoginOptions,
                                          config?: PopupConfigOptions,
                                      ) => Promise<void>
                                      await loginWithPopup(options, config);

                                      Opens a popup with the /authorize URL using the parameters @@ -152,20 +165,20 @@

                                      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: (options?: RedirectLoginOptions<AppState>) => Promise<void>
                                      await loginWithRedirect(options);
+
                                      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: (options?: LogoutOptions) => Promise<void>
                                      auth0.logout({ logoutParams: { returnTo: window.location.origin } });
+
                                      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.

                                      -
                                      mfa: MfaApiClient
                                      const { mfa } = useAuth0();
                                      const authenticators = await mfa.getAuthenticators(mfaToken);
+
                                      mfa: MfaApiClient
                                      const { mfa } = useAuth0();
                                      const authenticators = await mfa.getAuthenticators(mfaToken);

                                      MFA API client for Multi-Factor Authentication operations.

                                      @@ -180,7 +193,7 @@ 
                                      const { mfa, getAccessTokenSilently } = useAuth0();

                                      try {
                                        await getAccessTokenSilently();
                                      } catch (error) {
                                        if (error.error === 'mfa_required') {
                                          // Check if enrollment is needed
                                          const factors = await mfa.getEnrollmentFactors(error.mfa_token);

                                          if (factors.length > 0) {
                                            // Enroll in OTP
                                            const enrollment = await mfa.enroll({
                                              mfaToken: error.mfa_token,
                                              factorType: 'otp'
                                            });
                                            console.log('QR Code:', enrollment.barcodeUri);
                                          }

                                          // Get authenticators and challenge
                                          const authenticators = await mfa.getAuthenticators(error.mfa_token);
                                          await mfa.challenge({
                                            mfaToken: error.mfa_token,
                                            challengeType: 'otp',
                                            authenticatorId: authenticators[0].id
                                          });

                                          // Verify with user's code
                                          const tokens = await mfa.verify({
                                            mfaToken: error.mfa_token,
                                            otp: userCode
                                          });
                                        }
                                      }
                                      -
                                      setDpopNonce: (nonce: string, id?: string) => Promise<void>

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

                                      +
                                      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.

                                          @@ -192,4 +205,4 @@

                                          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.

                                          -
                                      user: TUser | undefined

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Properties
                                      +
                                      user: TUser | undefined

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Properties
                                      diff --git a/docs/interfaces/EnrollEmailParams.html b/docs/interfaces/EnrollEmailParams.html index 29a890f4..82cafe4f 100644 --- a/docs/interfaces/EnrollEmailParams.html +++ b/docs/interfaces/EnrollEmailParams.html @@ -1,5 +1,5 @@ EnrollEmailParams | @auth0/auth0-react
                                      @auth0/auth0-react
                                        Preparing search index...

                                        Interface EnrollEmailParams

                                        Email enrollment parameters

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

                                        Hierarchy

                                        • EnrollBaseParams
                                          • EnrollEmailParams
                                        Index

                                        Properties

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

                                        Hierarchy

                                        • EnrollBaseParams
                                          • EnrollEmailParams
                                        Index

                                        Properties

                                        email? factorType mfaToken

                                        Properties

                                        email?: string

                                        Email address (optional, uses user's email if not provided)

                                        diff --git a/docs/interfaces/EnrollOtpParams.html b/docs/interfaces/EnrollOtpParams.html index 0236a64c..559ce36e 100644 --- a/docs/interfaces/EnrollOtpParams.html +++ b/docs/interfaces/EnrollOtpParams.html @@ -1,5 +1,5 @@ EnrollOtpParams | @auth0/auth0-react
                                        @auth0/auth0-react
                                          Preparing search index...

                                          Interface EnrollOtpParams

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

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

                                          Hierarchy

                                          • EnrollBaseParams
                                            • EnrollOtpParams
                                          Index

                                          Properties

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

                                          Hierarchy

                                          • EnrollBaseParams
                                            • EnrollOtpParams
                                          Index

                                          Properties

                                          factorType mfaToken

                                          Properties

                                          factorType: "otp"

                                          The factor type for enrollment

                                          mfaToken: string

                                          MFA token from mfa_required error

                                          diff --git a/docs/interfaces/EnrollPushParams.html b/docs/interfaces/EnrollPushParams.html index cde6fa41..6a1b93f1 100644 --- a/docs/interfaces/EnrollPushParams.html +++ b/docs/interfaces/EnrollPushParams.html @@ -1,5 +1,5 @@ EnrollPushParams | @auth0/auth0-react
                                          @auth0/auth0-react
                                            Preparing search index...

                                            Interface EnrollPushParams

                                            Push notification enrollment parameters

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

                                            Hierarchy

                                            • EnrollBaseParams
                                              • EnrollPushParams
                                            Index

                                            Properties

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

                                            Hierarchy

                                            • EnrollBaseParams
                                              • EnrollPushParams
                                            Index

                                            Properties

                                            factorType mfaToken

                                            Properties

                                            factorType: "push"

                                            The factor type for enrollment

                                            mfaToken: string

                                            MFA token from mfa_required error

                                            diff --git a/docs/interfaces/EnrollSmsParams.html b/docs/interfaces/EnrollSmsParams.html index 220269da..7836af72 100644 --- a/docs/interfaces/EnrollSmsParams.html +++ b/docs/interfaces/EnrollSmsParams.html @@ -1,5 +1,5 @@ EnrollSmsParams | @auth0/auth0-react
                                            @auth0/auth0-react
                                              Preparing search index...

                                              Interface EnrollSmsParams

                                              SMS enrollment parameters

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

                                              Hierarchy

                                              • EnrollBaseParams
                                                • EnrollSmsParams
                                              Index

                                              Properties

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

                                              Hierarchy

                                              • EnrollBaseParams
                                                • EnrollSmsParams
                                              Index

                                              Properties

                                              factorType mfaToken phoneNumber

                                              Properties

                                              factorType: "sms"

                                              The factor type for enrollment

                                              diff --git a/docs/interfaces/EnrollVoiceParams.html b/docs/interfaces/EnrollVoiceParams.html index 9f0fab02..4b673f1f 100644 --- a/docs/interfaces/EnrollVoiceParams.html +++ b/docs/interfaces/EnrollVoiceParams.html @@ -1,5 +1,5 @@ EnrollVoiceParams | @auth0/auth0-react
                                              @auth0/auth0-react
                                                Preparing search index...

                                                Interface EnrollVoiceParams

                                                Voice enrollment parameters

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

                                                Hierarchy

                                                • EnrollBaseParams
                                                  • EnrollVoiceParams
                                                Index

                                                Properties

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

                                                Hierarchy

                                                • EnrollBaseParams
                                                  • EnrollVoiceParams
                                                Index

                                                Properties

                                                factorType mfaToken phoneNumber

                                                Properties

                                                factorType: "voice"

                                                The factor type for enrollment

                                                diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index 36200771..47b70cb2 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -1,4 +1,4 @@ -GetTokenWithPopupOptions | @auth0/auth0-react
                                                @auth0/auth0-react
                                                  Preparing search index...

                                                  Interface GetTokenWithPopupOptions

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

                                                  Hierarchy (View Summary)

                                                  Index

                                                  Properties

                                                  authorizationParams? +GetTokenWithPopupOptions | @auth0/auth0-react
                                                  @auth0/auth0-react
                                                    Preparing search index...

                                                    Interface GetTokenWithPopupOptions

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

                                                    Hierarchy (View Summary)

                                                    Index

                                                    Properties

                                                    authorizationParams? cacheMode?

                                                    Properties

                                                    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.

                                                    diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html index deea3a65..84bc3c5b 100644 --- a/docs/interfaces/IdToken.html +++ b/docs/interfaces/IdToken.html @@ -1,5 +1,6 @@ -IdToken | @auth0/auth0-react
                                                    @auth0/auth0-react
                                                      Preparing search index...

                                                      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
                                                      Index

                                                      Properties

                                                      __raw +IdToken | @auth0/auth0-react
                                                      @auth0/auth0-react
                                                        Preparing search index...

                                                        Interface IdToken

                                                        interface IdToken {
                                                            __raw: string;
                                                            acr?: string;
                                                            act?: ActClaim;
                                                            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
                                                        Index

                                                        Properties

                                                        __raw acr? +act? address? amr? at_hash? @@ -36,4 +37,7 @@ updated_at? website? zoneinfo? -

                                                        Properties

                                                        __raw

                                                        __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

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Properties
                                                        +

                                                        Properties

                                                        __raw

                                                        __raw: string
                                                        acr?: string
                                                        act?: ActClaim

                                                        The actor claim, present in ID tokens returned via token exchange responses. +Identifies the acting party that has been delegated authority to act on behalf +of the subject. Set via Auth0 Actions using the setActor command.

                                                        +
                                                        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

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Properties
                                                        diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index fce48025..a6e7729f 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -1,4 +1,4 @@ -LogoutOptions | @auth0/auth0-react
                                                        @auth0/auth0-react
                                                          Preparing search index...

                                                          Interface LogoutOptions

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

                                                          Hierarchy

                                                          • Omit<SPALogoutOptions, "onRedirect">
                                                            • LogoutOptions
                                                          Index

                                                          Properties

                                                          clientId? +LogoutOptions | @auth0/auth0-react
                                                          @auth0/auth0-react
                                                            Preparing search index...

                                                            Interface LogoutOptions

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

                                                            Hierarchy

                                                            • Omit<SPALogoutOptions, "onRedirect">
                                                              • LogoutOptions
                                                            Index

                                                            Properties

                                                            clientId? logoutParams? openUrl?

                                                            Properties

                                                            clientId?: string | null

                                                            The clientId of your application.

                                                            diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 38620661..0c637b9c 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...

                                                              Interface PopupLoginOptions

                                                              interface PopupLoginOptions {
                                                                  authorizationParams?: AuthorizationParams;
                                                              }

                                                              Hierarchy (View Summary)

                                                              Index

                                                              Properties

                                                              authorizationParams? +PopupLoginOptions | @auth0/auth0-react
                                                              @auth0/auth0-react
                                                                Preparing search index...

                                                                Interface PopupLoginOptions

                                                                interface PopupLoginOptions {
                                                                    authorizationParams?: AuthorizationParams;
                                                                }

                                                                Hierarchy (View Summary)

                                                                Index

                                                                Properties

                                                                authorizationParams?

                                                                Properties

                                                                authorizationParams?: AuthorizationParams

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

                                                                Settings

                                                                Member Visibility

                                                                On This Page

                                                                Properties
                                                                diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index 66d993b0..7c212d03 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -1,4 +1,4 @@ -RedirectLoginOptions | @auth0/auth0-react
                                                                @auth0/auth0-react
                                                                  Preparing search index...

                                                                  Interface RedirectLoginOptions<TAppState>

                                                                  interface RedirectLoginOptions<TAppState = AppState> {
                                                                      appState?: TAppState;
                                                                      authorizationParams?: AuthorizationParams;
                                                                      fragment?: string;
                                                                      openUrl?: (url: string) => void | Promise<void>;
                                                                  }

                                                                  Type Parameters

                                                                  Hierarchy

                                                                  • Omit<SPARedirectLoginOptions<TAppState>, "onRedirect">
                                                                    • RedirectLoginOptions
                                                                  Index

                                                                  Properties

                                                                  appState? +RedirectLoginOptions | @auth0/auth0-react
                                                                  @auth0/auth0-react
                                                                    Preparing search index...

                                                                    Interface RedirectLoginOptions<TAppState>

                                                                    interface RedirectLoginOptions<TAppState = AppState> {
                                                                        appState?: TAppState;
                                                                        authorizationParams?: AuthorizationParams;
                                                                        fragment?: string;
                                                                        openUrl?: (url: string) => void | Promise<void>;
                                                                    }

                                                                    Type Parameters

                                                                    Hierarchy

                                                                    • Omit<SPARedirectLoginOptions<TAppState>, "onRedirect">
                                                                      • RedirectLoginOptions
                                                                    Index

                                                                    Properties

                                                                    appState? authorizationParams? fragment? openUrl? diff --git a/docs/interfaces/WithAuth0Props.html b/docs/interfaces/WithAuth0Props.html index 482dd7c2..d6677531 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...

                                                                      Interface WithAuth0Props

                                                                      Components wrapped in withAuth0 will have an additional auth0 prop

                                                                      -
                                                                      interface WithAuth0Props {
                                                                          auth0: Auth0ContextInterface;
                                                                      }
                                                                      Index

                                                                      Properties

                                                                      auth0 -

                                                                      Properties

                                                                      auth0: Auth0ContextInterface

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Properties
                                                                      +
                                                                      interface WithAuth0Props {
                                                                          auth0: Auth0ContextInterface;
                                                                      }
                                                                      Index

                                                                      Properties

                                                                      auth0 +

                                                                      Properties

                                                                      auth0: Auth0ContextInterface

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Properties
                                                                      diff --git a/docs/interfaces/WithAuthenticationRequiredOptions.html b/docs/interfaces/WithAuthenticationRequiredOptions.html index 22992a9a..14f494df 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...

                                                                        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);
                                                                        }
                                                                        Index

                                                                        Properties

                                                                        context? +
                                                                        interface WithAuthenticationRequiredOptions {
                                                                            context?: Context<Auth0ContextInterface<User>>;
                                                                            loginOptions?: RedirectLoginOptions<AppState>;
                                                                            onBeforeAuthentication?: () => Promise<void>;
                                                                            onRedirecting?: () => Element;
                                                                            returnTo?: string | (() => string);
                                                                        }
                                                                        Index

                                                                        Properties

                                                                        context? loginOptions? onBeforeAuthentication? onRedirecting? @@ -7,20 +7,20 @@

                                                                        Properties

                                                                        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.

                                                                        -
                                                                        loginOptions?: RedirectLoginOptions<AppState>
                                                                        withAuthenticationRequired(Profile, {
                                                                          loginOptions: {
                                                                            appState: {
                                                                              customProp: 'foo'
                                                                            }
                                                                          }
                                                                        })
+
                                                                        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.

                                                                        -
                                                                        onBeforeAuthentication?: () => Promise<void>
                                                                        withAuthenticationRequired(Profile, {
                                                                          onBeforeAuthentication: () => { analyticsLibrary.track('login_triggered'); }
                                                                        })
+
                                                                        onBeforeAuthentication?: () => Promise<void>
                                                                        withAuthenticationRequired(Profile, {
                                                                          onBeforeAuthentication: () => { analyticsLibrary.track('login_triggered'); }
                                                                        })

                                                                        Allows executing logic before the user is redirected to the login page.

                                                                        -
                                                                        onRedirecting?: () => Element
                                                                        withAuthenticationRequired(Profile, {
                                                                          onRedirecting: () => <div>Redirecting you to the login...</div>
                                                                        })
+
                                                                        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.

                                                                        -
                                                                        returnTo?: string | (() => string)
                                                                        withAuthenticationRequired(Profile, {
                                                                          returnTo: '/profile'
                                                                        })
+
                                                                        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.

                                                                        -

                                                                        Settings

                                                                        Member Visibility

                                                                        On This Page

                                                                        Properties
                                                                        +

                                                                        Settings

                                                                        Member Visibility

                                                                        On This Page

                                                                        Properties
                                                                        diff --git a/docs/modules.html b/docs/modules.html index 71dda503..6f4a601e 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1 @@ -@auth0/auth0-react
                                                                        @auth0/auth0-react
                                                                          Preparing search index...

                                                                            @auth0/auth0-react

                                                                            Main

                                                                            ClientConfiguration

                                                                            Other

                                                                            ResponseType
                                                                            AuthenticationError
                                                                            ConnectError
                                                                            GenericError
                                                                            InMemoryCache
                                                                            LocalStorageCache
                                                                            MfaChallengeError
                                                                            MfaEnrollmentError
                                                                            MfaEnrollmentFactorsError
                                                                            MfaError
                                                                            MfaListAuthenticatorsError
                                                                            MfaRequiredError
                                                                            MfaVerifyError
                                                                            MissingRefreshTokenError
                                                                            OAuthError
                                                                            PopupCancelledError
                                                                            PopupOpenError
                                                                            PopupTimeoutError
                                                                            TimeoutError
                                                                            UseDpopNonceError
                                                                            User
                                                                            Auth0ContextInterface
                                                                            Authenticator
                                                                            AuthorizationParams
                                                                            ChallengeAuthenticatorParams
                                                                            ChallengeResponse
                                                                            EnrollEmailParams
                                                                            EnrollmentFactor
                                                                            EnrollOtpParams
                                                                            EnrollPushParams
                                                                            EnrollSmsParams
                                                                            EnrollVoiceParams
                                                                            GetTokenSilentlyOptions
                                                                            GetTokenWithPopupOptions
                                                                            ICache
                                                                            IdToken
                                                                            LogoutOptions
                                                                            LogoutUrlOptions
                                                                            MfaApiClient
                                                                            PopupConfigOptions
                                                                            PopupLoginOptions
                                                                            RedirectConnectAccountOptions
                                                                            RedirectLoginOptions
                                                                            VerifyParams
                                                                            WithAuth0Props
                                                                            WithAuthenticationRequiredOptions
                                                                            AppState
                                                                            Auth0ProviderOptions
                                                                            Auth0ProviderWithClientOptions
                                                                            Auth0ProviderWithConfigOptions
                                                                            Cacheable
                                                                            CacheLocation
                                                                            ConnectAccountRedirectResult
                                                                            ConnectedAccount
                                                                            CustomTokenExchangeOptions
                                                                            EnrollmentResponse
                                                                            EnrollParams
                                                                            FetcherConfig
                                                                            InteractiveErrorHandler
                                                                            MfaFactorType
                                                                            TokenEndpointResponse
                                                                            Auth0Context
                                                                            Auth0Provider
                                                                            useAuth0
                                                                            withAuth0
                                                                            withAuthenticationRequired

                                                                            Settings

                                                                            Member Visibility

                                                                            On This Page

                                                                            Main
                                                                            Other
                                                                            ResponseTypeAuthenticationErrorConnectErrorGenericErrorInMemoryCacheLocalStorageCacheMfaChallengeErrorMfaEnrollmentErrorMfaEnrollmentFactorsErrorMfaErrorMfaListAuthenticatorsErrorMfaRequiredErrorMfaVerifyErrorMissingRefreshTokenErrorOAuthErrorPopupCancelledErrorPopupOpenErrorPopupTimeoutErrorTimeoutErrorUseDpopNonceErrorUserAuth0ContextInterfaceAuthenticatorAuthorizationParamsChallengeAuthenticatorParamsChallengeResponseEnrollEmailParamsEnrollmentFactorEnrollOtpParamsEnrollPushParamsEnrollSmsParamsEnrollVoiceParamsGetTokenSilentlyOptionsGetTokenWithPopupOptionsICacheIdTokenLogoutOptionsLogoutUrlOptionsMfaApiClientPopupConfigOptionsPopupLoginOptionsRedirectConnectAccountOptionsRedirectLoginOptionsVerifyParamsWithAuth0PropsWithAuthenticationRequiredOptionsAppStateAuth0ProviderOptionsAuth0ProviderWithClientOptionsAuth0ProviderWithConfigOptionsCacheableCacheLocationConnectAccountRedirectResultConnectedAccountCustomTokenExchangeOptionsEnrollmentResponseEnrollParamsFetcherConfigInteractiveErrorHandlerMfaFactorTypeTokenEndpointResponseAuth0ContextAuth0ProvideruseAuth0withAuth0withAuthenticationRequired
                                                                            +@auth0/auth0-react
                                                                            @auth0/auth0-react
                                                                              Preparing search index...

                                                                                @auth0/auth0-react

                                                                                Main

                                                                                ClientConfiguration

                                                                                Other

                                                                                ResponseType
                                                                                AuthenticationError
                                                                                ConnectError
                                                                                GenericError
                                                                                InMemoryCache
                                                                                LocalStorageCache
                                                                                MfaChallengeError
                                                                                MfaEnrollmentError
                                                                                MfaEnrollmentFactorsError
                                                                                MfaError
                                                                                MfaListAuthenticatorsError
                                                                                MfaRequiredError
                                                                                MfaVerifyError
                                                                                MissingRefreshTokenError
                                                                                OAuthError
                                                                                PopupCancelledError
                                                                                PopupOpenError
                                                                                PopupTimeoutError
                                                                                TimeoutError
                                                                                UseDpopNonceError
                                                                                User
                                                                                ActClaim
                                                                                Auth0ContextInterface
                                                                                Authenticator
                                                                                AuthorizationParams
                                                                                ChallengeAuthenticatorParams
                                                                                ChallengeResponse
                                                                                EnrollEmailParams
                                                                                EnrollmentFactor
                                                                                EnrollOtpParams
                                                                                EnrollPushParams
                                                                                EnrollSmsParams
                                                                                EnrollVoiceParams
                                                                                GetTokenSilentlyOptions
                                                                                GetTokenWithPopupOptions
                                                                                ICache
                                                                                IdToken
                                                                                LogoutOptions
                                                                                LogoutUrlOptions
                                                                                MfaApiClient
                                                                                PopupConfigOptions
                                                                                PopupLoginOptions
                                                                                RedirectConnectAccountOptions
                                                                                RedirectLoginOptions
                                                                                VerifyParams
                                                                                WithAuth0Props
                                                                                WithAuthenticationRequiredOptions
                                                                                AppState
                                                                                Auth0ProviderOptions
                                                                                Auth0ProviderWithClientOptions
                                                                                Auth0ProviderWithConfigOptions
                                                                                Cacheable
                                                                                CacheLocation
                                                                                ConnectAccountRedirectResult
                                                                                ConnectedAccount
                                                                                CustomTokenExchangeOptions
                                                                                EnrollmentResponse
                                                                                EnrollParams
                                                                                FetcherConfig
                                                                                InteractiveErrorHandler
                                                                                MfaFactorType
                                                                                TokenEndpointResponse
                                                                                Auth0Context
                                                                                Auth0Provider
                                                                                useAuth0
                                                                                withAuth0
                                                                                withAuthenticationRequired

                                                                                Settings

                                                                                Member Visibility

                                                                                On This Page

                                                                                Main
                                                                                Other
                                                                                ResponseTypeAuthenticationErrorConnectErrorGenericErrorInMemoryCacheLocalStorageCacheMfaChallengeErrorMfaEnrollmentErrorMfaEnrollmentFactorsErrorMfaErrorMfaListAuthenticatorsErrorMfaRequiredErrorMfaVerifyErrorMissingRefreshTokenErrorOAuthErrorPopupCancelledErrorPopupOpenErrorPopupTimeoutErrorTimeoutErrorUseDpopNonceErrorUserActClaimAuth0ContextInterfaceAuthenticatorAuthorizationParamsChallengeAuthenticatorParamsChallengeResponseEnrollEmailParamsEnrollmentFactorEnrollOtpParamsEnrollPushParamsEnrollSmsParamsEnrollVoiceParamsGetTokenSilentlyOptionsGetTokenWithPopupOptionsICacheIdTokenLogoutOptionsLogoutUrlOptionsMfaApiClientPopupConfigOptionsPopupLoginOptionsRedirectConnectAccountOptionsRedirectLoginOptionsVerifyParamsWithAuth0PropsWithAuthenticationRequiredOptionsAppStateAuth0ProviderOptionsAuth0ProviderWithClientOptionsAuth0ProviderWithConfigOptionsCacheableCacheLocationConnectAccountRedirectResultConnectedAccountCustomTokenExchangeOptionsEnrollmentResponseEnrollParamsFetcherConfigInteractiveErrorHandlerMfaFactorTypeTokenEndpointResponseAuth0ContextAuth0ProvideruseAuth0withAuth0withAuthenticationRequired
                                                                                diff --git a/docs/types/AppState.html b/docs/types/AppState.html index 40b0ecaa..169a90f0 100644 --- a/docs/types/AppState.html +++ b/docs/types/AppState.html @@ -1,6 +1,6 @@ AppState | @auth0/auth0-react
                                                                                @auth0/auth0-react
                                                                                  Preparing search index...

                                                                                  Type Alias AppState

                                                                                  The state of the application before the user was redirected to the login page and any account that the user may have connected to.

                                                                                  -
                                                                                  type AppState = {
                                                                                      connectedAccount?: ConnectedAccount;
                                                                                      response_type?: ResponseType;
                                                                                      returnTo?: string;
                                                                                      [key: string]: any;
                                                                                  }

                                                                                  Indexable

                                                                                  • [key: string]: any
                                                                                  Index

                                                                                  Properties

                                                                                  connectedAccount? +
                                                                                  type AppState = {
                                                                                      connectedAccount?: ConnectedAccount;
                                                                                      response_type?: ResponseType;
                                                                                      returnTo?: string;
                                                                                      [key: string]: any;
                                                                                  }

                                                                                  Indexable

                                                                                  • [key: string]: any
                                                                                  Index

                                                                                  Properties

                                                                                  connectedAccount? response_type? returnTo? -

                                                                                  Properties

                                                                                  connectedAccount?: ConnectedAccount
                                                                                  response_type?: ResponseType
                                                                                  returnTo?: string

                                                                                  Settings

                                                                                  Member Visibility

                                                                                  On This Page

                                                                                  Properties
                                                                                  +

                                                                                  Properties

                                                                                  connectedAccount?: ConnectedAccount
                                                                                  response_type?: ResponseType
                                                                                  returnTo?: string

                                                                                  Settings

                                                                                  Member Visibility

                                                                                  On This Page

                                                                                  Properties
                                                                                  diff --git a/docs/types/Auth0ProviderOptions.html b/docs/types/Auth0ProviderOptions.html index ea534dd2..6875ebe4 100644 --- a/docs/types/Auth0ProviderOptions.html +++ b/docs/types/Auth0ProviderOptions.html @@ -1,4 +1,4 @@ Auth0ProviderOptions | @auth0/auth0-react
                                                                                  @auth0/auth0-react
                                                                                    Preparing search index...

                                                                                    Type Alias Auth0ProviderOptions<TUser>

                                                                                    Auth0ProviderOptions:
                                                                                        | Auth0ProviderWithConfigOptions<TUser>
                                                                                        | Auth0ProviderWithClientOptions<TUser>

                                                                                    The main configuration to instantiate the Auth0Provider.

                                                                                    Either provide domain and clientId (Auth0ProviderWithConfigOptions) or a pre-configured client instance (Auth0ProviderWithClientOptions).

                                                                                    -

                                                                                    Type Parameters

                                                                                    Settings

                                                                                    Member Visibility
                                                                                    +

                                                                                    Type Parameters

                                                                                    Settings

                                                                                    Member Visibility
                                                                                    diff --git a/docs/types/Auth0ProviderWithClientOptions.html b/docs/types/Auth0ProviderWithClientOptions.html index 1ba4feeb..ddc88535 100644 --- a/docs/types/Auth0ProviderWithClientOptions.html +++ b/docs/types/Auth0ProviderWithClientOptions.html @@ -1,2 +1,2 @@ Auth0ProviderWithClientOptions | @auth0/auth0-react
                                                                                    @auth0/auth0-react
                                                                                      Preparing search index...

                                                                                      Type Alias Auth0ProviderWithClientOptions<TUser>

                                                                                      Auth0ProviderWithClientOptions: Auth0ProviderBaseOptions<TUser> & {
                                                                                          client: Auth0Client;
                                                                                      }

                                                                                      Options for Auth0Provider when supplying a pre-configured Auth0Client instance.

                                                                                      -

                                                                                      Type Parameters

                                                                                      Settings

                                                                                      Member Visibility
                                                                                      +

                                                                                      Type Parameters

                                                                                      Settings

                                                                                      Member Visibility
                                                                                      diff --git a/docs/types/Auth0ProviderWithConfigOptions.html b/docs/types/Auth0ProviderWithConfigOptions.html index c3333032..7f5ca19e 100644 --- a/docs/types/Auth0ProviderWithConfigOptions.html +++ b/docs/types/Auth0ProviderWithConfigOptions.html @@ -1,3 +1,3 @@ Auth0ProviderWithConfigOptions | @auth0/auth0-react
                                                                                      @auth0/auth0-react
                                                                                        Preparing search index...

                                                                                        Type Alias Auth0ProviderWithConfigOptions<TUser>

                                                                                        Auth0ProviderWithConfigOptions: Auth0ProviderBaseOptions<TUser> & Auth0ClientOptions & {
                                                                                            client?: never;
                                                                                        }

                                                                                        Options for Auth0Provider when configuring Auth0 via domain and clientId. Use this type when building wrapper components around Auth0Provider.

                                                                                        -

                                                                                        Type Parameters

                                                                                        Settings

                                                                                        Member Visibility
                                                                                        +

                                                                                        Type Parameters

                                                                                        Settings

                                                                                        Member Visibility
                                                                                        diff --git a/docs/types/ConnectedAccount.html b/docs/types/ConnectedAccount.html index a504b484..e335ff73 100644 --- a/docs/types/ConnectedAccount.html +++ b/docs/types/ConnectedAccount.html @@ -1,2 +1,2 @@ ConnectedAccount | @auth0/auth0-react
                                                                                        @auth0/auth0-react
                                                                                          Preparing search index...

                                                                                          Type Alias ConnectedAccount

                                                                                          ConnectedAccount: Omit<
                                                                                              ConnectAccountRedirectResult,
                                                                                              "appState"
                                                                                              | "response_type",
                                                                                          >

                                                                                          The account that has been connected during the connect flow.

                                                                                          -

                                                                                          Settings

                                                                                          Member Visibility
                                                                                          +

                                                                                          Settings

                                                                                          Member Visibility
                                                                                          diff --git a/docs/types/CustomTokenExchangeOptions.html b/docs/types/CustomTokenExchangeOptions.html index e9ca84e7..27fb6ef8 100644 --- a/docs/types/CustomTokenExchangeOptions.html +++ b/docs/types/CustomTokenExchangeOptions.html @@ -1,28 +1,42 @@ CustomTokenExchangeOptions | @auth0/auth0-react
                                                                                          @auth0/auth0-react
                                                                                            Preparing search index...

                                                                                            Type Alias CustomTokenExchangeOptions

                                                                                            Represents the configuration options required for initiating a Custom Token Exchange request following RFC 8693 specifications.

                                                                                            RFC 8693: OAuth 2.0 Token Exchange

                                                                                            -
                                                                                            type CustomTokenExchangeOptions = {
                                                                                                audience?: string;
                                                                                                organization?: string;
                                                                                                scope?: string;
                                                                                                subject_token: string;
                                                                                                subject_token_type: string;
                                                                                                [key: string]: unknown;
                                                                                            }

                                                                                            Indexable

                                                                                            • [key: string]: unknown

                                                                                              Additional custom parameters for Auth0 Action processing

                                                                                              +
                                                                                            type CustomTokenExchangeOptions = {
                                                                                                actor_token?: string;
                                                                                                actor_token_type?: string;
                                                                                                audience?: string;
                                                                                                organization?: string;
                                                                                                scope?: string;
                                                                                                subject_token: string;
                                                                                                subject_token_type: string;
                                                                                                [key: string]: unknown;
                                                                                            }

                                                                                            Indexable

                                                                                            • [key: string]: unknown

                                                                                              Additional custom parameters for Auth0 Action processing

                                                                                              Accessible in Action code via event.request.body

                                                                                              {
                                                                                                custom_parameter: "session_context",
                                                                                                device_fingerprint: "a3d8f7...",
                                                                                              }
                                                                                              -
                                                                                            Index

                                                                                            Properties

                                                                                            audience? +
                                                                                            Index

                                                                                            Properties

                                                                                            actor_token? +actor_token_type? +audience? organization? scope? subject_token subject_token_type -

                                                                                            Properties

                                                                                            audience?: string

                                                                                            The target audience for the requested Auth0 token

                                                                                            -

                                                                                            Must match exactly with an API identifier configured in your Auth0 tenant. +

                                                                                            Properties

                                                                                            actor_token?: string

                                                                                            A token representing the acting party for delegation or impersonation scenarios.

                                                                                            +

                                                                                            Used when one principal needs to act on behalf of another. +For example, an AI agent acting on behalf of a user.

                                                                                            +
                                                                                            "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
+
                                                                                            + +
                                                                                            actor_token_type?: string

                                                                                            The type identifier for the actor token.

                                                                                            +

                                                                                            Must be a URI under your organization's control, following the same +rules as subject_token_type.

                                                                                            +
                                                                                            "https://idp.example.com/token-type/agent"
+
                                                                                            + +
                                                                                            audience?: string

                                                                                            The target audience for the requested Auth0 token

                                                                                            +

                                                                                            Must match exactly with an API identifier configured in your Auth0 tenant. If not provided, falls back to the client's default audience.

                                                                                            -
                                                                                            "https://api.your-service.com/v1"
+
                                                                                            "https://api.your-service.com/v1"
                                                                                            organization?: string

                                                                                            ID or name of the organization to use when authenticating a user. When provided, the user will be authenticated using the organization context. The organization ID will be present in the access token payload.

                                                                                            scope?: string

                                                                                            Space-separated list of OAuth 2.0 scopes being requested

                                                                                            -

                                                                                            Subject to API authorization policies configured in Auth0

                                                                                            -
                                                                                            "openid profile email read:data write:data"
+

                                                                                            Subject to API authorization policies configured in Auth0

                                                                                            +
                                                                                            "openid profile email read:data write:data"
                                                                                            subject_token: string

                                                                                            The opaque token value being exchanged for Auth0 tokens

                                                                                            @@ -31,7 +45,7 @@
                                                                                          • Implement replay attack protection
                                                                                          • Recommended validation libraries: jose, jsonwebtoken
                                                                                            • -
                                                                                            "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+
                                                                                            "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
                                                                                            subject_token_type: string

                                                                                            The type identifier for the subject token being exchanged

                                                                                            @@ -45,7 +59,7 @@ -
                                                                                            "urn:acme:legacy-system-token"
                                                                                            "https://api.yourcompany.com/token-type/v1"
+
                                                                                            "urn:acme:legacy-system-token"
                                                                                            "https://api.yourcompany.com/token-type/v1"
                                                                                            -

                                                                                            Settings

                                                                                            Member Visibility

                                                                                            On This Page

                                                                                            Properties
                                                                                            +

                                                                                            Settings

                                                                                            Member Visibility

                                                                                            On This Page

                                                                                            Properties
                                                                                            diff --git a/docs/variables/Auth0Context.html b/docs/variables/Auth0Context.html index 74dc97be..158fa5bb 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...

                                                                                              Variable Auth0ContextConst

                                                                                              Auth0Context: Context<Auth0ContextInterface<User>> = ...

                                                                                              The Auth0 Context

                                                                                              -

                                                                                              Settings

                                                                                              Member Visibility
                                                                                              +

                                                                                              Settings

                                                                                              Member Visibility
                                                                                              diff --git a/package.json b/package.json index 48f06057..c539618b 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "author": "Auth0", "name": "@auth0/auth0-react", - "version": "2.16.2", + "version": "2.17.0", "description": "Auth0 SDK for React Single Page Applications (SPA)", "keywords": [ "auth0",