diff --git a/.version b/.version index 6b5c90e6..c0543207 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.27.0 \ No newline at end of file +v2.28.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 87ece400..1309c64b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.28.0](https://github.com/auth0/auth0-react/tree/v2.28.0) (2026-10-01) +[Full Changelog](https://github.com/auth0/auth0-react/compare/v2.27.0...v2.28.0) + +**Added** +- feat(anonymous): add Session Transfer Ticket support [\#1266](https://github.com/auth0/auth0-react/pull/1266) ([yogeshchoudhary147](https://github.com/yogeshchoudhary147)) + ## [v2.27.0](https://github.com/auth0/auth0-react/tree/v2.27.0) (2026-09-18) [Full Changelog](https://github.com/auth0/auth0-react/compare/v2.26.0...v2.27.0) diff --git a/docs/classes/AnonymousSessionError.html b/docs/classes/AnonymousSessionError.html index a8239c08..ab8ec5e7 100644 --- a/docs/classes/AnonymousSessionError.html +++ b/docs/classes/AnonymousSessionError.html @@ -23,7 +23,7 @@

Hierarchy

+
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3296
  • @@ -65,7 +65,7 @@

    Parameters

    Returns AnonymousSessionError

    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3306
  • @@ -75,7 +75,7 @@
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3305
  • code: string
    @@ -83,7 +83,7 @@
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3301
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:46
  • @@ -67,7 +67,7 @@

    Parameters

    Returns AuthenticationError

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:49
  • @@ -75,19 +75,19 @@
    appState: any
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:48
  • error: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:47
  • stackTraceLimit: number
    @@ -173,7 +173,7 @@

    Parameters

    Returns GenericError

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:25
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:57
  • @@ -69,7 +69,7 @@

    Parameters

    Returns ConnectError

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:61
  • @@ -77,24 +77,24 @@
    appState: any
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:60
  • connection: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:58
  • error: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:59
  • stackTraceLimit: number
    @@ -180,7 +180,7 @@

    Parameters

    Returns GenericError

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:25
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:21
  • @@ -74,7 +74,7 @@

    Parameters

    Returns GenericError

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:24
  • @@ -82,12 +82,12 @@
    error: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:25
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:36
  • @@ -64,7 +64,7 @@

    Parameters

    Returns InvalidConfigurationError

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:38
  • @@ -73,13 +73,13 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:37
  • stackTraceLimit: number
    @@ -165,7 +165,7 @@

    Parameters

    Returns GenericError

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:25
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:103
  • @@ -66,7 +66,7 @@

    Parameters

    Returns MfaRequiredError

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:106
  • @@ -75,13 +75,13 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:105
  • mfa_token: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:104
  • name: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:25
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:113
  • @@ -64,7 +64,7 @@

    Parameters

    Returns MissingRefreshTokenError

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:116
  • @@ -72,19 +72,19 @@
    audience: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:114
  • error: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:115
  • stack?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:25
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:123
  • @@ -64,7 +64,7 @@

    Parameters

    Returns MissingScopesError

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:126
  • @@ -72,19 +72,19 @@
    audience: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:124
  • error: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:125
  • stack?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:25
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:99
  • @@ -69,7 +69,7 @@

    Parameters

    Returns MyAccountApiError

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:110
  • @@ -79,7 +79,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:107
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:103
  • title: string

    Short human-readable summary of the error

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:105
  • type: string

    RFC 7807 error type identifier

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:101
  • validation_errors?: {
        detail: string;
        field?: string;
        pointer?: string;
        source?: string;
    }[]

    Field-level validation errors, if present

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:109
  • stackTraceLimit: number
    diff --git a/docs/classes/OAuthError.html b/docs/classes/OAuthError.html index c78c55d3..6b47d032 100644 --- a/docs/classes/OAuthError.html +++ b/docs/classes/OAuthError.html @@ -15,14 +15,14 @@

    Class OAuthError

    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
    +
  • Defined in src/errors.tsx:7
  • @@ -63,7 +63,7 @@

    Parameters

    Returns OAuthError

    +
  • Defined in src/errors.tsx:8
  • @@ -71,12 +71,12 @@
    error: string
    +
  • Defined in src/errors.tsx:8
  • error_description?: string
    +
  • Defined in src/errors.tsx:8
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3075
  • @@ -64,7 +64,7 @@

    Parameters

    Returns PasskeyChallengeError

    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3076
  • @@ -75,19 +75,19 @@
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3063
  • cause?: PasskeyApiErrorResponse
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3050
  • code: string
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3051
  • headers?: Headers
    @@ -95,7 +95,7 @@
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3059
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3055
  • stackTraceLimit: number
    diff --git a/docs/classes/PasskeyGetTokenError.html b/docs/classes/PasskeyGetTokenError.html index 7b9c423b..ed0ee45a 100644 --- a/docs/classes/PasskeyGetTokenError.html +++ b/docs/classes/PasskeyGetTokenError.html @@ -22,7 +22,7 @@

    Hierarchy

    • PasskeyGetTokenError
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3084
  • @@ -66,7 +66,7 @@

    Parameters

    Returns PasskeyGetTokenError

    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3086
  • @@ -77,19 +77,19 @@
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3063
  • cause?: PasskeyGetTokenApiErrorResponse
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3085
  • code: string
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3051
  • headers?: Headers
    @@ -97,7 +97,7 @@
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3059
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3055
  • stackTraceLimit: number
    diff --git a/docs/classes/PasskeyRegisterError.html b/docs/classes/PasskeyRegisterError.html index 62334d45..1e23ef6d 100644 --- a/docs/classes/PasskeyRegisterError.html +++ b/docs/classes/PasskeyRegisterError.html @@ -20,7 +20,7 @@

    Hierarchy

    • PasskeyRegisterError
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3069
  • @@ -64,7 +64,7 @@

    Parameters

    Returns PasskeyRegisterError

    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3070
  • @@ -75,19 +75,19 @@
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3063
  • cause?: PasskeyApiErrorResponse
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3050
  • code: string
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3051
  • headers?: Headers
    @@ -95,7 +95,7 @@
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3059
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3055
  • stackTraceLimit: number
    diff --git a/docs/classes/PopupCancelledError.html b/docs/classes/PopupCancelledError.html index 190b3407..8547051a 100644 --- a/docs/classes/PopupCancelledError.html +++ b/docs/classes/PopupCancelledError.html @@ -11,7 +11,7 @@
  • PopupCancelledError
  • Class PopupCancelledError

    -

    Thrown when network requests to the Auth server fail.

    +

    Error thrown when the login popup is closed before auth completes.

    Hierarchy (View Summary)

    @@ -20,7 +20,7 @@

    Hierarchy (View Summary)
    • PopupCancelledError

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:86
  • @@ -62,7 +62,7 @@

    Parameters

    Returns PopupCancelledError

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:88
  • @@ -71,13 +71,13 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:87
  • stack?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:25
    • diff --git a/docs/classes/PopupOpenError.html b/docs/classes/PopupOpenError.html index 1911a2aa..7065fffd 100644 --- a/docs/classes/PopupOpenError.html +++ b/docs/classes/PopupOpenError.html @@ -11,7 +11,7 @@
    • PopupOpenError

    Class PopupOpenError

    -

    Thrown when network requests to the Auth server fail.

    +

    Error thrown when a popup cannot be opened (window.open returned null).

    Hierarchy (View Summary)

    @@ -20,7 +20,7 @@

    Hierarchy (View Summary)

    • PopupOpenError
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:95
  • @@ -57,7 +57,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:96
  • @@ -66,13 +66,13 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:25
    • diff --git a/docs/classes/PopupTimeoutError.html b/docs/classes/PopupTimeoutError.html index bdfb57ea..adf2ac46 100644 --- a/docs/classes/PopupTimeoutError.html +++ b/docs/classes/PopupTimeoutError.html @@ -20,7 +20,7 @@

      Hierarchy (View Summary)
    • PopupTimeoutError
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:77
  • @@ -62,7 +62,7 @@

    Parameters

    Returns PopupTimeoutError

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:79
  • @@ -71,13 +71,13 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:78
  • stack?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:25
    • diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html index 91369c6f..aaccf00d 100644 --- a/docs/classes/TimeoutError.html +++ b/docs/classes/TimeoutError.html @@ -23,7 +23,7 @@

      Hierarchy (View Summary)

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:69
  • @@ -60,7 +60,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:70
  • @@ -69,13 +69,13 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:25
    • diff --git a/docs/classes/UseDpopNonceError.html b/docs/classes/UseDpopNonceError.html index 119204de..13b4e800 100644 --- a/docs/classes/UseDpopNonceError.html +++ b/docs/classes/UseDpopNonceError.html @@ -20,7 +20,7 @@

      Hierarchy (View Summary)
    • UseDpopNonceError
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:133
  • @@ -62,7 +62,7 @@

    Parameters

    Returns UseDpopNonceError

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:135
  • @@ -71,13 +71,13 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:22
  • error_description: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:23
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:134
  • stack?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:25
    • diff --git a/docs/classes/User.html b/docs/classes/User.html index e160d60c..abaea858 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -16,7 +16,7 @@

      Indexable

    • [key: string]: any
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:950
  • @@ -67,107 +67,107 @@
    act?: ActClaim
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:971
  • address?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:968
  • birthdate?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:963
  • email?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:960
  • email_verified?: boolean
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:961
  • family_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:953
  • gender?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:962
  • given_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:952
  • locale?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:965
  • middle_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:954
  • name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:951
  • nickname?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:955
  • phone_number?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:966
  • phone_number_verified?: boolean
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:967
  • picture?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:958
  • preferred_username?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:956
  • profile?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:957
  • sub?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:970
  • updated_at?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:969
  • website?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:959
  • zoneinfo?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:964
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:525
  • @@ -36,12 +36,12 @@
    Code: "code"
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:526
  • ConnectCode: "connect_code"
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:527
  • +
  • Defined in src/auth0-provider.tsx:203
  • +
  • Defined in src/use-auth0.tsx:29
  • +
  • Defined in src/use-auth0-suspense.tsx:43
  • +
  • Defined in src/use-enterprise-connect.tsx:46
  • +
  • Defined in src/with-auth0.tsx:29
  • +
  • Defined in src/with-authentication-required.tsx:103
  • interface AnonymousSession {
        accessToken: string;
        expiresAt: number;
        scope?: string;
        sessionReplaced?: boolean;
        sessionToken: string;
        sessionTokenExpiresAt?: number;
    }
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1922
  • @@ -41,21 +41,21 @@
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1931
  • expiresAt: number

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

    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1935
  • scope?: string

    Scopes granted to this anonymous session.

    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1949
  • sessionReplaced?: boolean
    @@ -69,7 +69,7 @@
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1962
  • sessionToken: string
    @@ -77,7 +77,7 @@
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1927
  • sessionTokenExpiresAt?: number
    @@ -88,7 +88,7 @@
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1945
  • -
    interface AnonymousSessionApiClient {
        createSession(
            options?: CreateAnonymousSessionOptions,
        ): Promise<AnonymousSession>;
        getClaims(): null;
        getTokenSilently(
            options?: AnonymousGetTokenSilentlyOptions,
        ): Promise<AnonymousTokenResult>;
        hasSession(): boolean;
        logout(): Promise<void>;
    }
    @@ -34,6 +34,7 @@
    @@ -52,7 +53,7 @@

    Parameters

  • Optionaloptions: CreateAnonymousSessionOptions
  • Returns Promise<AnonymousSession>

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/anonymous/AnonymousSessionApiClient.d.ts:35
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/anonymous/AnonymousSessionApiClient.d.ts:63
  • Returns Promise<AnonymousTokenResult>

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/anonymous/AnonymousSessionApiClient.d.ts:44
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/anonymous/AnonymousSessionApiClient.d.ts:58
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/anonymous/AnonymousSessionApiClient.d.ts:54
  • +
    + +
      +
    • + +
      +

      Mints a short-lived transfer ticket (30s single-use JWE) for linking the +anonymous session during loginWithRedirect(). Returns null if no session +is active or the request fails — callers must never be blocked from login.

      +
      +

      Returns Promise<string | null>

    interface AnonymousSessionClaims {
        aud: string | string[];
        exp: number;
        iat: number;
        iss: string;
        metadata?: Record<string, string>;
        sid: string;
        sub: string;
    }
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1973
  • @@ -45,49 +45,49 @@
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1979
  • exp: number

    Expiry timestamp (seconds since epoch).

    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1983
  • iat: number

    Issued-at timestamp (seconds since epoch).

    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1981
  • iss: string

    Issuer of the token.

    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1975
  • metadata?: Record<string, string>

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

    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1987
  • sid: string

    Session ID.

    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1985
  • sub: string

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

    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1977
  • Returns Promise<string>

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

    If there's a valid token stored, return it. Otherwise, opens an -iframe with the /authorize URL using the parameters provided -as arguments. Random and secure state and nonce parameters -will be auto-generated. If the response is successful, results -will be valid according to their expiration times.

    -

    If refresh tokens are used, the token endpoint is called directly with the -'refresh_token' grant. If no refresh token is available to make this call, -the SDK will only fall back to using an iframe to the '/authorize' URL if -the useRefreshTokensFallback setting has been set to true. By default this -setting is false.

    -

    This method may use a web worker to perform the token call if the in-memory -cache is used.

    -

    If an audience value is given to this function, the SDK always falls -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.

    -
    -
    -

    Type Declaration

    -
      -
    • -
        -
      • (
            options: GetTokenSilentlyOptions & { detailedResponse: true },
        ): Promise<GetTokenSilentlyVerboseResponse | undefined>
      • -
      • -

        Fetches a new access token and returns the response from the /oauth/token endpoint, omitting the refresh token.

        -
        -
        -

        Parameters

        -
        -

        Returns Promise<GetTokenSilentlyVerboseResponse | undefined>

      • -
      • (options?: GetTokenSilentlyOptions): Promise<string | undefined>
      • -
      • -

        Fetches a new access token and returns it.

        -
        -
        -

        Parameters

        -
        -

        Returns Promise<string | undefined>

    -
    - -
    getAccessTokenWithPopup: (
        options?: GetTokenWithPopupOptions,
        config?: PopupConfigOptions,
    ) => Promise<string | undefined>
    -
    const token = await getTokenWithPopup(options, config);
    -
    - -

    Get an access token interactively.

    -

    Opens a popup with the /authorize URL using the parameters -provided as arguments. Random and secure state and nonce -parameters will be auto-generated. If the response is successful, -results will be valid according to their expiration times.

    -
    +
  • Defined in src/auth0-context.tsx:340
  • getConfiguration: () => Readonly<ClientConfiguration>
    @@ -311,7 +153,7 @@
    +
  • Defined in src/auth0-context.tsx:361
  • getDpopNonce: (id?: string) => Promise<string | undefined>
    @@ -351,7 +193,165 @@
    +
  • Defined in src/auth0-context.tsx:320
  • +
    + +
    setDpopNonce: (nonce: string, id?: string) => Promise<void>
    +

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

    +

    It requires enabling the Auth0ClientOptions.useDpop option.

    +
    +
    +

    Type Declaration

    +
      +
    • +
        +
      • (nonce: string, id?: string): Promise<void>
      • +
      • +

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

        +

        It requires enabling the Auth0ClientOptions.useDpop option.

        +
        +
        +

        Parameters

        +
          +
        • nonce: string +

          The nonce value.

          +
        • +
        • Optionalid: string +

          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.

          +
        +

        Returns Promise<void>

    +
    +
    +

    The nonce value.

    +
    +
    +

    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.

    +
    +
    + +
    +
    + + +
    const { anonymous } = useAuth0();
    const { accessToken } = await anonymous.getTokenSilently({ audience: 'https://api.example.com' }); +
    + +

    Anonymous session client for pre-authentication identity management.

    +
      +
    • createSession(options?) - Create a new anonymous session
    • +
    • getTokenSilently(options?) - Get or renew an anonymous access token
    • +
    • logout() - End the anonymous session and clear stored tokens
    • +
    • getClaims() - Always returns null in EA
    • +
    +
    +
    + +
    connectAccountWithRedirect: (
        options: RedirectConnectAccountOptions,
    ) => Promise<void>
    +
    await connectAccountWithRedirect({
    connection: 'google-oauth2',
    scopes: ['openid', 'profile', 'email', 'https://www.googleapis.com/auth/drive.readonly'],
    authorization_params: {
    // additional authorization params to forward to the authorization server
    }
    }); +
    + +

    Redirects to the /connect URL using the parameters +provided as arguments. This then redirects to the connection's login page +where the user can authenticate and authorize the account to be connected.

    +

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

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

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

    +

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

    +

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

    +
    +
    +

    Type Declaration

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

    Type Declaration

    +
    +
    +
    +

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

    +
    const tokenResponse = await exchangeToken({
    subject_token: 'external_token_value',
    subject_token_type: 'urn:acme:legacy-system-token',
    scope: 'openid profile email'
    }); +
    + +

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

    +

    Example:

    +
    // Instead of:
    const tokens = await exchangeToken(options);

    // Use:
    const tokens = await loginWithCustomTokenExchange(options); +
    + +
    +
    + +
    getAccessTokenWithPopup: (
        options?: GetTokenWithPopupOptions,
        config?: PopupConfigOptions,
    ) => Promise<string | undefined>
    +
    const token = await getTokenWithPopup(options, config);
    +
    + +

    Get an access token interactively.

    +

    Opens a popup with the /authorize URL using the parameters +provided as arguments. Random and secure state and nonce +parameters will be auto-generated. If the response is successful, +results will be valid according to their expiration times.

    +
    getIdTokenClaims: () => Promise<IdToken | undefined>
    @@ -361,7 +361,7 @@
    +
  • Defined in src/auth0-context.tsx:88
  • handleRedirectCallback: (
        url?: string,
    ) => Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>
    @@ -385,19 +385,19 @@

    Parameters

    Returns Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>

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

    Returns Promise

    +
  • Defined in src/auth0-context.tsx:138
  • loginWithPopup: (
        options?: PopupLoginOptions,
        config?: PopupConfigOptions,
    ) => Promise<void>
    @@ -456,7 +456,7 @@
    +
  • Defined in src/auth0-context.tsx:229
  • loginWithRedirect: (options?: RedirectLoginOptions<AppState>) => Promise<void>
    @@ -468,7 +468,7 @@
    +
  • Defined in src/auth0-context.tsx:211
  • logout: (options?: LogoutOptions) => Promise<void>
    @@ -481,7 +481,7 @@
    +
  • Defined in src/auth0-context.tsx:266
  • @@ -505,7 +505,7 @@
    +
  • Defined in src/auth0-context.tsx:415
  • @@ -532,7 +532,7 @@
    +
  • Defined in src/auth0-context.tsx:467
  • @@ -548,7 +548,7 @@
    +
  • Defined in src/auth0-context.tsx:431
  • revokeRefreshToken: (options?: RevokeRefreshTokenOptions) => Promise<void>
    @@ -585,52 +585,64 @@

    Parameters

    Returns Promise<void>

    +
  • Defined in src/auth0-context.tsx:295
  • +
    + +
    user: TUser | undefined
    +
    + +
    - -
    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.

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

    If there's a valid token stored, return it. Otherwise, opens an +iframe with the /authorize URL using the parameters provided +as arguments. Random and secure state and nonce parameters +will be auto-generated. If the response is successful, results +will be valid according to their expiration times.

    +

    If refresh tokens are used, the token endpoint is called directly with the +'refresh_token' grant. If no refresh token is available to make this call, +the SDK will only fall back to using an iframe to the '/authorize' URL if +the useRefreshTokensFallback setting has been set to true. By default this +setting is false.

    +

    This method may use a web worker to perform the token call if the in-memory +cache is used.

    +

    If an audience value is given to this function, the SDK always falls +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.

    Type Declaration

      • -
      • (nonce: string, id?: string): Promise<void>
      • +
      • (
            options: GetTokenSilentlyOptions & { detailedResponse: true },
        ): Promise<GetTokenSilentlyVerboseResponse | undefined>
      • -

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

        -

        It requires enabling the Auth0ClientOptions.useDpop option.

        +

        Fetches a new access token and returns the response from the /oauth/token endpoint, omitting the refresh token.

        Parameters

          -
        • nonce: string -

          The nonce value.

          -
        • -
        • Optionalid: string -

          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.

          -
        -

        Returns Promise<void>

    -
    -
    -

    The nonce value.

    +
  • options: GetTokenSilentlyOptions & { detailedResponse: true }
  • +

    Returns Promise<GetTokenSilentlyVerboseResponse | undefined>

    +
  • (options?: GetTokenSilentlyOptions): Promise<string | undefined>
  • +
  • +

    Fetches a new access token and returns it.

    -
    -

    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
    +
  • Defined in src/auth0-context.tsx:62
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:31
  • @@ -54,14 +54,14 @@
    acr_values?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:77
  • audience?: string

    The default audience to be used for requesting API access.

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:90
  • connection?: string
    @@ -70,7 +70,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:96
  • display?: "page" | "popup" | "touch" | "wap"
    @@ -82,7 +82,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:38
  • experiment_id?: string
    @@ -100,21 +100,21 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:146
  • id_token_hint?: string

    Previously issued ID Token.

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

    The Id of an invitation to accept. This is available from the user invitation URL that is given when participating in a user invitation flow.

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:112
  • login_hint?: string
    @@ -124,7 +124,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:76
  • max_age?: string | number
    @@ -133,7 +133,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:51
  • organization?: string
    @@ -147,7 +147,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:108
  • prompt?: "none" | "login" | "consent" | "select_account"
    @@ -159,7 +159,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:45
  • redirect_uri?: string
    @@ -170,7 +170,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:120
  • scope?: string
    @@ -180,7 +180,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:86
  • screen_hint?: string
    @@ -190,7 +190,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:68
  • segment_id?: string
    @@ -198,7 +198,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:158
  • session_transfer_token?: string
    @@ -211,7 +211,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:128
  • ui_locales?: string
    @@ -219,7 +219,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:56
  • variation_id?: string
    @@ -229,7 +229,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:153
  • interface ClientConfiguration {
        clientId: string;
        domain: string;
    }
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:444
  • @@ -35,14 +35,14 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:452
  • domain: string

    The Auth0 domain that was configured

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:448
  • interface CreateAnonymousSessionOptions {
        audience?: string;
        metadata?: Record<string, string>;
        scope?: string;
    }
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1994
  • @@ -38,7 +38,7 @@
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:1999
  • metadata?: Record<string, string>
    @@ -46,14 +46,14 @@
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:2008
  • scope?: string

    Space-separated list of scopes to request.

    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:2003
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:600
  • cacheMode?: "on" | "off" | "cache-only"
    @@ -69,7 +69,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:596
  • detailedResponse?: boolean
    @@ -78,7 +78,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:634
  • timeoutInSeconds?: number
    @@ -86,7 +86,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:627
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:645
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:938
  • sid?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:931
  • sub_jwk?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:929
  • updated_at?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:915
  • website?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:905
  • zoneinfo?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:910
  • Returns Promise<Response>

    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3310
  • telemetry?: TelemetryConfig
    +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3311
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:665
  • openUrl?: false | ((url: string) => void | Promise<void>)
    @@ -97,7 +97,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:729
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:660
  • logoutParams?: { federated?: boolean; returnTo?: string; [key: string]: any }
    @@ -68,7 +68,7 @@
    OptionalreturnT

    Read more about how redirecting after logout works

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:665
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/mfa/MfaApiClient.d.ts:139
    • @@ -115,7 +115,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/mfa/MfaApiClient.d.ts:109
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/mfa/MfaApiClient.d.ts:80
    • @@ -178,7 +178,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/mfa/MfaApiClient.d.ts:182
    • @@ -206,7 +206,7 @@

      Parameters

    Returns void

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/mfa/MfaApiClient.d.ts:57
    • @@ -257,7 +257,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/mfa/MfaApiClient.d.ts:226
  • interface MyAccountApiClient {
        completeAccount(params: CompleteRequest): Promise<CompleteResponse>;
        connectAccount(params: ConnectRequest): Promise<ConnectResponse>;
        deleteAuthenticationMethod(id: string): Promise<void>;
        enrollmentChallenge(
            options: EnrollmentChallengeOptions,
        ): Promise<EnrollmentChallengeResponse>;
        enrollmentVerify(
            options: EnrollmentVerifyOptions,
        ): Promise<AuthenticationMethod>;
        getAuthenticationMethod(id: string): Promise<AuthenticationMethod>;
        getAuthenticationMethods(
            type?: AuthenticationMethodType,
        ): Promise<AuthenticationMethod[]>;
        getFactors(): Promise<Factor[]>;
        updateAuthenticationMethod(
            id: string,
            data: UpdateAuthenticationMethodRequest,
        ): Promise<AuthenticationMethod>;
    }
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:15
  • @@ -60,7 +60,7 @@

    Parameters

    Returns Promise<CompleteResponse>

    A promise that resolves to the completed connected account details

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:32
    • @@ -78,7 +78,7 @@

      Parameters

      Returns Promise<ConnectResponse>

      A promise that resolves to a connect response with the redirect URI and auth session

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:25
    • @@ -96,7 +96,7 @@

      Parameters

      Returns Promise<void>

      A promise that resolves when the authentication method has been deleted

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:59
    • @@ -115,7 +115,7 @@

      Parameters

      Returns Promise<EnrollmentChallengeResponse>

      A promise that resolves to the enrollment challenge response (shape varies by type)

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:75
    • @@ -133,7 +133,7 @@

      Parameters

      Returns Promise<AuthenticationMethod>

      A promise that resolves to the confirmed authentication method

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:82
    • @@ -151,7 +151,7 @@

      Parameters

      Returns Promise<AuthenticationMethod>

      A promise that resolves to the authentication method

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:52
    • @@ -169,7 +169,7 @@

      Parameters

      Returns Promise<AuthenticationMethod[]>

      A promise that resolves to an array of authentication methods

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:45
    • @@ -181,7 +181,7 @@

      A promise that resolves to an array of factors with their enabled/disabled status

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:38
    • @@ -202,7 +202,7 @@

      Parameters

      Returns Promise<AuthenticationMethod>

      A promise that resolves to the updated authentication method

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/myaccount/MyAccountApiClient.d.ts:67
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/passkey/PasskeyApiClient.d.ts:87
    • @@ -100,7 +100,7 @@

      If the challenge request fails

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/passkey/PasskeyApiClient.d.ts:73
    • @@ -132,7 +132,7 @@

      If the token exchange fails

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/passkey/PasskeyApiClient.d.ts:102
    • @@ -166,7 +166,7 @@

      If the user cancels the WebAuthn prompt

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/passkey/PasskeyApiClient.d.ts:59
    • @@ -200,7 +200,7 @@

      If the user cancels the WebAuthn prompt

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/passkey/PasskeyApiClient.d.ts:44
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:561
  • timeoutInSeconds?: number
    @@ -67,7 +67,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:555
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:176
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:784
  • redirectUri?: string

    The URI to redirect back to after connecting the account.

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:764
  • scopes?: string[]
    @@ -99,7 +99,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:748
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:176
  • fragment?: string
    @@ -62,7 +62,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:484
  • openUrl?: (url: string) => void | Promise<void>
    @@ -81,7 +81,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:516
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:1001
  • @@ -34,7 +34,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:1003
  • interface UseEnterpriseConnect {
        isFederatedDomain: (
            emailDomain: string,
            options?: IsFederatedDomainOptions,
        ) => Promise<boolean>;
        loginWithSSO: (
            email: string,
            options?: RedirectLoginOptions<AppState>,
        ) => Promise<void>;
    }
    +
  • Defined in src/use-enterprise-connect.tsx:14
  • @@ -38,7 +38,7 @@
    +
  • Defined in src/use-enterprise-connect.tsx:21
  • loginWithSSO: (
        email: string,
        options?: RedirectLoginOptions<AppState>,
    ) => Promise<void>
    @@ -47,7 +47,7 @@
    +
  • Defined in src/use-enterprise-connect.tsx:30
  • interface WithAuth0Props {
        auth0: Auth0ContextInterface;
    }
    +
  • Defined in src/with-auth0.tsx:7
  • @@ -32,7 +32,7 @@
    +
  • Defined in src/with-auth0.tsx:8
  • interface WithAuthenticationRequiredOptions {
        context?: Context<Auth0ContextInterface<User>>;
        loginOptions?: RedirectLoginOptions<AppState>;
        onBeforeAuthentication?: () => Promise<void>;
        onRedirecting?: () => Element;
        returnTo?: string | (() => string);
    }
    +
  • Defined in src/with-authentication-required.tsx:33
  • @@ -40,7 +40,7 @@
    +
  • Defined in src/with-authentication-required.tsx:92
  • @@ -51,7 +51,7 @@
    +
  • Defined in src/with-authentication-required.tsx:86
  • onBeforeAuthentication?: () => Promise<void>
    @@ -61,7 +61,7 @@
    +
  • Defined in src/with-authentication-required.tsx:71
  • onRedirecting?: () => Element
    @@ -71,7 +71,7 @@
    +
  • Defined in src/with-authentication-required.tsx:61
  • returnTo?: string | (() => string)
    @@ -85,7 +85,7 @@
    +
  • Defined in src/with-authentication-required.tsx:51
  • AnonymousGetTokenSilentlyOptions: Omit<
        GetAnonymousAccessTokenOptions,
        "sessionToken",
    >
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/anonymous/AnonymousSessionApiClient.d.ts:6
  • +
  • Defined in node_modules/@auth0/auth0-auth-js/dist/index.d.ts:3288
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:459
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/TokenExchange.d.ts:47
  • organization?: string
    @@ -114,7 +114,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/TokenExchange.d.ts:63
  • scope?: string
    @@ -130,7 +130,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/TokenExchange.d.ts:57
  • subject_token: string
    @@ -150,7 +150,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/TokenExchange.d.ts:36
  • subject_token_type: string
    @@ -175,7 +175,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/TokenExchange.d.ts:24
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:11
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:20
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:27
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:842
  • +
  • Defined in src/auth0-context.tsx:559
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:20
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:27