From 32510ea8dcd78f18707b9794fda0430b257bfccc Mon Sep 17 00:00:00 2001 From: Yogesh Chaudhary Date: Thu, 5 Feb 2026 17:35:22 +0530 Subject: [PATCH] Release v2.13.0 --- .version | 2 +- CHANGELOG.md | 6 ++ docs/assets/hierarchy.js | 2 +- docs/assets/search.js | 2 +- docs/classes/AuthenticationError.html | 6 +- docs/classes/ConnectError.html | 6 +- docs/classes/GenericError.html | 6 +- docs/classes/MfaRequiredError.html | 7 +- docs/classes/MissingRefreshTokenError.html | 6 +- docs/classes/OAuthError.html | 4 +- docs/classes/PopupCancelledError.html | 6 +- docs/classes/PopupTimeoutError.html | 6 +- docs/classes/TimeoutError.html | 6 +- docs/classes/UseDpopNonceError.html | 6 +- docs/functions/Auth0Provider.html | 2 +- docs/functions/useAuth0.html | 4 +- docs/functions/withAuth0.html | 2 +- .../functions/withAuthenticationRequired.html | 2 +- docs/hierarchy.html | 2 +- docs/interfaces/Auth0ContextInterface.html | 76 ++++++++++++------- docs/interfaces/Auth0ProviderOptions.html | 10 +-- docs/interfaces/GetTokenWithPopupOptions.html | 2 +- docs/interfaces/LogoutOptions.html | 2 +- docs/interfaces/PopupLoginOptions.html | 2 +- docs/interfaces/RedirectLoginOptions.html | 2 +- docs/interfaces/WithAuth0Props.html | 4 +- .../WithAuthenticationRequiredOptions.html | 12 +-- docs/types/AppState.html | 4 +- docs/types/ConnectedAccount.html | 2 +- docs/variables/Auth0Context.html | 2 +- package-lock.json | 4 +- package.json | 2 +- 32 files changed, 118 insertions(+), 89 deletions(-) diff --git a/.version b/.version index a5db00c8..311f78b6 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.12.0 \ No newline at end of file +v2.13.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 004cf95c..53da4384 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.13.0](https://github.com/auth0/auth0-react/tree/v2.13.0) (2026-02-05) +[Full Changelog](https://github.com/auth0/auth0-react/compare/v2.12.0...v2.13.0) + +**Added** +- feat: add loginWithCustomTokenExchange and deprecate exchangeToken [\#1010](https://github.com/auth0/auth0-react/pull/1010) ([yogeshchoudhary147](https://github.com/yogeshchoudhary147)) + ## [v2.12.0](https://github.com/auth0/auth0-react/tree/v2.12.0) (2026-01-28) [Full Changelog](https://github.com/auth0/auth0-react/compare/v2.11.0...v2.12.0) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index 9ea380ca..ce9b904a 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJyVlMtuwjAQRf9l1qaQ2I5CdhWtqkr0oT7UBWJhmYFYBDu1nRXi36uAWhkCdVhFcu7k3OuZyRasMd5BMeOMEsoYSdl4TsDiskLpldEOii2kbNw+tNggFPBq6qaempXSL/VBQmCt9AKKlGcEGltBAUp7tEsh0Q07+pvSbyogICvhHBTg3WLQfmDwV9S+LFW1sKihmKWcz3cEUs4DFw/oP8wa9Zfy5Z7Qz8ylsh6edgQoY4GFx4mQJUaAB9G1kWlG28g0owFvaqSo3r2xYoXH6CTNf9F7ArphR3zRwuGgpeVJQPtQGzSNv7fW2P9AoS7COIrI+LiNyEZhV5+W4g2/G2VxEQWfauMBGaWnczwRWmJV9cCdkfcg8s7m9L3XjrgHLQ/v8rbxJWqvpGgnPMo7I48TeXLUPeWc0qs3XFp05X7P4l28UNODzejR/0CjVTLKC3XXjCvNE8JGnDBKCcs54QknPBuTLE3aMeZZ2OhPh3e1qZ+Nlhh11BHHo2dpuKkTozXK+ESFuhhjt/sBUIgHAQ==" \ No newline at end of file +window.hierarchyData = "eJyVlMtuwyAQRf9l1vRhDMT1rkqrqlJfSlt1EWWByCRGccAFvIry75UTtSKv4qws2Wd85sLACpy1wUM55pySnGeEcjEh4HBWowraGg/lCigX3cPIJUIJb7Zpmyc71+a12SIEFtpMoaRcEGhdDSVoE9DNpEJ/dcBfVmFZAwFVS++hhOCnF90PLv6Kuo+VrqcODZRjKuhkTYAKGnXxgOHDLtB86VBtDP2aOVXWo6c1gZxnUQuPQ6kqTAi30LmR88F1FzkfXEe+J6tk/R6sk3PcVWe0+FVvDOivDuCTLWxfdLaiiGwfeom2DffOWfefKOYSjp2ITBRdRJbFu/o8kyP8brXDaVK8z6YDMkb353gojcK67qE7gvcwimLf2HddD+AethsW2W7bUKEJWsluwpO+I3jayGlsfNbeazMf4cyhrzbnLL2LJ2p6uPnufWDQaZX0xdw545oXBWEZJYxRwm4Y4ZQRPiiIyDcnlQ/ijf70eNfY5sUahcmODuB0dJHH98LQGoMqPVExl3Ks1z8U3wb7" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 178be51b..c7eca539 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "eJy1mt1u2zgQhd+FuVVTc0jbse+62V2gQLEttsXuhREUqsTEQhRJK8lpiyDvvqB+h+JIoRz1LrA4h4fkN0NG4hPL0+8F2x+e2H2UhGzP4cpjif+g2J59fHcqj3/keZozj53ymO1ZEPtFoYq3/aPLY/kQM699wvaMPXut2ppDpxakSVHmp6B8We7CbIukPZb5uUpK013fIV+B7HpULtYv2lav6uVrqIogj7IyShO3HgcRM3qH9abrXD9fXadJqX6U75NS5bd+oDoDUftL8ZZsOLl2xiCDNElUUL4LgvSUlP9G5fFvFUa5Csp5nV00Qn4t9D0qj3kvRE8CPcYxo7nyS/WnKoOjyud6q2Jvu9gF7JgIutmwgSyL8E1UvImSo8qjUoXn2/kRHP3kTn1J71Uy11YTWzaxC8zOnUpU7pfq9yzNPuVpejvTUhsfZmmWNfGL2NKgq6KopulzFKukjH/O9qYhV0VRzVfRiyxuUGfjpzQ7Za9yqFMxa1SWsXidJrfR3Sn3jaLo7C0YhC9jSqP2V5rMLZLakKYsaUKXMfM+rBbwOvajh2K+oSisVi5owxcwdfSTMFZtbb/24/ibH9zPtFaLtHU96EUWMBgVurlKyijw60o4x1lU+IPoX1Bko+JD6odRcjfbXNzF/QJbcXoXnV0rquCFS0Rn6MyjROdp2RNEnN6lpzO81EELGCjOr1LF4lXqVMw+RjUhyyBsHXY/5eljFKr8Y3VyHq+ag3YzjrrHKA7zieMRpXyBoiZmfWh+/LSt52Omgy7o9QbSxHkLIL2kybzq72iruI+y1xnTCktZw2h+qPJ/gkmjwSSMWLYd7Add6ibUqXbOnegS3A41I+XNFu6ppDfblaPgRduYXouByemRNBt8pDH+7xTlKpyYuxeDZv2XPJa3br28mMQvj3Bqs331LNR7btrJLGwyTX5Tt2muzOBX2E2Tb5WgPxRc3HibgSPHPme/uaGzsM1clac8+ZK+wmEtUaaLmIPVbsvX/SvCd1n2ufTL/tRT/sx0OW9+nv26SoXNC6spwYuusd81HtkPWnuj01tkaVKor7qXyS6HLc/tb7CcdFcvLBjRy3Bdrqenc/h4cp0EmOe560HNfPTzyP8WD46Yk5IbSR8RO83bUxJU7JknA1fRU1FVpBWh1z5ylfrebmOEVvdsrpidahPqdmOquxuPRUmofrD9E3tUeaGr5p7BpbjcMY/dRioO9VeD2onHgvThQVVchGlwqv68aZr9o/RbfN24bv12xbzDyhPy8mojb268QxtcPah+aDX6X6pAzrwDpwK5FciNQGDeATzYXW7XayMQrEAwAgXzDoLqUViBwgiUzDtIKlBagdIIXDPvsKYC11bg2gjcMO+woQI3VuDGCNyOTc7WCtwagVfMO2ypHq+swCsjcMe8wxUVuLMCdyYAmocdSYDNDh/AU9FDcscJfkyAuMaC0+zZDHETIq7R4EAG2xxxEySu8eAkg9xmiZswcY0IJznkNk/cBIprTDjJIreZ4iZUXKPCSR65zRU3weIaF06ixW22uAkX18hwEi9u88VNwEAzw0nCwCYMTMJAMwMkYWATBoMSVdUokjAgqpRJGGhmgCQMbMLAJAw0M0ASBjZhYBIGmhmQZG21CQOTMNDMAEkY2ISBSRhUdYskDGzCwCQMNDNAEgY2YWASBpoZIAkDmzAwCROaGSAJEzZhwiRMaGYESZiwCRMmYUIzI0jChE2YGGyEYnSdBbEXmoQJzYwg8RQ2YcIkTGhmBL0J24QJkzChmRFkARQ2YcIkTGhmxJocs02YMAkTmhlB4ilswoRJmNDMiC3Zs02YMAmTmhlB4iltwqRJmOSjY5Y2YdIkTMKobWkTJk3CZHXWIhND2oTJwXGrOm+RiSGJE5dJmNTMSDIxpE2YNAmTmhlJsi1twqRJmNTMSJJtaRPW/FSdzB9VXqrwfX1CPxyYn2VF/Y/zE/vaHNxF917siYkrtn96fu4P6vunZ3RW1890X80rOKSxQhrcXaN7jYWkdr2UFLOlujcVWFMiSXfFrPv3ECmhgcoztLpXYr0kQC8JbgPuPyIgGYFk3JxN3bHphde97nqOLHpPglZ3i0DZ1QISXGX7u169Iu8F3cAjmAMECKzrOOG4FOZdoF4TZdXGSam5zoNcIVN1zNZdyLw2hhYAzb+bmnmdp1dCK+lWNYhbOL3aVa+2c1Sj7830kqiQ8NUZmugzNsINFQDuBpx9RwXJYXzd8sC8YYKkEC/cbW3tuyFIDpHC3erJ2H0OJIoSjbtVE+sqBlJDpYm7JRm6O4F0UK5ytxwzv2+g9EKLINxmbXhlAvlCKcbdcoy464D0UJJxtyxr7ysgEZRW4JZWtQi19aEBgtsA04qGYalESelmaeyDD1pJXCndUKW+ZqPBIlrBjdbBZx5kDuWRcNNqlcbIBQQHuMEx+DqB7CEt6bYg/ecHJINmTGybw4JbzS1GiiQgUsBRirwKgCRR9QC36nEqlHWElmgnkG681RdokBMkAW6biS4VthVUxKQbXZ1OVt8NQKZQvRBuLLRifWLm3fcK5BIlqHSb93FhqpSj2RQOs3njsSzKVBwliu0PN8/P/wN0jl0g"; \ No newline at end of file +window.searchData = "eJy1mttu3DYQht+FvlWc5ZB7vEvdFAgQNEFTtBcLI1Ak2it4LaqS1klg+N0LanUYiiOZspU7w+L8/El+M+RKfGS5/l6w3f6R3SVpzHYcNgFLw3vFduzTu1N5eJ/nOmcBO+VHtmPRMSwKVbztHl0eyvsjC5onbMfYU9CoLTm0apFOizI/ReXzchd2WyQdsCzMVVra7roO+QJk26PysX7RtHpVL19jVUR5kpWJTv167EVM6B2Wq7Zz83xxpdNS/Sg/pKXKb8JItQaS5j/FW7Lh6NpZg4x0mqqofBdF+pSW/ybl4S8VJ7mKymmdXdRC4Vnoe1Ie8k6IngR6jENGcxWW6g9VRgeVT/VWxd60sTPYsRH0s+ECWRbxm6R4k6QHlSelil9u50d0CNNb9be+U+lUW3VsWcfOMDu3KlV5WKrfM519zrW+mWipiY8znWV1/Cy2DOiqKKpp+pIcVVoef072ZiBXRVHNV9GJzG7QZONnnZ2yVzk0qZjVKvNYvNLpTXJ7ykOrKHp7i3rh85gyqP2p06lF0hgylKV16DxmPsTVAl4dw+S+mG4oiauVi5rwGUwdwjQ+qqa2X4XH47cwupto7SzS1PWoE5nBYFKY5iotkyg8V8IpzpIi7EX/giKbFB91GCfp7WRzxzbuF9g66tukqhVXp6LU9xV57+uaPtFpJWUKRlRJVRSqTmqGZW7NvqSwtfZmrGetoReee1pP8x53jvpWn17g5Rw0g4Hi5SW1mL2knorJZ746ZJ58c07mn3P9kMQq/1Qd84dLfK/dhHP5ITnG+chZjlK+QFEjs943P/zTwMzHRAdt0OsN6NR7vyK96HTaVuVpq7hLstcZMwpzWcNofqzyf4RJq8EojFi2GexHU+pG1Kl23p2YEtwMNSPl7Rb+qWROBgtPwYumMb0WPZPjI6lPI4nB+L9Tkqt4ZO6eDZr0k34ob/16eTaJnx/h2Gb76lk477m6lZnZpE5/Uzc6V3bwK+zq9FslGPYFZzfeZODAGdXbb27pzGwzV+UpT//Wr3B4lij1LOZgsV3zZfc+812WfSnDsjv1lD8zU87rf09+t6bi+u3amOBF2zhsGw/sB429wektMp0W6qvpZbTLfsuX9tdbTrqrZxaM6KW/Llfj09l/PLpOAuzz3FWvZj6EeRJ+O/aOmKOSK0kfEVvNm1MaVezZJwNf0VNRVaQFodc88pX63mxjhFb7bKqYm2oj6m5jqrvrgCVprH6w3SN7UHlhquaOwaW43LKA3STqGJtPHGcnAYv0/b2quIh1dKr+vK6b/aPMJwfT+Nz67YIF+0UglpeL1er6Otg3wdWD6h+NRvefKpCzYM+pQO4EcisQWLCHALaX2+XaCgQnEKxAwYK9oHoUTqCwAiUL9pIKlE6gtAKXLNgvqcClE7i0Alcs2K+owJUTuLIC10OTs3YC11bghgX7NdXjxgncWIFbFuw3VODWCdzaABgetiQBLju8B09FD8kdJ/ixAeIGC06z5zLEbYi4QYMDGexyxG2QuMGDkwxylyVuw8QNIpzkkLs8cRsobjDhJIvcZYrbUHGDCid55C5X3AaLG1w4iRZ32eI2XNwgw0m8uMsXtwEDwwwnCQOXMLAJA8MMkISBSxj0SlRVo0jCgKhSNmFgmAGSMHAJA5swMMwASRi4hIFNGBhmgCQMXMLAJgwMM7AkC7NLGNiEQVW3SMLAJQxswsAwAyRh4BIGNmFgmAGSMHAJA5swYZgBkjDhEiZswoRhRpCECZcwYRMmDDOCJEy4hIneRljthCRhgtgLbcKEHFxn4RImbMKEYUbQm7BLmLAJE4YZQeIpXMKETZgwzAiyAAqXMGETJgwzYkWO2SVM2IQJw4wg8RQuYcImTBpmxIbqWbqESZswWRFG4ildwqRNmITBMUuXMGkTJsWwbZcw2TtuVectMjEkceKyCZOGGUkmhnQJkzZh0jAjycSQLmHSJkwaZiTJtnQJkzZh0jAj6UOmS1j9r+pY/6DyUsUfzsf7/Z6FWVacf3U/sq/1qV+sm18Zj0xs2e7x6ak75e8en9BB3zwzfdXv75AGRxrgr9G+A+uk5KKTknKyVPuaw9JEkv6KWfvbEimhgcrldK32fVonCaKTBD973RcIJIMGCX7Oxm4TdcLLTneSLHrJgkDZoPlbnAWk8JXtbrV1imhBuK9OnzlAY4TVOU54LoV966nTXHWSKy+l+uIScoVMnWPW/kL2BTm0AChR/dTsi0udEiobGy8l4r5Rp4a48KtBQzeEOsktImPxAk30DRzhhsoT9wPOvY2D5DC+foXTvkuDpBAv3G9t3VswSA6Rwv1yYejmChJFRYr7VRPn0glSQ2nL/ZIM3RJBOihXuV+O2R9HUHrh/PIb4Ph1EOQSJRz3y7j+VQ4khvKN+yUccQcD6aFkA79ka+5RoIKHcgv8cussQu2qaIDgN0BdgdavwsiT37iGPkQhSFAWCD9uqa/saLAIYPADuPf5CZlDSSX8tBqloaQABIfwm8TeVxNkD2lJP0a6zyJIBs2Y2NTnEL/6WwzUX0ClHDylyCsKSBKlPPil/KlQzulcop1B+vF2vtiDnODDiN/mYkqFawXVR+lHV6uTne8soEVEuSn8WGjEusTM2+8oyCX+weA378PC1C6BZlN4zOZ1wLIkU8ckVWy3v356+h+zGcyF"; \ No newline at end of file diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index 44a77c44..a93ef39c 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 @@ -12,7 +12,7 @@ stackTraceLimit

    Methods

    captureStackTrace fromPayload -

    Constructors

    • Parameters

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

      Returns AuthenticationError

    Properties

    appState: any
    error: string
    error_description: string
    message: string
    name: string
    stack?: string
    state: string
    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Optional override for formatting stack traces

    +

    Constructors

    • Parameters

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

      Returns AuthenticationError

    Properties

    appState: any
    error: string
    error_description: string
    message: string
    name: string
    stack?: string
    state: string
    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Optional override for formatting stack traces

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Parameters

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

      Returns GenericError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/classes/ConnectError.html b/docs/classes/ConnectError.html index 5d5bcef9..7c00ec58 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 @@ -13,7 +13,7 @@ stackTraceLimit

      Methods

      captureStackTrace fromPayload -

      Constructors

      • Parameters

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

        Returns ConnectError

      Properties

      appState: any
      connection: string
      error: string
      error_description: string
      message: string
      name: string
      stack?: string
      state: string
      prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

      Optional override for formatting stack traces

      +

      Constructors

      • Parameters

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

        Returns ConnectError

      Properties

      appState: any
      connection: string
      error: string
      error_description: string
      message: string
      name: string
      stack?: string
      state: string
      prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

      Optional override for formatting stack traces

      https://v8.dev/docs/stack-trace-api#customizing-stack-traces

      stackTraceLimit: number

      Methods

      • Create .stack property on a target object

        -

        Parameters

        • targetObject: object
        • OptionalconstructorOpt: Function

        Returns void

      • Parameters

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

        Returns GenericError

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Methods
      +

      Parameters

      Returns void

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Methods
      diff --git a/docs/classes/GenericError.html b/docs/classes/GenericError.html index 0b092c15..e810614c 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 @@ -9,7 +9,7 @@ stackTraceLimit

        Methods

        captureStackTrace fromPayload -

        Constructors

        • Parameters

          • error: string
          • error_description: string

          Returns GenericError

        Properties

        error: string
        error_description: string
        message: string
        name: string
        stack?: string
        prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

        Optional override for formatting stack traces

        +

        Constructors

        • Parameters

          • error: string
          • error_description: string

          Returns GenericError

        Properties

        error: string
        error_description: string
        message: string
        name: string
        stack?: string
        prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

        Optional override for formatting stack traces

        https://v8.dev/docs/stack-trace-api#customizing-stack-traces

        stackTraceLimit: number

        Methods

        • Create .stack property on a target object

          -

          Parameters

          • targetObject: object
          • OptionalconstructorOpt: Function

          Returns void

        • Parameters

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

          Returns GenericError

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Methods
        +

        Parameters

        Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Methods
        diff --git a/docs/classes/MfaRequiredError.html b/docs/classes/MfaRequiredError.html index 0615345a..026483a5 100644 --- a/docs/classes/MfaRequiredError.html +++ b/docs/classes/MfaRequiredError.html @@ -1,8 +1,9 @@ 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 +mfa_requirements mfa_token name stack? @@ -10,7 +11,7 @@ stackTraceLimit

          Methods

          captureStackTrace fromPayload -

          Constructors

          • Parameters

            • error: string
            • error_description: string
            • mfa_token: string

            Returns MfaRequiredError

          Properties

          error: string
          error_description: string
          message: string
          mfa_token: string
          name: string
          stack?: string
          prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

          Optional override for formatting stack traces

          +

          Constructors

          • Parameters

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

            Returns MfaRequiredError

          Properties

          error: string
          error_description: string
          message: string
          mfa_requirements: MfaRequirements
          mfa_token: string
          name: string
          stack?: string
          prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

          Optional override for formatting stack traces

          https://v8.dev/docs/stack-trace-api#customizing-stack-traces

          stackTraceLimit: number

          Methods

          • Create .stack property on a target object

            -

            Parameters

            • targetObject: object
            • OptionalconstructorOpt: Function

            Returns void

          • Parameters

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

            Returns GenericError

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          Methods
          +

          Parameters

          Returns void

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          Methods
          diff --git a/docs/classes/MissingRefreshTokenError.html b/docs/classes/MissingRefreshTokenError.html index fa85f156..0eb1af02 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 @@ -11,7 +11,7 @@ stackTraceLimit

            Methods

            captureStackTrace fromPayload -

            Constructors

            Properties

            audience: string
            error: string
            error_description: string
            message: string
            name: string
            scope: string
            stack?: string
            prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

            Optional override for formatting stack traces

            +

            Constructors

            Properties

            audience: string
            error: string
            error_description: string
            message: string
            name: string
            scope: string
            stack?: string
            prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

            Optional override for formatting stack traces

            https://v8.dev/docs/stack-trace-api#customizing-stack-traces

            stackTraceLimit: number

            Methods

            • Create .stack property on a target object

              -

              Parameters

              • targetObject: object
              • OptionalconstructorOpt: Function

              Returns void

            • Parameters

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

              Returns GenericError

            Settings

            Member Visibility

            On This Page

            Constructors
            Properties
            Methods
            +

            Parameters

            Returns void

            Settings

            Member Visibility

            On This Page

            Constructors
            Properties
            Methods
            diff --git a/docs/classes/OAuthError.html b/docs/classes/OAuthError.html index 333e1dcb..a5e96d1b 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 @@ prepareStackTrace? stackTraceLimit

              Methods

              captureStackTrace -

              Constructors

              • Parameters

                • error: string
                • Optionalerror_description: string

                Returns OAuthError

              Properties

              error: string
              error_description?: string
              message: string
              name: string
              stack?: string
              prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

              Optional override for formatting stack traces

              +

              Constructors

              • Parameters

                • error: string
                • Optionalerror_description: string

                Returns OAuthError

              Properties

              error: string
              error_description?: string
              message: string
              name: string
              stack?: string
              prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

              Optional override for formatting stack traces

              https://v8.dev/docs/stack-trace-api#customizing-stack-traces

              stackTraceLimit: number

              Methods

              • Create .stack property on a target object

                Parameters

                • targetObject: object
                • OptionalconstructorOpt: Function

                Returns void

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              Methods
              diff --git a/docs/classes/PopupCancelledError.html b/docs/classes/PopupCancelledError.html index c5c1917c..87c6100f 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 @@ -10,7 +10,7 @@ stackTraceLimit

                Methods

                captureStackTrace fromPayload -

                Constructors

                Properties

                error: string
                error_description: string
                message: string
                name: string
                popup: Window
                stack?: string
                prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

                Optional override for formatting stack traces

                +

                Constructors

                Properties

                error: string
                error_description: string
                message: string
                name: string
                popup: Window
                stack?: string
                prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

                Optional override for formatting stack traces

                https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                stackTraceLimit: number

                Methods

                • Create .stack property on a target object

                  -

                  Parameters

                  • targetObject: object
                  • OptionalconstructorOpt: Function

                  Returns void

                • Parameters

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

                  Returns GenericError

                Settings

                Member Visibility

                On This Page

                Constructors
                Properties
                Methods
                +

                Parameters

                Returns void

                Settings

                Member Visibility

                On This Page

                Constructors
                Properties
                Methods
                diff --git a/docs/classes/PopupTimeoutError.html b/docs/classes/PopupTimeoutError.html index cf1a0538..a1fa980c 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 @@ -10,7 +10,7 @@ stackTraceLimit

                  Methods

                  captureStackTrace fromPayload -

                  Constructors

                  Properties

                  error: string
                  error_description: string
                  message: string
                  name: string
                  popup: Window
                  stack?: string
                  prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

                  Optional override for formatting stack traces

                  +

                  Constructors

                  Properties

                  error: string
                  error_description: string
                  message: string
                  name: string
                  popup: Window
                  stack?: string
                  prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

                  Optional override for formatting stack traces

                  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                  stackTraceLimit: number

                  Methods

                  • Create .stack property on a target object

                    -

                    Parameters

                    • targetObject: object
                    • OptionalconstructorOpt: Function

                    Returns void

                  • Parameters

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

                    Returns GenericError

                  Settings

                  Member Visibility

                  On This Page

                  Constructors
                  Properties
                  Methods
                  +

                  Parameters

                  Returns void

                  Settings

                  Member Visibility

                  On This Page

                  Constructors
                  Properties
                  Methods
                  diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html index 4fcbc454..592e44a4 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 @@ -10,7 +10,7 @@ stackTraceLimit

                    Methods

                    captureStackTrace fromPayload -

                    Constructors

                    Properties

                    error: string
                    error_description: string
                    message: string
                    name: string
                    stack?: string
                    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

                    Optional override for formatting stack traces

                    +

                    Constructors

                    Properties

                    error: string
                    error_description: string
                    message: string
                    name: string
                    stack?: string
                    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

                    Optional override for formatting stack traces

                    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                    stackTraceLimit: number

                    Methods

                    • Create .stack property on a target object

                      -

                      Parameters

                      • targetObject: object
                      • OptionalconstructorOpt: Function

                      Returns void

                    • Parameters

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

                      Returns GenericError

                    Settings

                    Member Visibility

                    On This Page

                    Constructors
                    Properties
                    Methods
                    +

                    Parameters

                    Returns void

                    Settings

                    Member Visibility

                    On This Page

                    Constructors
                    Properties
                    Methods
                    diff --git a/docs/classes/UseDpopNonceError.html b/docs/classes/UseDpopNonceError.html index 249f8823..861edfce 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 @@ -10,7 +10,7 @@ stackTraceLimit

                      Methods

                      captureStackTrace fromPayload -

                      Constructors

                      Properties

                      error: string
                      error_description: string
                      message: string
                      name: string
                      newDpopNonce: string | undefined
                      stack?: string
                      prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

                      Optional override for formatting stack traces

                      +

                      Constructors

                      Properties

                      error: string
                      error_description: string
                      message: string
                      name: string
                      newDpopNonce: string | undefined
                      stack?: string
                      prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

                      Optional override for formatting stack traces

                      https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                      stackTraceLimit: number

                      Methods

                      • Create .stack property on a target object

                        -

                        Parameters

                        • targetObject: object
                        • OptionalconstructorOpt: Function

                        Returns void

                      • Parameters

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

                        Returns GenericError

                      Settings

                      Member Visibility

                      On This Page

                      Constructors
                      Properties
                      Methods
                      +

                      Parameters

                      Returns void

                      Settings

                      Member Visibility

                      On This Page

                      Constructors
                      Properties
                      Methods
                      diff --git a/docs/functions/Auth0Provider.html b/docs/functions/Auth0Provider.html index 69a331ed..52acca24 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 15044655..ecb94dc5 100644 --- a/docs/functions/useAuth0.html +++ b/docs/functions/useAuth0.html @@ -1,6 +1,6 @@ -useAuth0 | @auth0/auth0-react
                      @auth0/auth0-react
                        Preparing search index...

                        Function useAuth0

                        • const {
                            // Auth state:
                            error,
                            isAuthenticated,
                            isLoading,
                            user,
                            // Auth methods:
                            getAccessTokenSilently,
                            getAccessTokenWithPopup,
                            getIdTokenClaims,
                            exchangeToken,
                            loginWithRedirect,
                            loginWithPopup,
                            logout,
                          } = useAuth0<TUser>();
+useAuth0 | @auth0/auth0-react
                          @auth0/auth0-react
                            Preparing search index...
                            Function useAuth0
                            • const {
                                // Auth state:
                                error,
                                isAuthenticated,
                                isLoading,
                                user,
                                // Auth methods:
                                getAccessTokenSilently,
                                getAccessTokenWithPopup,
                                getIdTokenClaims,
                                loginWithCustomTokenExchange,
                                exchangeToken, // deprecated - use loginWithCustomTokenExchange
                                loginWithRedirect,
                                loginWithPopup,
                                logout,
                              } = useAuth0<TUser>();
 
                              
 
 
                              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 cd8d4305..b33f500c 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 5d4a9402..b665934b 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 3ce3e244..d5252ed1 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/Auth0ContextInterface.html b/docs/interfaces/Auth0ContextInterface.html index a93bbaed..ca01ee2b 100644 --- a/docs/interfaces/Auth0ContextInterface.html +++ b/docs/interfaces/Auth0ContextInterface.html @@ -1,8 +1,8 @@ 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;
                                    loginWithPopup: (
                                        options?: PopupLoginOptions,
                                        config?: PopupConfigOptions,
                                    ) => Promise<void>;
                                    loginWithRedirect: (
                                        options?: RedirectLoginOptions<AppState>,
                                    ) => Promise<void>;
                                    logout: (options?: LogoutOptions) => Promise<void>;
                                    setDpopNonce: (nonce: string, id?: string) => Promise<void>;
                                    user: 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>;
                                    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>;
                                    setDpopNonce: (nonce: string, id?: string) => Promise<void>;
                                    user: TUser | undefined;
                                }

                                Type Parameters

                                Hierarchy

                                • AuthState<TUser>
                                  • Auth0ContextInterface
                                Index

                                Properties

                                connectAccountWithRedirect createFetcher error -exchangeToken +exchangeToken generateDpopProof getAccessTokenSilently getAccessTokenWithPopup @@ -12,6 +12,7 @@ handleRedirectCallback isAuthenticated isLoading +loginWithCustomTokenExchange loginWithPopup loginWithRedirect logout @@ -25,7 +26,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.

                                @@ -35,30 +36,27 @@ 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>
                                const tokenResponse = await exchangeToken({
                                  subject_token: 'external_token_value',
                                  subject_token_type: 'urn:acme:legacy-system-token',
                                  scope: 'openid profile email'
                                });
+

                                Type Parameters

                                • TOutput extends CustomFetchMinimalOutput = Response

                                Parameters

                                Returns Fetcher<TOutput>

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

                                Exchanges an external subject token for Auth0 tokens via a token exchange request.

                                +

                                Exchanges an external subject token for Auth0 tokens and logs the user in.

                                This method implements the token exchange grant as specified in RFC 8693. It performs a token exchange by sending a request to the /oauth/token endpoint with the external token and returns Auth0 tokens (access token, ID token, etc.).

                                -

                                The request includes the following parameters:

                                -
                                  -
                                • grant_type: Hard-coded to "urn:ietf:params:oauth:grant-type:token-exchange"
                                  • -
                                • subject_token: The external token to be exchanged
                                  • -
                                • subject_token_type: A namespaced URI identifying the token type (must be under your organization's control)
                                  • -
                                • audience: The target audience (falls back to the SDK's default audience if not provided)
                                  • -
                                • scope: Space-separated list of scopes (merged with the SDK's default scopes)
                                  • -
                                -

                                Type Declaration

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

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

                                Example:

                                +
                                // 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 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 @@ -77,7 +75,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.

                                @@ -85,7 +83,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 @@ -95,7 +93,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.

                                @@ -110,16 +108,40 @@

                                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
                                loginWithPopup: (
                                    options?: PopupLoginOptions,
                                    config?: PopupConfigOptions,
                                ) => Promise<void>
                                await loginWithPopup(options, config);
+

                                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. +This method implements the Custom Token Exchange grant as specified in RFC 8693.

                                +

                                The exchanged tokens are automatically cached, establishing an authenticated session. +After calling this method, you can use getUser(), getIdTokenClaims(), and +getTokenSilently() to access the user's information and tokens.

                                +

                                Type Declaration

                                  • (options: CustomTokenExchangeOptions): Promise<TokenEndpointResponse>

                                  • Parameters

                                    Returns Promise<TokenEndpointResponse>

                                    A promise that resolves to the token endpoint response, +which contains the issued Auth0 tokens (access_token, id_token, etc.).

                                    +

                                    The request includes the following parameters:

                                    +
                                      +
                                    • grant_type: "urn:ietf:params:oauth:grant-type:token-exchange"
                                      • +
                                    • subject_token: The external token to exchange
                                      • +
                                    • subject_token_type: The type identifier of the external token
                                      • +
                                    • scope: Merged scopes from the request and SDK defaults
                                      • +
                                    • audience: Target audience (defaults to SDK configuration)
                                      • +
                                    • organization: Optional organization ID/name for org-scoped authentication
                                      • +
                                    +

                                    Example Usage:

                                    +
                                    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);

                                Opens a popup with the /authorize URL using the parameters @@ -129,20 +151,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.

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

                                    @@ -154,4 +176,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/Auth0ProviderOptions.html b/docs/interfaces/Auth0ProviderOptions.html index 207d44dc..07791fb8 100644 --- a/docs/interfaces/Auth0ProviderOptions.html +++ b/docs/interfaces/Auth0ProviderOptions.html @@ -1,5 +1,5 @@ Auth0ProviderOptions | @auth0/auth0-react
                                @auth0/auth0-react
                                  Preparing search index...

                                  Interface Auth0ProviderOptions<TUser>

                                  The main configuration to instantiate the Auth0Provider.

                                  -
                                  interface Auth0ProviderOptions<TUser extends User = User> {
                                      auth0Client?: {
                                          env?: { [key: string]: string };
                                          name: string;
                                          version: string;
                                      };
                                      authorizationParams?: ClientAuthorizationParams;
                                      authorizeTimeoutInSeconds?: number;
                                      cache?: ICache;
                                      cacheLocation?: CacheLocation;
                                      children?: ReactNode;
                                      clientId: string;
                                      context?: Context<Auth0ContextInterface<TUser>>;
                                      cookieDomain?: string;
                                      domain: string;
                                      httpTimeoutInSeconds?: number;
                                      issuer?: string;
                                      leeway?: number;
                                      legacySameSiteCookie?: boolean;
                                      nowProvider?: () => number | Promise<number>;
                                      onRedirectCallback?: (appState?: AppState, user?: TUser) => void;
                                      sessionCheckExpiryDays?: number;
                                      skipRedirectCallback?: boolean;
                                      useCookiesForTransactions?: boolean;
                                      useDpop?: boolean;
                                      useFormData?: boolean;
                                      useMrrt?: boolean;
                                      useRefreshTokens?: boolean;
                                      useRefreshTokensFallback?: boolean;
                                      workerUrl?: string;
                                  }

                                  Type Parameters

                                  Hierarchy

                                  • Auth0ClientOptions
                                    • Auth0ProviderOptions
                                  Index

                                  Properties

                                  auth0Client? +
                                  interface Auth0ProviderOptions<TUser extends User = User> {
                                      auth0Client?: {
                                          env?: { [key: string]: string };
                                          name: string;
                                          version: string;
                                      };
                                      authorizationParams?: ClientAuthorizationParams;
                                      authorizeTimeoutInSeconds?: number;
                                      cache?: ICache;
                                      cacheLocation?: CacheLocation;
                                      children?: ReactNode;
                                      clientId: string;
                                      context?: Context<Auth0ContextInterface<TUser>>;
                                      cookieDomain?: string;
                                      domain: string;
                                      httpTimeoutInSeconds?: number;
                                      issuer?: string;
                                      leeway?: number;
                                      legacySameSiteCookie?: boolean;
                                      nowProvider?: () => number | Promise<number>;
                                      onRedirectCallback?: (appState?: AppState, user?: TUser) => void;
                                      sessionCheckExpiryDays?: number;
                                      skipRedirectCallback?: boolean;
                                      useCookiesForTransactions?: boolean;
                                      useDpop?: boolean;
                                      useFormData?: boolean;
                                      useMrrt?: boolean;
                                      useRefreshTokens?: boolean;
                                      useRefreshTokensFallback?: boolean;
                                      workerUrl?: string;
                                  }

                                  Type Parameters

                                  Hierarchy

                                  • Auth0ClientOptions
                                    • Auth0ProviderOptions
                                  Index

                                  Properties

                                  auth0Client? authorizationParams? authorizeTimeoutInSeconds? cache? @@ -34,7 +34,7 @@ The default setting is memory.

                                  Read more about changing storage options in the Auth0 docs

                                  children?: ReactNode

                                  The child nodes your Provider has wrapped

                                  -
                                  clientId: string

                                  The Client ID found on your Application settings page

                                  +
                                  clientId: string

                                  The Client ID found on your Application settings page

                                  context?: Context<Auth0ContextInterface<TUser>>

                                  Context to be used when creating the Auth0Provider, defaults to the internally created context.

                                  This allows multiple Auth0Providers to be nested within the same application, the context value can then be passed to useAuth0, withAuth0, or withAuthenticationRequired to use that specific Auth0Provider to access @@ -48,7 +48,7 @@ used to store data is different

                                  For a sample on using multiple Auth0Providers review the React Account Linking Sample

                                  -
                                  cookieDomain?: string

                                  The domain the cookie is accessible from. If not set, the cookie is scoped to +

                                  cookieDomain?: string

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

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

                                  @@ -73,7 +73,7 @@
                                  onRedirectCallback?: (appState?: AppState, user?: TUser) => void

                                  By default this removes the code and state parameters from the url when you are redirected from the authorize page. It uses window.history but you might want to overwrite this if you are using a custom router, like react-router-dom See the EXAMPLES.md for more info.

                                  -
                                  sessionCheckExpiryDays?: number

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

                                  sessionCheckExpiryDays?: number

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

                                  skipRedirectCallback?: boolean

                                  By default, if the page url has code/state params, the SDK will treat them as Auth0's and attempt to exchange the code for a token. In some cases the code might be for something else (another OAuth SDK perhaps). In these @@ -81,7 +81,7 @@ 

                                  <Auth0Provider
                                    clientId={clientId}
                                    domain={domain}
                                    skipRedirectCallback={window.location.pathname === '/stripe-oauth-callback'}
                                  >
                                  -
                                  useCookiesForTransactions?: boolean

                                  If true, the SDK will use a cookie when storing information about the auth transaction while +

                                  useCookiesForTransactions?: boolean

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

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

                                  You might want to enable this if you rely on your users being able to authenticate using flows that diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index 13480268..b6df4585 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/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index f122c624..36412a2b 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 38e05944..1aad72db 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 a8d1bc17..9957dbb3 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 f37a977f..8cffca76 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 aee40ea2..934ea9a4 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/types/AppState.html b/docs/types/AppState.html index 6f9c2338..2d0281f1 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/ConnectedAccount.html b/docs/types/ConnectedAccount.html index 0aee1707..e51ba53c 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/variables/Auth0Context.html b/docs/variables/Auth0Context.html index 68b89f43..caf97bff 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-lock.json b/package-lock.json index 4a87014c..f26dece0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/auth0-react", - "version": "2.12.0", + "version": "2.13.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@auth0/auth0-react", - "version": "2.12.0", + "version": "2.13.0", "license": "MIT", "dependencies": { "@auth0/auth0-spa-js": "^2.14.0" diff --git a/package.json b/package.json index e6176e8b..c0fa4a43 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "author": "Auth0", "name": "@auth0/auth0-react", - "version": "2.12.0", + "version": "2.13.0", "description": "Auth0 SDK for React Single Page Applications (SPA)", "keywords": [ "auth0",