Class AuthenticationError
Hierarchy
- GenericError
- AuthenticationError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Authentication Error(error, error_description, state, appState?): AuthenticationError Parameters
error: string
error_description: string
state: string
OptionalappState: any
Returns AuthenticationError
Properties
app
app
error
error: string
error_
error_
message
message: string
name
name: string
Optional stack
stack?: string
state
state: string
Static Optional prepare
prepare
Type declaration
- (err, stackTraces): any
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Static from
- from
Payload(__namedParameters): GenericError Parameters
__namedParameters: {
    error: string;
    error_description: string;
}error: string
error_
description: string
Returns GenericError
Class GenericError
Thrown when network requests to the Auth server fail.
-Hierarchy (view full)
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Generic Error(error, error_description): GenericError Parameters
- error: string
- error_description: string
Returns GenericError
Properties
error
error: string
error_
error_
message
message: string
name
name: string
Optional stack
stack?: string
Static Optional prepare
prepare
Optional override for formatting stack traces
-Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Static from
- from
Payload(__namedParameters): GenericError Parameters
- __namedParameters: {
    error: string;
    error_description: string;
}error: string
error_
description: string
Returns GenericError
- __namedParameters: {
Class GenericError
Thrown when network requests to the Auth server fail.
+Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Generic Error(error, error_description): GenericError Parameters
error: string
error_description: string
Returns GenericError
Properties
error
error: string
error_
error_
message
message: string
name
name: string
Optional stack
stack?: string
Static Optional prepare
prepare
Type declaration
- (err, stackTraces): any
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Static from
- from
Payload(__namedParameters): GenericError Parameters
__namedParameters: {
    error: string;
    error_description: string;
}error: string
error_
description: string
Returns GenericError
Class InMemoryCache
Index
Constructors
Properties
Constructors
constructor
- new
In Memory Cache(): InMemoryCache Returns InMemoryCache
Properties
enclosed
Class InMemoryCache
Index
Constructors
Properties
Constructors
constructor
- new
In Memory Cache(): InMemoryCache Returns InMemoryCache
Properties
enclosed
Class LocalStorageCache
Implements
Index
Constructors
Methods
Constructors
constructor
- new
Local Storage Cache(): LocalStorageCache Returns LocalStorageCache
Methods
all
get
remove
set
Class LocalStorageCache
Implements
Index
Constructors
Methods
Constructors
constructor
- new
Local Storage Cache(): LocalStorageCache Returns LocalStorageCache
Methods
all
get
- get<T>(key): MaybePromise<undefined | T>
Type Parameters
T = Cacheable
Parameters
key: string
Returns MaybePromise<undefined | T>
remove
set
- set<T>(key, entry): void
Type Parameters
T = Cacheable
Parameters
key: string
entry: T
Returns void
Class MfaRequiredError
Error thrown when the token exchange results in a mfa_required error
Hierarchy (view full)
- GenericError
- MfaRequiredError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Mfa Required Error(error, error_description, mfa_token): MfaRequiredError Parameters
- error: string
- error_description: string
- mfa_token: string
Returns MfaRequiredError
Properties
error
error: string
error_
error_
message
message: string
mfa_
mfa_
name
name: string
Optional stack
stack?: string
Static Optional prepare
prepare
Optional override for formatting stack traces
-Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Static from
- from
Payload(__namedParameters): GenericError Parameters
- __namedParameters: {
    error: string;
    error_description: string;
}error: string
error_
description: string
Returns GenericError
- __namedParameters: {
Class MfaRequiredError
Error thrown when the token exchange results in a mfa_required error
Hierarchy
- GenericError
- MfaRequiredError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Mfa Required Error(error, error_description, mfa_token): MfaRequiredError Parameters
error: string
error_description: string
mfa_token: string
Returns MfaRequiredError
Properties
error
error: string
error_
error_
message
message: string
mfa_
mfa_
name
name: string
Optional stack
stack?: string
Static Optional prepare
prepare
Type declaration
- (err, stackTraces): any
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Static from
- from
Payload(__namedParameters): GenericError Parameters
__namedParameters: {
    error: string;
    error_description: string;
}error: string
error_
description: string
Returns GenericError
Class MissingRefreshTokenError
Error thrown when there is no refresh token to use
-Hierarchy (view full)
- GenericError
- MissingRefreshTokenError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Missing Refresh Token Error(audience, scope): MissingRefreshTokenError Parameters
- audience: string
- scope: string
Returns MissingRefreshTokenError
Properties
audience
audience: string
error
error: string
error_
error_
message
message: string
name
name: string
scope
scope: string
Optional stack
stack?: string
Static Optional prepare
prepare
Optional override for formatting stack traces
-Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Static from
- from
Payload(__namedParameters): GenericError Parameters
- __namedParameters: {
    error: string;
    error_description: string;
}error: string
error_
description: string
Returns GenericError
- __namedParameters: {
Class MissingRefreshTokenError
Error thrown when there is no refresh token to use
+Hierarchy
- GenericError
- MissingRefreshTokenError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Missing Refresh Token Error(audience, scope): MissingRefreshTokenError Parameters
audience: string
scope: string
Returns MissingRefreshTokenError
Properties
audience
audience: string
error
error: string
error_
error_
message
message: string
name
name: string
scope
scope: string
Optional stack
stack?: string
Static Optional prepare
prepare
Type declaration
- (err, stackTraces): any
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Static from
- from
Payload(__namedParameters): GenericError Parameters
__namedParameters: {
    error: string;
    error_description: string;
}error: string
error_
description: string
Returns GenericError
Class OAuthError
An OAuth2 error will come from the authorization server and will have at least an error property which will
+
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
Properties
Methods
Constructors
constructor
- new OAuth
Error(error, error_description?): OAuthError Parameters
- error: string
Optionalerror_description: string
Returns OAuthError
Properties
error
error: string
Optional error_
error_
message
message: string
name
name: string
Optional stack
stack?: string
Static Optional prepare
prepare
Optional override for formatting stack traces
-Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Hierarchy
- Error
- OAuthError
Index
Constructors
Properties
Methods
Constructors
constructor
- new OAuth
Error(error, error_description?): OAuthError Parameters
error: string
Optionalerror_description: string
Returns OAuthError
Properties
error
error: string
Optional error_
error_
message
message: string
name
name: string
Optional stack
stack?: string
Static Optional prepare
prepare
Type declaration
- (err, stackTraces): any
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Class PopupCancelledError
Thrown when network requests to the Auth server fail.
-Hierarchy (view full)
- GenericError
- PopupCancelledError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Popup Cancelled Error(popup): PopupCancelledError Parameters
- popup: Window
Returns PopupCancelledError
Properties
error
error: string
error_
error_
message
message: string
name
name: string
popup
popup: Window
Optional stack
stack?: string
Static Optional prepare
prepare
Optional override for formatting stack traces
-Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Static from
- from
Payload(__namedParameters): GenericError Parameters
- __namedParameters: {
    error: string;
    error_description: string;
}error: string
error_
description: string
Returns GenericError
- __namedParameters: {
Class PopupCancelledError
Thrown when network requests to the Auth server fail.
+Hierarchy
- GenericError
- PopupCancelledError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Popup Cancelled Error(popup): PopupCancelledError Parameters
popup: Window
Returns PopupCancelledError
Properties
error
error: string
error_
error_
message
message: string
name
name: string
popup
popup: Window
Optional stack
stack?: string
Static Optional prepare
prepare
Type declaration
- (err, stackTraces): any
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Static from
- from
Payload(__namedParameters): GenericError Parameters
__namedParameters: {
    error: string;
    error_description: string;
}error: string
error_
description: string
Returns GenericError
Class PopupTimeoutError
Error thrown when the login popup times out (if the user does not complete auth)
-Hierarchy (view full)
- TimeoutError
- PopupTimeoutError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Popup Timeout Error(popup): PopupTimeoutError Parameters
- popup: Window
Returns PopupTimeoutError
Properties
error
error: string
error_
error_
message
message: string
name
name: string
popup
popup: Window
Optional stack
stack?: string
Static Optional prepare
prepare
Optional override for formatting stack traces
-Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Static from
- from
Payload(__namedParameters): GenericError Parameters
- __namedParameters: {
    error: string;
    error_description: string;
}error: string
error_
description: string
Returns GenericError
- __namedParameters: {
Class PopupTimeoutError
Error thrown when the login popup times out (if the user does not complete auth)
+Hierarchy
- TimeoutError
- PopupTimeoutError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Popup Timeout Error(popup): PopupTimeoutError Parameters
popup: Window
Returns PopupTimeoutError
Properties
error
error: string
error_
error_
message
message: string
name
name: string
popup
popup: Window
Optional stack
stack?: string
Static Optional prepare
prepare
Type declaration
- (err, stackTraces): any
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Static from
- from
Payload(__namedParameters): GenericError Parameters
__namedParameters: {
    error: string;
    error_description: string;
}error: string
error_
description: string
Returns GenericError
Class TimeoutError
Thrown when silent auth times out (usually due to a configuration issue) or +
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 full)
- GenericError
- TimeoutError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Timeout Error(): TimeoutError Returns TimeoutError
Properties
error
error: string
error_
error_
message
message: string
name
name: string
Optional stack
stack?: string
Static Optional prepare
prepare
Optional override for formatting stack traces
-Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Static from
- from
Payload(__namedParameters): GenericError Parameters
- __namedParameters: {
    error: string;
    error_description: string;
}error: string
error_
description: string
Returns GenericError
- __namedParameters: {
Hierarchy
- GenericError
- TimeoutError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Timeout Error(): TimeoutError Returns TimeoutError
Properties
error
error: string
error_
error_
message
message: string
name
name: string
Optional stack
stack?: string
Static Optional prepare
prepare
Type declaration
- (err, stackTraces): any
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Static from
- from
Payload(__namedParameters): GenericError Parameters
__namedParameters: {
    error: string;
    error_description: string;
}error: string
error_
description: string
Returns GenericError
Class User
Indexable
[key: string]: any
Index
Constructors
Properties
Constructors
constructor
Properties
Optional address
address?: string
Optional birthdate
birthdate?: string
Optional email
email?: string
Optional email_
email_
Optional family_
family_
Optional gender
gender?: string
Optional given_
given_
Optional locale
locale?: string
Optional middle_
middle_
Optional name
name?: string
Optional nickname
nickname?: string
Optional phone_
phone_
Optional phone_
phone_
Optional picture
picture?: string
Optional preferred_
preferred_
Optional profile
profile?: string
Optional sub
sub?: string
Optional updated_
updated_
Optional website
website?: string
Optional zoneinfo
zoneinfo?: string
Class User
Indexable
[key: string]: any
Index
Constructors
Properties
Constructors
constructor
Properties
Optional address
address?: string
Optional birthdate
birthdate?: string
Optional email
email?: string
Optional email_
email_
Optional family_
family_
Optional gender
gender?: string
Optional given_
given_
Optional locale
locale?: string
Optional middle_
middle_
Optional name
name?: string
Optional nickname
nickname?: string
Optional phone_
phone_
Optional phone_
phone_
Optional picture
picture?: string
Optional preferred_
preferred_
Optional profile
profile?: string
Optional sub
sub?: string
Optional updated_
updated_
Optional website
website?: string
Optional zoneinfo
zoneinfo?: string
Function Auth0Context
- Auth0
Context(props): null | ReactElement<unknown, string | JSXElementConstructor<any>> The Auth0 Context
-Parameters
- props: ProviderProps<Auth0ContextInterface<User>>
Returns null | ReactElement<unknown, string | JSXElementConstructor<any>>
Index
Properties
Properties
Readonly $$typeof
$$typeof: symbol
Consumer
Provider
Optional display
display
Used in debugging messages. You might want to set it -explicitly if you want to display a different name for -debugging purposes.
-See
-Function Auth0Provider
- Auth0
Provider(opts): Element <Auth0Provider
domain={domain}
clientId={clientId}
authorizationParams={{ redirect_uri: window.location.origin }}>
<MyApp />
</Auth0Provider> +Auth0Provider | @auth0/auth0-react \ No newline at end of file +Function Auth0Provider
- Auth0
Provider(opts): Element <Auth0Provider
domain={domain}
clientId={clientId}
authorizationParams={{ redirect_uri: window.location.origin }}}>
<MyApp />
</Auth0Provider>Provides the Auth0Context to its child components.
-Parameters
- opts: Auth0ProviderOptions
Returns Element
Parameters
opts: Auth0ProviderOptions
Returns Element
- Auth0
Function useAuth0
- use
Auth0<TUser>(context?): Auth0ContextInterface<TUser> const {
// Auth state:
error,
isAuthenticated,
isLoading,
user,
// Auth methods:
getAccessTokenSilently,
getAccessTokenWithPopup,
getIdTokenClaims,
loginWithRedirect,
loginWithPopup,
logout,
} = useAuth0<TUser>(); +useAuth0 | @auth0/auth0-react \ No newline at end of file +Function useAuth0
- use
Auth0<TUser>(context?): Auth0ContextInterface<TUser> const {
// Auth state:
error,
isAuthenticated,
isLoading,
user,
// Auth methods:
getAccessTokenSilently,
getAccessTokenWithPopup,
getIdTokenClaims,
loginWithRedirect,
loginWithPopup,
logout,
} = useAuth0<TUser>();Use the
useAuth0hook in your components to access the auth state and methods.TUser is an optional type param to provide a type to the
-userfield.Type Parameters
Parameters
- context: Context<Auth0ContextInterface<User>> = Auth0Context
Returns Auth0ContextInterface<TUser>
Type Parameters
Parameters
context: Context<Auth0ContextInterface<User>> = Auth0Context
Returns Auth0ContextInterface<TUser>
- use
Function withAuth0
- with
Auth0<P>(Component, context?): ComponentType<Omit<P, "auth0">> class MyComponent extends Component {
render() {
// Access the auth context from the `auth0` prop
const { user } = this.props.auth0;
return <div>Hello {user.name}!</div>
}
}
// Wrap your class component in withAuth0
export default withAuth0(MyComponent); +withAuth0 | @auth0/auth0-react \ No newline at end of file +Function withAuth0
- with
Auth0<P>(Component, context?): ComponentType<Omit<P, "auth0">> class MyComponent extends Component {
render() {
// Access the auth context from the `auth0` prop
const { user } = this.props.auth0;
return <div>Hello {user.name}!</div>
}
}
// Wrap your class component in withAuth0
export default withAuth0(MyComponent);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
- P extends WithAuth0Props
Parameters
- Component: ComponentType<P>
- context: Context<Auth0ContextInterface<User>> = Auth0Context
Returns ComponentType<Omit<P, "auth0">>
Type Parameters
P extends WithAuth0Props
Parameters
Component: ComponentType<P>
context: Context<Auth0ContextInterface<User>> = Auth0Context
Returns ComponentType<Omit<P, "auth0">>
- with
Function withAuthenticationRequired
- with
Authentication Required<P>(Component, options?): FC<P> const MyProtectedComponent = withAuthenticationRequired(MyComponent); +withAuthenticationRequired | @auth0/auth0-react \ No newline at end of file +Function withAuthenticationRequired
- with
Authentication Required<P>(Component, options?): FC<P> const MyProtectedComponent = withAuthenticationRequired(MyComponent);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
Parameters
- Component: ComponentType<P>
- options: WithAuthenticationRequiredOptions = {}
Returns FC<P>
Type Parameters
P extends object
Parameters
Component: ComponentType<P>
options: WithAuthenticationRequiredOptions = {}
Returns FC<P>
- with
\ No newline at end of file
diff --git a/docs/index.html b/docs/index.html
index a5304100..b549e4d6 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,4 +1,4 @@
-
@auth0/auth0-react
@auth0/auth0-react
Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?
-This project is licensed under the MIT license. See the LICENSE file for more info.
Interface Auth0ContextInterface<TUser>
Contains the authenticated state and authentication methods provided by the useAuth0 hook.
interface Auth0ContextInterface<TUser> {
    error?: Error;
    getAccessTokenSilently: {
        (options): Promise<GetTokenSilentlyVerboseResponse>;
        (options?): Promise<string>;
        (options): Promise<string | GetTokenSilentlyVerboseResponse>;
    };
    getAccessTokenWithPopup: ((options?, config?) => Promise<undefined | string>);
    getIdTokenClaims: (() => Promise<undefined | IdToken>);
    handleRedirectCallback: ((url?) => Promise<RedirectLoginResult<any>>);
    isAuthenticated: boolean;
    isLoading: boolean;
    loginWithPopup: ((options?, config?) => Promise<void>);
    loginWithRedirect: ((options?) => Promise<void>);
    logout: ((options?) => Promise<void>);
    user?: TUser;
}
    error?: Error;
    getAccessTokenSilently: {
        (options): Promise<GetTokenSilentlyVerboseResponse>;
        (options?): Promise<string>;
        (options): Promise<string | GetTokenSilentlyVerboseResponse>;
    };
    getAccessTokenWithPopup: ((options?, config?) => Promise<undefined | string>);
    getIdTokenClaims: (() => Promise<undefined | IdToken>);
    handleRedirectCallback: ((url?) => Promise<RedirectLoginResult<any>>);
    isAuthenticated: boolean;
    isLoading: boolean;
    loginWithPopup: ((options?, config?) => Promise<void>);
    loginWithRedirect: ((options?) => Promise<void>);
    logout: ((options?) => Promise<void>);
    user?: TUser;
}
Type Parameters
Hierarchy
- AuthState<TUser>
- Auth0ContextInterface
Properties
Optional error
error?: Error
get
get
    (options): Promise<GetTokenSilentlyVerboseResponse>;
    (options?): Promise<string>;
    (options): Promise<string | GetTokenSilentlyVerboseResponse>;
}
    (options): Promise<GetTokenSilentlyVerboseResponse>;
    (options?): Promise<string>;
    (options): Promise<string | GetTokenSilentlyVerboseResponse>;
}
const token = await getAccessTokenSilently(options);
+Auth0ContextInterface | @auth0/auth0-react Interface Auth0ContextInterface<TUser>
Contains the authenticated state and authentication methods provided by the useAuth0 hook.
+
    error?: Error;
    getAccessTokenSilently: {
        (options): Promise<GetTokenSilentlyVerboseResponse>;
        (options?): Promise<string>;
        (options): Promise<string | GetTokenSilentlyVerboseResponse>;
    };
    getAccessTokenWithPopup: ((options?, config?) => Promise<undefined | string>);
    getIdTokenClaims: (() => Promise<undefined | IdToken>);
    handleRedirectCallback: ((url?) => Promise<RedirectLoginResult<any>>);
    isAuthenticated: boolean;
    isLoading: boolean;
    loginWithPopup: ((options?, config?) => Promise<void>);
    loginWithRedirect: ((options?) => Promise<void>);
    logout: ((options?) => Promise<void>);
    user?: TUser;
} Type Parameters
Hierarchy
- AuthState<TUser>
- Auth0ContextInterface
Properties
Optional error
error?: Errorget
get
    (options): Promise<GetTokenSilentlyVerboseResponse>;
    (options?): Promise<string>;
    (options): Promise<string | GetTokenSilentlyVerboseResponse>;
}Type declaration
- (options): Promise<GetTokenSilentlyVerboseResponse>
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
@@ -19,31 +19,61 @@
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.
+the SDK falls back to using an iframe to the '/authorize' URL.
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): Promise<GetTokenSilentlyVerboseResponse>
Parameters
- options: GetTokenSilentlyOptions & {
    detailedResponse: true;
}
Returns Promise<GetTokenSilentlyVerboseResponse>
- (options?): Promise<string>
Parameters
Optional options: GetTokenSilentlyOptions
Returns Promise<string>
- (options): Promise<string | GetTokenSilentlyVerboseResponse>
Parameters
- options: GetTokenSilentlyOptions
Returns Promise<string | GetTokenSilentlyVerboseResponse>
get
getconst token = await getTokenWithPopup(options, config);
+
Parameters
options: GetTokenSilentlyOptions & {
    detailedResponse: true;
}
Returns Promise<GetTokenSilentlyVerboseResponse>
- (options?): Promise<string>
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 falls back to using an iframe to the '/authorize' URL.
+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.
+Parameters
Optional options: GetTokenSilentlyOptions
Returns Promise<string>
- (options): Promise<string | GetTokenSilentlyVerboseResponse>
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 falls back to using an iframe to the '/authorize' URL.
+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.
+Parameters
options: GetTokenSilentlyOptions
Returns Promise<string | GetTokenSilentlyVerboseResponse>
get
getType declaration
- (options?, config?): Promise<undefined | string>
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.
-Type declaration
- (options?, config?): Promise<undefined | string>
Parameters
Optional options: GetTokenWithPopupOptionsOptional config: PopupConfigOptions
Returns Promise<undefined | string>
get
const claims = await getIdTokenClaims();
+
Parameters
Optional options: GetTokenWithPopupOptions
Optional config: PopupConfigOptions
Returns Promise<undefined | string>
get
Type declaration
- (): Promise<undefined | IdToken>
const claims = await getIdTokenClaims();
Returns all claims from the id_token if available.
-handle
handleAfter the browser redirects back to the callback page,
+
Returns Promise<undefined | IdToken>
handle
handleType declaration
- (url?): Promise<RedirectLoginResult<any>>
After the browser redirects back to the callback page,
call handleRedirectCallback to handle success and error
responses from Auth0. If the response is successful, results
will be valid according to their expiration times.
-Type declaration
- (url?): Promise<RedirectLoginResult<any>>
Parameters
Optional url: stringThe URL to that should be used to retrieve the state and code values. Defaults to window.location.href if not given.
-
Returns Promise<RedirectLoginResult<any>>
is
isis
islogin
loginawait loginWithPopup(options, config);
+
Parameters
Optional url: 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<RedirectLoginResult<any>>
is
isis
islogin
loginType declaration
- (options?, config?): Promise<void>
await loginWithPopup(options, config);
Opens a popup with the /authorize URL using the parameters
provided as arguments. Random and secure state and nonce
@@ -52,15 +82,15 @@
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.
-Type declaration
- (options?, config?): Promise<void>
Parameters
Optional options: PopupLoginOptionsOptional config: PopupConfigOptions
Returns Promise<void>
login
loginawait loginWithRedirect(options);
+
Parameters
Optional options: PopupLoginOptions
Optional config: PopupConfigOptions
Returns Promise<void>
login
loginType declaration
- (options?): 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.
-Type declaration
- (options?): Promise<void>
Parameters
Optional options: RedirectLoginOptions<AppState>
Returns Promise<void>
logout
logout: ((options?) => Promise<void>)auth0.logout({ logoutParams: { returnTo: window.location.origin } });
+
Parameters
Optional options: RedirectLoginOptions<AppState>
Returns Promise<void>
logout
logout: ((options?) => Promise<void>)Type declaration
- (options?): 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.
-Type declaration
- (options?): Promise<void>
Parameters
Optional options: LogoutOptions
Returns Promise<void>
Optional user
Parameters
Optional options: LogoutOptions
Returns Promise<void>
Optional user
user?: TUser
Interface Auth0ProviderOptions
The main configuration to instantiate the Auth0Provider.
interface Auth0ProviderOptions {
    auth0Client?: {
        env?: {
            [key: string]: string;
        };
        name: string;
        version: string;
    };
    authorizationParams?: AuthorizationParams;
    authorizeTimeoutInSeconds?: number;
    cache?: ICache;
    cacheLocation?: CacheLocation;
    children?: ReactNode;
    clientId: string;
    context?: Context<Auth0ContextInterface<User>>;
    cookieDomain?: string;
    domain: string;
    httpTimeoutInSeconds?: number;
    issuer?: string;
    leeway?: number;
    legacySameSiteCookie?: boolean;
    nowProvider?: (() => number | Promise<number>);
    onRedirectCallback?: ((appState?, user?) => void);
    sessionCheckExpiryDays?: number;
    skipRedirectCallback?: boolean;
    useCookiesForTransactions?: boolean;
    useFormData?: boolean;
    useRefreshTokens?: boolean;
    useRefreshTokensFallback?: boolean;
    workerUrl?: string;
}
    auth0Client?: {
        env?: {
            [key: string]: string;
        };
        name: string;
        version: string;
    };
    authorizationParams?: AuthorizationParams;
    authorizeTimeoutInSeconds?: number;
    cache?: ICache;
    cacheLocation?: CacheLocation;
    children?: ReactNode;
    clientId: string;
    context?: Context<Auth0ContextInterface<User>>;
    cookieDomain?: string;
    domain: string;
    httpTimeoutInSeconds?: number;
    issuer?: string;
    leeway?: number;
    legacySameSiteCookie?: boolean;
    nowProvider?: (() => number | Promise<number>);
    onRedirectCallback?: ((appState?, user?) => void);
    sessionCheckExpiryDays?: number;
    skipRedirectCallback?: boolean;
    useCookiesForTransactions?: boolean;
    useFormData?: boolean;
    useRefreshTokens?: boolean;
    useRefreshTokensFallback?: boolean;
    workerUrl?: string;
}
Hierarchy
- Auth0ClientOptions
- Auth0ProviderOptions
Index
Properties
auth0
Properties
Optional Internal auth0
auth0
    env?: {
        [key: string]: string;
    };
    name: string;
    version: string;
}
    env?: {
        [key: string]: string;
    };
    name: string;
    version: string;
}
Internal property to send information about the client to the authorization server.
-Type declaration
Optionalenv?: {
    [key: string]: string;
}[key: string]: string
name: string
version: string
Optional authorization
URL parameters that will be sent back to the Authorization Server. This can be known parameters +
Interface Auth0ProviderOptions
The main configuration to instantiate the Auth0Provider.
interface Auth0ProviderOptions {
    auth0Client?: {
        env?: {
            [key: string]: string;
        };
        name: string;
        version: string;
    };
    authorizationParams?: AuthorizationParams;
    authorizeTimeoutInSeconds?: number;
    cache?: ICache;
    cacheLocation?: CacheLocation;
    children?: ReactNode;
    clientId: string;
    context?: Context<Auth0ContextInterface<User>>;
    cookieDomain?: string;
    domain: string;
    httpTimeoutInSeconds?: number;
    issuer?: string;
    leeway?: number;
    legacySameSiteCookie?: boolean;
    nowProvider?: (() => number | Promise<number>);
    onRedirectCallback?: ((appState?, user?) => void);
    sessionCheckExpiryDays?: number;
    skipRedirectCallback?: boolean;
    useCookiesForTransactions?: boolean;
    useFormData?: boolean;
    useRefreshTokens?: boolean;
    useRefreshTokensFallback?: boolean;
    workerUrl?: string;
}
    auth0Client?: {
        env?: {
            [key: string]: string;
        };
        name: string;
        version: string;
    };
    authorizationParams?: AuthorizationParams;
    authorizeTimeoutInSeconds?: number;
    cache?: ICache;
    cacheLocation?: CacheLocation;
    children?: ReactNode;
    clientId: string;
    context?: Context<Auth0ContextInterface<User>>;
    cookieDomain?: string;
    domain: string;
    httpTimeoutInSeconds?: number;
    issuer?: string;
    leeway?: number;
    legacySameSiteCookie?: boolean;
    nowProvider?: (() => number | Promise<number>);
    onRedirectCallback?: ((appState?, user?) => void);
    sessionCheckExpiryDays?: number;
    skipRedirectCallback?: boolean;
    useCookiesForTransactions?: boolean;
    useFormData?: boolean;
    useRefreshTokens?: boolean;
    useRefreshTokensFallback?: boolean;
    workerUrl?: string;
}
Hierarchy
- Auth0ClientOptions
- Auth0ProviderOptions
Index
Properties
auth0
Properties
Optional Internal auth0
auth0
    env?: {
        [key: string]: string;
    };
    name: string;
    version: string;
}
    env?: {
        [key: string]: string;
    };
    name: string;
    version: string;
}
Internal property to send information about the client to the authorization server.
+Type declaration
Optionalenv?: {
    [key: string]: string;
}[key: string]: string
name: string
version: string
Optional authorization
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.
-Optional authorize
authorize
A maximum number of seconds to wait before declaring background calls to /authorize as failed for timeout +
Optional authorize
authorize
A maximum number of seconds to wait before declaring background calls to /authorize as failed for timeout Defaults to 60s.
-Optional cache
Specify a custom cache implementation to use for token storage and retrieval. This setting takes precedence over cacheLocation if they are both specified.
Optional cache
The location to use when storing cache data. Valid values are memory or localstorage.
+
Optional cache
Specify a custom cache implementation to use for token storage and retrieval. This setting takes precedence over cacheLocation if they are both specified.
Optional cache
The location to use when storing cache data. Valid values are memory or localstorage.
The default setting is memory.
Read more about changing storage options in the Auth0 docs
-Optional children
children?: ReactNode
The child nodes your Provider has wrapped
-client
client
The Client ID found on your Application settings page
-Optional context
Context to be used when creating the Auth0Provider, defaults to the internally created context.
+Optional children
children?: ReactNode
The child nodes your Provider has wrapped
+client
client
The Client ID found on your Application settings page
+Optional context
Context to be used when creating the Auth0Provider, defaults to the internally created context.
This allows multiple Auth0Providers to be nested within the same application, the context value can then be passed to useAuth0, withAuth0, or withAuthenticationRequired to use that specific Auth0Provider to access auth state and methods specifically tied to the provider that the context belongs to.
@@ -46,50 +46,50 @@ used to store data is differentFor a sample on using multiple Auth0Providers review the React Account Linking Sample
-Optional cookie
cookie
The domain the cookie is accessible from. If not set, the cookie is scoped to +
Optional cookie
cookie
The domain the cookie is accessible from. If not set, the cookie is scoped to the current domain, including the subdomain.
Note: setting this incorrectly may cause silent authentication to stop working on page load.
To keep a user logged in across multiple subdomains set this to your
top-level domain and prefixed with a . (eg: .example.com).
domain
domain: string
Your Auth0 account domain such as 'example.auth0.com',
+
domain
domain: string
Your Auth0 account domain such as 'example.auth0.com',
'example.eu.auth0.com' or , 'example.mycompany.com'
(when using custom domains)
Optional http
http
Specify the timeout for HTTP calls using fetch. The default is 10 seconds.
Optional issuer
issuer?: string
The issuer to be used for validation of JWTs, optionally defaults to the domain above
-Optional leeway
leeway?: number
The value in seconds used to account for clock skew in JWT expirations. +
Optional http
http
Specify the timeout for HTTP calls using fetch. The default is 10 seconds.
Optional issuer
issuer?: string
The issuer to be used for validation of JWTs, optionally defaults to the domain above
+Optional leeway
leeway?: number
The value in seconds used to account for clock skew in JWT expirations. Typically, this value is no more than a minute or two at maximum. Defaults to 60s.
-Optional legacy
legacy
Sets an additional cookie with no SameSite attribute to support legacy browsers +
Optional legacy
legacy
Sets an additional cookie with no SameSite attribute to support legacy browsers that are not compatible with the latest SameSite changes. This will log a warning on modern browsers, you can disable the warning by setting this to false but be aware that some older useragents will not work, See https://www.chromium.org/updates/same-site/incompatible-clients Defaults to true
-Optional now
now
Modify the value used as the current time during the token validation.
+Optional now
now
Type declaration
- (): number | Promise<number>
Modify the value used as the current time during the token validation.
Note: Using this improperly can potentially compromise the token validation.
-Type declaration
- (): number | Promise<number>
Returns number | Promise<number>
OptionalonRedirect Callback onRedirect Callback?: ((appState?, user?) => void) By default this removes the code and state parameters from the url when you are redirected from the authorize page. +
Returns number | Promise<number>
Optional on
on
Type declaration
- (appState?, user?): void
By default this removes the code and state parameters from the url when you are redirected from the authorize page. It uses
-window.historybut you might want to overwrite this if you are using a custom router, likereact-router-domSee the EXAMPLES.md for more info.Type declaration
- (appState?, user?): void
Returns void
OptionalsessionCheck Expiry Days sessionCheck Expiry Days?: number Number of days until the cookie
auth0.is.authenticatedwill expire +Returns void
Optional session
session
Number of days until the cookie auth0.is.authenticated will expire
Defaults to 1.
Optional skip
skip
By default, if the page url has code/state params, the SDK will treat them as Auth0's and attempt to exchange the +
Optional skip
skip
By default, if the page url has code/state params, the SDK will treat them as Auth0's and attempt to exchange the code for a token. In some cases the code might be for something else (another OAuth SDK perhaps). In these instances you can instruct the client to ignore them eg
<Auth0Provider
clientId={clientId}
domain={domain}
skipRedirectCallback={window.location.pathname === '/stripe-oauth-callback'}
>
Optional use
use
If true, the SDK will use a cookie when storing information about the auth transaction while
+
Optional use
use
If true, the SDK will use a cookie when storing information about the auth transaction while
the user is going through the authentication flow on the authorization server.
The default is false, in which case the SDK will use session storage.
Notes
You might want to enable this if you rely on your users being able to authenticate using flows that may end up spanning across multiple tabs (e.g. magic links) or you cannot otherwise rely on session storage being available.
-Optional use
use
If true, data to the token endpoint is transmitted as x-www-form-urlencoded data, if false it will be transmitted as JSON. The default setting is true.
Optional use
use
If true, data to the token endpoint is transmitted as x-www-form-urlencoded data, if false it will be transmitted as JSON. The default setting is true.
Note: Setting this to false may affect you if you use Auth0 Rules and are sending custom, non-primitive data. If you disable this,
please verify that your Auth0 Rules continue to work as intended.
Optional use
use
If true, refresh tokens are used to fetch new access tokens from the Auth0 server. If false, the legacy technique of using a hidden iframe and the authorization_code grant with prompt=none is used.
+
Optional use
use
If true, refresh tokens are used to fetch new access tokens from the Auth0 server. If false, the legacy technique of using a hidden iframe and the authorization_code grant with prompt=none is used.
The default setting is false.
Note: Use of refresh tokens must be enabled by an administrator on your Auth0 client application.
-Optional use
use
If true, fallback to the technique of using a hidden iframe and the authorization_code grant with prompt=none when unable to use refresh tokens. If false, the iframe fallback is not used and
+
Optional use
use
If true, fallback to the technique of using a hidden iframe and the authorization_code grant with prompt=none when unable to use refresh tokens. If false, the iframe fallback is not used and
errors relating to a failed refresh_token grant should be handled appropriately. The default setting is false.
Note: There might be situations where doing silent auth with a Web Message response from an iframe is not possible, like when you're serving your application from the file system or a custom protocol (like in a Desktop or Native app). @@ -97,9 +97,9 @@
E.g. Using the file: protocol in an Electron application does not support that legacy technique.
Example
let token: string;
try {
token = await auth0.getTokenSilently();
} catch (e) {
if (e.error === 'missing_refresh_token' || e.error === 'invalid_grant') {
auth0.loginWithRedirect();
}
}
Optional worker
worker
If provided, the SDK will load the token worker from this URL instead of the integrated blob. An example of when this is useful is if you have strict
+
Optional worker
worker
If provided, the SDK will load the token worker from this URL instead of the integrated blob. An example of when this is useful is if you have strict
Content-Security-Policy (CSP) and wish to avoid needing to set worker-src: blob:. We recommend either serving the worker, which you can find in the module
at <module_path>/dist/auth0-spa-js.worker.production.js, from the same host as your application or using the Auth0 CDN
https://cdn.auth0.com/js/auth0-spa-js/<version>/auth0-spa-js.worker.production.js.
Note: The worker is only used when useRefreshTokens: true, cacheLocation: 'memory', and the cache is not custom.
Interface AuthorizationParams
interface AuthorizationParams {
    acr_values?: string;
    audience?: string;
    connection?: string;
    display?: "page" | "popup" | "touch" | "wap";
    id_token_hint?: string;
    invitation?: string;
    login_hint?: string;
    max_age?: string | number;
    organization?: string;
    prompt?: "none" | "login" | "consent" | "select_account";
    redirect_uri?: string;
    scope?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: string]: any;
}
    acr_values?: string;
    audience?: string;
    connection?: string;
    display?: "page" | "popup" | "touch" | "wap";
    id_token_hint?: string;
    invitation?: string;
    login_hint?: string;
    max_age?: string | number;
    organization?: string;
    prompt?: "none" | "login" | "consent" | "select_account";
    redirect_uri?: string;
    scope?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: string]: any;
}
Indexable
[key: string]: any
If you need to send custom parameters to the Authorization Server, +
Interface AuthorizationParams
interface AuthorizationParams {
    acr_values?: string;
    audience?: string;
    connection?: string;
    display?: "page" | "popup" | "touch" | "wap";
    id_token_hint?: string;
    invitation?: string;
    login_hint?: string;
    max_age?: string | number;
    organization?: string;
    prompt?: "none" | "login" | "consent" | "select_account";
    redirect_uri?: string;
    scope?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: string]: any;
}
    acr_values?: string;
    audience?: string;
    connection?: string;
    display?: "page" | "popup" | "touch" | "wap";
    id_token_hint?: string;
    invitation?: string;
    login_hint?: string;
    max_age?: string | number;
    organization?: string;
    prompt?: "none" | "login" | "consent" | "select_account";
    redirect_uri?: string;
    scope?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: string]: any;
}
Indexable
[key: string]: any
If you need to send custom parameters to the Authorization Server, make sure to use the original parameter name.
- Index
Properties
Properties
Optional acr_
acr_
Optional audience
audience?: string
The default audience to be used for requesting API access.
-Optional connection
connection?: string
The name of the connection configured for your application. +
Index
Properties
Properties
Optional acr_
acr_
Optional audience
audience?: string
The default audience to be used for requesting API access.
+Optional connection
connection?: string
The name of the connection configured for your application. If null, it will redirect to the Auth0 Login Page and show the Login Widget.
-Optional display
display?: "page" | "popup" | "touch" | "wap"
-
+
Optional display
display?: "page" | "popup" | "touch" | "wap"
'page': displays the UI with a full page view'popup': displays the UI with a popup window'touch': displays the UI in a way that leverages a touch interface'wap': displays the UI with a "feature phone" type interface
Optional id_
id_
Previously issued ID Token.
-Optional invitation
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.
-Optional login_
login_
The user's email address or other identifier. When your app knows +
Optional id_
id_
Previously issued ID Token.
+Optional invitation
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.
+Optional login_
login_
The user's email address or other identifier. When your app knows which user is trying to authenticate, you can provide this parameter to pre-fill the email box or select the right session for sign-in.
This currently only affects the classic Lock experience.
-Optional max_
max_
Maximum allowable elapsed time (in seconds) since authentication. +
Optional max_
max_
Maximum allowable elapsed time (in seconds) since authentication. If the last time the user authenticated is greater than this value, the user must be reauthenticated.
-Optional organization
organization?: string
The organization to log in to.
+Optional organization
organization?: string
The organization to log in to.
This will specify an organization parameter in your user's login request.
- If you provide an Organization ID (a string with the prefix
org_), it will be validated against theorg_idclaim of your user's ID Token. The validation is case-sensitive. - If you provide an Organization Name (a string without the prefix
org_), it will be validated against theorg_nameclaim of your user's ID Token. The validation is case-insensitive.
Optional prompt
prompt?: "none" | "login" | "consent" | "select_account"
-
+
Optional prompt
prompt?: "none" | "login" | "consent" | "select_account"
'none': do not prompt user for login or consent on reauthentication'login': prompt user for reauthentication'consent': prompt user for consent before processing request'select_account': prompt user to select an account
Optional redirect_
redirect_
The default URL where Auth0 will redirect your browser to with +
Optional redirect_
redirect_
The default URL where Auth0 will redirect your browser to with the authentication result. It must be whitelisted in the "Allowed Callback URLs" field in your Auth0 Application's settings. If not provided here, it should be provided in the other methods that provide authentication.
-Optional scope
scope?: string
The default scope to be used on authentication requests.
+Optional scope
scope?: string
The default scope to be used on authentication requests.
This defaults to profile email if not set. If you are setting extra scopes and require
profile and email to be included then you must include them in the provided scope.
Note: The openid scope is always applied regardless of this setting.
Optional screen_
screen_
Provides a hint to Auth0 as to what flow should be displayed. +
Optional screen_
screen_
Provides a hint to Auth0 as to what flow should be displayed. The default behavior is to show a login page but you can override this by passing 'signup' to show the signup page instead.
This only affects the New Universal Login Experience.
-Optional ui_
ui_
The space-separated list of language tags, ordered by preference. +
Optional ui_
ui_
The space-separated list of language tags, ordered by preference.
For example: 'fr-CA fr en'.
Interface GetTokenSilentlyOptions
interface GetTokenSilentlyOptions {
    authorizationParams?: {
        audience?: string;
        redirect_uri?: string;
        scope?: string;
        [key: string]: any;
    };
    cacheMode?: "on" | "off" | "cache-only";
    detailedResponse?: boolean;
    timeoutInSeconds?: number;
}
    authorizationParams?: {
        audience?: string;
        redirect_uri?: string;
        scope?: string;
        [key: string]: any;
    };
    cacheMode?: "on" | "off" | "cache-only";
    detailedResponse?: boolean;
    timeoutInSeconds?: number;
}
Index
Properties
Properties
Optional authorization
authorization
    audience?: string;
    redirect_uri?: string;
    scope?: string;
    [key: string]: any;
}
    audience?: string;
    redirect_uri?: string;
    scope?: string;
    [key: string]: any;
}
Parameters that will be sent back to Auth0 as part of a request.
+Interface GetTokenSilentlyOptions
interface GetTokenSilentlyOptions {
    authorizationParams?: {
        audience?: string;
        redirect_uri?: string;
        scope?: string;
        [key: string]: any;
    };
    cacheMode?: "on" | "off" | "cache-only";
    detailedResponse?: boolean;
    timeoutInSeconds?: number;
}
    authorizationParams?: {
        audience?: string;
        redirect_uri?: string;
        scope?: string;
        [key: string]: any;
    };
    cacheMode?: "on" | "off" | "cache-only";
    detailedResponse?: boolean;
    timeoutInSeconds?: number;
}
Index
Properties
Properties
Optional authorization
authorization
    audience?: string;
    redirect_uri?: string;
    scope?: string;
    [key: string]: any;
}
    audience?: string;
    redirect_uri?: string;
    scope?: string;
    [key: string]: any;
}
Parameters that will be sent back to Auth0 as part of a request.
Type declaration
[key: string]: any
If you need to send custom parameters to the Authorization Server, make sure to use the original parameter name.
Optionalaudience?: stringThe audience that was used in the authentication request
@@ -13,13 +13,13 @@ It must be whitelisted in the "Allowed Web Origins" in your Auth0 Application's settings.Optionalscope?: stringThe scope that was used in the authentication request
-
Optional cache
cache
When off, ignores the cache and always sends a
+
Optional cache
cache
When off, ignores the cache and always sends a
request to Auth0.
When cache-only, only reads from the cache and never sends a request to Auth0.
Defaults to on, where it both reads from the cache and sends a request to Auth0 as needed.
Optional detailed
detailed
If true, the full response from the /oauth/token endpoint (or the cache, if the cache was used) is returned +
Optional detailed
detailed
If true, the full response from the /oauth/token endpoint (or the cache, if the cache was used) is returned
(minus refresh_token if one was issued). Otherwise, just the access token is returned.
The default is false.
Optional timeout
timeout
A maximum number of seconds to wait before declaring the background /authorize call as failed for timeout +
Optional timeout
timeout
A maximum number of seconds to wait before declaring the background /authorize call as failed for timeout Defaults to 60s.
-Interface GetTokenWithPopupOptions
interface GetTokenWithPopupOptions {
    authorizationParams?: AuthorizationParams;
    cacheMode?: "on" | "off" | "cache-only";
}
    authorizationParams?: AuthorizationParams;
    cacheMode?: "on" | "off" | "cache-only";
}
Hierarchy (view full)
- PopupLoginOptions
- GetTokenWithPopupOptions
Index
Properties
Properties
Optional authorization
URL parameters that will be sent back to the Authorization Server. This can be known parameters +
Interface GetTokenWithPopupOptions
interface GetTokenWithPopupOptions {
    authorizationParams?: AuthorizationParams;
    cacheMode?: "on" | "off" | "cache-only";
}
    authorizationParams?: AuthorizationParams;
    cacheMode?: "on" | "off" | "cache-only";
}
Hierarchy
- PopupLoginOptions
- GetTokenWithPopupOptions
Index
Properties
Properties
Optional authorization
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.
-Optional cache
cache
When off, ignores the cache and always sends a request to Auth0.
+
Optional cache
cache
When off, ignores the cache and always sends a request to Auth0.
When cache-only, only reads from the cache and never sends a request to Auth0.
Defaults to on, where it both reads from the cache and sends a request to Auth0 as needed.
\ No newline at end of file
+
Interface ICache
interface ICache {
    allKeys?(): MaybePromise<string[]>;
    get<T>(key): MaybePromise<undefined | T>;
    remove(key): MaybePromise<void>;
    set<T>(key, entry): MaybePromise<void>;
}
    allKeys?(): MaybePromise<string[]>;
    get<T>(key): MaybePromise<undefined | T>;
    remove(key): MaybePromise<void>;
    set<T>(key, entry): MaybePromise<void>;
}
Implemented by
Methods
Optional all
get
- get<T>(key): MaybePromise<undefined | T>
Type Parameters
T = Cacheable
Parameters
key: string
Returns MaybePromise<undefined | T>
remove
set
- set<T>(key, entry): MaybePromise<void>
Type Parameters
T = Cacheable
Parameters
key: string
entry: T
Returns MaybePromise<void>
Interface IdToken
interface IdToken {
    __raw: string;
    acr?: string;
    address?: string;
    amr?: string[];
    at_hash?: string;
    aud?: string;
    auth_time?: string;
    azp?: string;
    birthdate?: string;
    c_hash?: string;
    cnf?: string;
    email?: string;
    email_verified?: boolean;
    exp?: number;
    family_name?: string;
    gender?: string;
    given_name?: string;
    iat?: number;
    iss?: string;
    jti?: string;
    locale?: string;
    middle_name?: string;
    name?: string;
    nbf?: number;
    nickname?: string;
    nonce?: string;
    org_id?: string;
    org_name?: string;
    phone_number?: string;
    phone_number_verified?: boolean;
    picture?: string;
    preferred_username?: string;
    profile?: string;
    sid?: string;
    sub_jwk?: string;
    updated_at?: string;
    website?: string;
    zoneinfo?: string;
    [key: string]: any;
}
    __raw: string;
    acr?: string;
    address?: string;
    amr?: string[];
    at_hash?: string;
    aud?: string;
    auth_time?: string;
    azp?: string;
    birthdate?: string;
    c_hash?: string;
    cnf?: string;
    email?: string;
    email_verified?: boolean;
    exp?: number;
    family_name?: string;
    gender?: string;
    given_name?: string;
    iat?: number;
    iss?: string;
    jti?: string;
    locale?: string;
    middle_name?: string;
    name?: string;
    nbf?: number;
    nickname?: string;
    nonce?: string;
    org_id?: string;
    org_name?: string;
    phone_number?: string;
    phone_number_verified?: boolean;
    picture?: string;
    preferred_username?: string;
    profile?: string;
    sid?: string;
    sub_jwk?: string;
    updated_at?: string;
    website?: string;
    zoneinfo?: string;
    [key: string]: any;
}
Indexable
[key: string]: any
Index
Properties
__raw
-acr?
-address?
-amr?
-at_
Properties
__raw
__raw: string
Optional acr
acr?: string
Optional address
address?: string
Optional amr
amr?: string[]
Optional at_
at_
Optional aud
aud?: string
Optional auth_
auth_
Optional azp
azp?: string
Optional birthdate
birthdate?: string
Optional c_
c_
Optional cnf
cnf?: string
Optional email
email?: string
Optional email_
email_
Optional exp
exp?: number
Optional family_
family_
Optional gender
gender?: string
Optional given_
given_
Optional iat
iat?: number
Optional iss
iss?: string
Optional jti
jti?: string
Optional locale
locale?: string
Optional middle_
middle_
Optional name
name?: string
Optional nbf
nbf?: number
Optional nickname
nickname?: string
Optional nonce
nonce?: string
Optional org_
org_
Optional org_
org_
Optional phone_
phone_
Optional phone_
phone_
Optional picture
picture?: string
Optional preferred_
preferred_
Optional profile
profile?: string
Optional sid
sid?: string
Optional sub_
sub_
Optional updated_
updated_
Optional website
website?: string
Optional zoneinfo
zoneinfo?: string
Interface IdToken
interface IdToken {
    __raw: string;
    acr?: string;
    address?: string;
    amr?: string[];
    at_hash?: string;
    aud?: string;
    auth_time?: string;
    azp?: string;
    birthdate?: string;
    c_hash?: string;
    cnf?: string;
    email?: string;
    email_verified?: boolean;
    exp?: number;
    family_name?: string;
    gender?: string;
    given_name?: string;
    iat?: number;
    iss?: string;
    jti?: string;
    locale?: string;
    middle_name?: string;
    name?: string;
    nbf?: number;
    nickname?: string;
    nonce?: string;
    org_id?: string;
    org_name?: string;
    phone_number?: string;
    phone_number_verified?: boolean;
    picture?: string;
    preferred_username?: string;
    profile?: string;
    sid?: string;
    sub_jwk?: string;
    updated_at?: string;
    website?: string;
    zoneinfo?: string;
    [key: string]: any;
}
    __raw: string;
    acr?: string;
    address?: string;
    amr?: string[];
    at_hash?: string;
    aud?: string;
    auth_time?: string;
    azp?: string;
    birthdate?: string;
    c_hash?: string;
    cnf?: string;
    email?: string;
    email_verified?: boolean;
    exp?: number;
    family_name?: string;
    gender?: string;
    given_name?: string;
    iat?: number;
    iss?: string;
    jti?: string;
    locale?: string;
    middle_name?: string;
    name?: string;
    nbf?: number;
    nickname?: string;
    nonce?: string;
    org_id?: string;
    org_name?: string;
    phone_number?: string;
    phone_number_verified?: boolean;
    picture?: string;
    preferred_username?: string;
    profile?: string;
    sid?: string;
    sub_jwk?: string;
    updated_at?: string;
    website?: string;
    zoneinfo?: string;
    [key: string]: any;
}
Indexable
[key: string]: any
Index
Properties
__raw
+acr?
+address?
+amr?
+at_
Properties
__raw
__raw: string
Optional acr
acr?: string
Optional address
address?: string
Optional amr
amr?: string[]
Optional at_
at_
Optional aud
aud?: string
Optional auth_
auth_
Optional azp
azp?: string
Optional birthdate
birthdate?: string
Optional c_
c_
Optional cnf
cnf?: string
Optional email
email?: string
Optional email_
email_
Optional exp
exp?: number
Optional family_
family_
Optional gender
gender?: string
Optional given_
given_
Optional iat
iat?: number
Optional iss
iss?: string
Optional jti
jti?: string
Optional locale
locale?: string
Optional middle_
middle_
Optional name
name?: string
Optional nbf
nbf?: number
Optional nickname
nickname?: string
Optional nonce
nonce?: string
Optional org_
org_
Optional org_
org_
Optional phone_
phone_
Optional phone_
phone_
Optional picture
picture?: string
Optional preferred_
preferred_
Optional profile
profile?: string
Optional sid
sid?: string
Optional sub_
sub_
Optional updated_
updated_
Optional website
website?: string
Optional zoneinfo
zoneinfo?: string
Interface LogoutOptions
interface LogoutOptions {
    clientId?: null | string;
    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    };
    openUrl?: false | ((url) => void | Promise<void>);
}
    clientId?: null | string;
    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    };
    openUrl?: false | ((url) => void | Promise<void>);
}
Hierarchy
- Omit<SPALogoutOptions, "onRedirect">
- LogoutOptions
Index
Properties
Properties
Optional client
client
The clientId of your application.
Interface LogoutOptions
interface LogoutOptions {
    clientId?: null | string;
    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    };
    openUrl?: false | ((url) => void | Promise<void>);
}
    clientId?: null | string;
    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    };
    openUrl?: false | ((url) => void | Promise<void>);
}
Hierarchy
- Omit<SPALogoutOptions, "onRedirect">
- LogoutOptions
Index
Properties
Properties
Optional client
client
The clientId of your application.
If this property is not set, then the clientId that was used during initialization of the SDK is sent to the logout endpoint.
If this property is set to null, then no client ID value is sent to the logout endpoint.
Optional logout
logout
    federated?: boolean;
    returnTo?: string;
    [key: string]: any;
}
    federated?: boolean;
    returnTo?: string;
    [key: string]: any;
}
Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters +
Optional logout
logout
    federated?: boolean;
    returnTo?: string;
    [key: string]: any;
}
    federated?: boolean;
    returnTo?: string;
    [key: string]: any;
}
Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters you wish to provide.
Type declaration
[key: string]: any
If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.
Optionalfederated?: booleanWhen supported by the upstream identity provider, @@ -20,10 +20,10 @@
-returnToURL must be listed in the "Allowed Logout URLs" at the account level in the Auth0 dashboard.
Optional open
open
Used to control the redirect and not rely on the SDK to do the actual redirect.
+Optional open
open
Used to control the redirect and not rely on the SDK to do the actual redirect.
Set to false to disable the redirect, or provide a function to handle the actual redirect yourself.
Type declaration
- (url): void | Promise<void>
Parameters
- url: string
Returns void | Promise<void>
Example
await auth0.logout({
openUrl(url) {
window.location.replace(url);
}
});
+Type declaration
- (url): void | Promise<void>
Parameters
url: string
Returns void | Promise<void>
Example
await auth0.logout({
openUrl(url) {
window.location.replace(url);
}
});
Example
import { Browser } from '@capacitor/browser';
await auth0.logout({
async openUrl(url) {
await Browser.open({ url });
}
});
Interface LogoutUrlOptions
interface LogoutUrlOptions {
    clientId?: null | string;
    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    };
}
    clientId?: null | string;
    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    };
}
Index
Properties
Properties
Optional client
client
The clientId of your application.
Interface LogoutUrlOptions
interface LogoutUrlOptions {
    clientId?: null | string;
    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    };
}
    clientId?: null | string;
    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    };
}
Index
Properties
Properties
Optional client
client
The clientId of your application.
If this property is not set, then the clientId that was used during initialization of the SDK is sent to the logout endpoint.
If this property is set to null, then no client ID value is sent to the logout endpoint.
Optional logout
logout
    federated?: boolean;
    returnTo?: string;
    [key: string]: any;
}
    federated?: boolean;
    returnTo?: string;
    [key: string]: any;
}
Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters +
Optional logout
logout
    federated?: boolean;
    returnTo?: string;
    [key: string]: any;
}
    federated?: boolean;
    returnTo?: string;
    [key: string]: any;
}
Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters you wish to provide.
Type declaration
[key: string]: any
If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.
Optionalfederated?: booleanWhen supported by the upstream identity provider, @@ -19,4 +19,4 @@
-returnToURL must be listed in the "Allowed Logout URLs" at the account level in the Auth0 dashboard.
Interface PopupConfigOptions
Index
Properties
Properties
Optional popup
popup?: any
Accepts an already-created popup window to use. If not specified, the SDK +
Interface PopupConfigOptions
Index
Properties
Properties
Optional popup
popup?: any
Accepts an already-created popup window to use. If not specified, the SDK will create its own. This may be useful for platforms like iOS that have security restrictions around when popups can be invoked (e.g. from a user click event)
-Optional timeout
timeout
The number of seconds to wait for a popup response before +
Optional timeout
timeout
The number of seconds to wait for a popup response before throwing a timeout error. Defaults to 60s
-Interface PopupLoginOptions
Hierarchy (view full)
- BaseLoginOptions
- PopupLoginOptions
Index
Properties
Properties
Optional authorization
URL parameters that will be sent back to the Authorization Server. This can be known parameters +
Interface RedirectLoginOptions<TAppState>
interface RedirectLoginOptions<TAppState> {
    appState?: TAppState;
    authorizationParams?: AuthorizationParams;
    fragment?: string;
    openUrl?: ((url) => void | Promise<void>);
}
    appState?: TAppState;
    authorizationParams?: AuthorizationParams;
    fragment?: string;
    openUrl?: ((url) => void | Promise<void>);
}
Type Parameters
- TAppState = AppState
Hierarchy
- Omit<SPARedirectLoginOptions<TAppState>, "onRedirect">
- RedirectLoginOptions
Index
Properties
Properties
Optional app
Used to store state before doing the redirect
-Optional authorization
URL parameters that will be sent back to the Authorization Server. This can be known parameters +
Interface RedirectLoginOptions<TAppState>
interface RedirectLoginOptions {
    appState?: TAppState;
    authorizationParams?: AuthorizationParams;
    fragment?: string;
    openUrl?: ((url) => void | Promise<void>);
}
    appState?: TAppState;
    authorizationParams?: AuthorizationParams;
    fragment?: string;
    openUrl?: ((url) => void | Promise<void>);
}
Type Parameters
TAppState = AppState
Hierarchy
- Omit<SPARedirectLoginOptions<TAppState>, "onRedirect">
- RedirectLoginOptions
Index
Properties
Properties
Optional app
app
Used to store state before doing the redirect
+Optional authorization
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.
-Optional fragment
fragment?: string
Used to add to the URL fragment before redirecting
-Optional open
open
Used to control the redirect and not rely on the SDK to do the actual redirect.
-Type declaration
- (url): void | Promise<void>
Parameters
- url: string
Returns void | Promise<void>
Example
const client = new Auth0Client({
openUrl(url) {
window.location.replace(url);
}
});
+Optional fragment
fragment?: string
Used to add to the URL fragment before redirecting
+Optional open
open
Type declaration
- (url): void | Promise<void>
Used to control the redirect and not rely on the SDK to do the actual redirect.
+Parameters
url: string
Returns void | Promise<void>
Example
const client = new Auth0Client({
openUrl(url) {
window.location.replace(url);
}
});Example
-import { Browser } from '@capacitor/browser';
const client = new Auth0Client({
async openUrl(url) {
await Browser.open({ url });
}
});
Interface WithAuth0Props
Components wrapped in withAuth0 will have an additional auth0 prop
Index
Properties
auth0
-
Properties
auth0
Interface WithAuth0Props
Components wrapped in withAuth0 will have an additional auth0 prop
Index
Properties
auth0
+
Properties
auth0
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);
}
    context?: Context<Auth0ContextInterface<User>>;
    loginOptions?: RedirectLoginOptions<AppState>;
    onBeforeAuthentication?: (() => Promise<void>);
    onRedirecting?: (() => Element);
    returnTo?: string | (() => string);
}
Index
Properties
Properties
Optional context
The context to be used when calling useAuth0, this should only be provided if you are using multiple Auth0Providers +
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);
}
    context?: Context<Auth0ContextInterface<User>>;
    loginOptions?: RedirectLoginOptions<AppState>;
    onBeforeAuthentication?: (() => Promise<void>);
    onRedirecting?: (() => Element);
    returnTo?: string | (() => string);
}
Index
Properties
Properties
Optional context
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.
-Optional login
withAuthenticationRequired(Profile, {
loginOptions: {
appState: {
customProp: 'foo'
}
}
})
+Optional login
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.
Optional on
on
withAuthenticationRequired(Profile, {
onBeforeAuthentication: () => { analyticsLibrary.track('login_triggered'); }
})
+Optional on
on
Type declaration
- (): Promise<void>
withAuthenticationRequired(Profile, {
onBeforeAuthentication: () => { analyticsLibrary.track('login_triggered'); }
})Allows executing logic before the user is redirected to the login page.
-Type declaration
- (): Promise<void>
Returns Promise<void>
OptionalonRedirecting onRedirecting?: (() => Element) withAuthenticationRequired(Profile, {
onRedirecting: () => <div>Redirecting you to the login...</div>
}) +Returns Promise<void>
Optional on
on
Type declaration
- (): 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.
-Type declaration
- (): Element
Returns Element
OptionalreturnTo returnTo?: string | (() => string) withAuthenticationRequired(Profile, {
returnTo: '/profile'
}) +Returns Element
Optional return
return
withAuthenticationRequired(Profile, {
returnTo: '/profile'
})
or
withAuthenticationRequired(Profile, {
returnTo: () => window.location.hash.substr(1)
})
Add a path for the onRedirectCallback handler to return the user to after login.
Type declaration
- (): string
Returns string
Type declaration
- (): string
Returns string
@auth0/auth0-react
Index
Classes
Interfaces
Type Aliases
Functions
@auth0/auth0-react
Index
Classes
Interfaces
Type Aliases
Variables
Functions
Type alias AppState
App
    returnTo?: string;
    [key: string]: any;
}
    returnTo?: string;
    [key: string]: any;
}
The state of the application before the user was redirected to the login page.
-Type declaration
[key: string]: any
OptionalreturnTo?: string
Type alias AppState
App
    returnTo?: string;
    [key: string]: any;
}
    returnTo?: string;
    [key: string]: any;
}
The state of the application before the user was redirected to the login page.
+Type declaration
[key: string]: any
OptionalreturnTo?: string
Type alias CacheLocation
Cache
The possible locations where tokens can be stored
-Type alias CacheLocation
Cache
The possible locations where tokens can be stored
+Type alias Cacheable
Cacheable: WrappedCacheEntry | KeyManifestEntry
Type alias Cacheable
Cacheable: WrappedCacheEntry | KeyManifestEntry
Variable Auth0ContextConst
The Auth0 Context
+
Thrown when handling the redirect callback fails, will be one of Auth0's +
- Preparing search index...
- The search index is not available
@auth0/auth0-reactClass 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 full)
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
OptionalappState: anyReturns AuthenticationError
Properties
app
error
error_
message
name
Optionalstackstate
StaticOptionalprepareOptional override for formatting stack traces
-Type declaration
Parameters
Returns any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-StaticstackMethods
StaticcaptureCreate .stack property on a target object
-Parameters
OptionalconstructorOpt: FunctionReturns void
StaticfromParameters
    error: string;
    error_description: string;
}
error: string
error_
Returns GenericError
Settings
Member Visibility
Theme
On This Page