Class Fetcher<TOutput>
Type Parameters
- TOutput extends CustomFetchMinimalOutput
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Fetcher<TOutput>(config, hooks): Fetcher<TOutput> Type Parameters
- TOutput extends CustomFetchMinimalOutput
Parameters
- config: FetcherConfig<TOutput>
- hooks: FetcherHooks
Returns Fetcher<TOutput>
Methods
Protectedbuild
Protectedbuild
Protectedextract
fetch
Protectedget
Protectedget
Protectedhandle
Protectedhas
- has
Use Dpop Nonce Error(response): boolean Parameters
- response: TOutput
Returns boolean
Protectedinternal
Protectedis
Protectedprepare
Protectedset
Protectedset
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
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 LocalStorageCache
Implements
Index
Constructors
Methods
Constructors
constructor
- new
Local Storage Cache(): LocalStorageCache Returns LocalStorageCache
Class UseDpopNonceError
Hierarchy
- GenericError
- UseDpopNonceError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Use Dpop Nonce Error(newDpopNonce): UseDpopNonceError Parameters
- newDpopNonce: undefined | string
Returns UseDpopNonceError
Properties
error
error: string
error_
error_
message
message: string
name
name: string
new
new
Optionalstack
stack?: string
Staticstack
stack
The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will +not capture any frames.
+ Methods
Staticcapture
- capture
Stack Trace(targetObject, constructorOpt?): void Creates a
+.stackproperty ontargetObject, which when accessed returns +a string representing the location in the code at which +Error.captureStackTrace()was called.
+ +const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack` +The first line of the trace will be prefixed with +
+${myObject.name}: ${myObject.message}.The optional
+constructorOptargument accepts a function. If given, all frames +aboveconstructorOpt, includingconstructorOpt, will be omitted from the +generated stack trace.The
+constructorOptargument is useful for hiding implementation +details of error generation from the user. For instance:
+ +function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a(); +Parameters
- targetObject: object
OptionalconstructorOpt: Function
Returns void
Staticfrom
Staticprepare
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
Properties
Optionaladdress
address?: string
Optionalbirthdate
birthdate?: string
Optionalemail
email?: string
Optionalemail_
email_
Optionalfamily_
family_
Optionalgender
gender?: string
Optionalgiven_
given_
Optionallocale
locale?: string
Optionalmiddle_
middle_
Optionalname
name?: string
Optionalnickname
nickname?: string
Optionalphone_
phone_
Optionalphone_
phone_
Optionalpicture
picture?: string
Optionalpreferred_
preferred_
Optionalprofile
profile?: string
Optionalsub
sub?: string
Optionalupdated_
updated_
Optionalwebsite
website?: string
Optionalzoneinfo
zoneinfo?: string
\ No newline at end of file
+
diff --git a/docs/functions/createAuth0.html b/docs/functions/createAuth0.html
index 1fdc01d..8b8c6d9 100644
--- a/docs/functions/createAuth0.html
+++ b/docs/functions/createAuth0.html
@@ -1,5 +1,5 @@
-
Function createAuth0
- create
Auth0(clientOptions, pluginOptions?): Auth0Plugin Creates the Auth0 plugin.
-Parameters
clientOptions: Auth0VueClientOptions
The Auth Vue Client Options
-OptionalpluginOptions: Auth0PluginOptionsAdditional Plugin Configuration Options
-
Returns Auth0Plugin
An instance of Auth0Plugin
-
Function createAuth0
- create
Auth0(clientOptions, pluginOptions?): Auth0Plugin Creates the Auth0 plugin.
+Parameters
- clientOptions: Auth0VueClientOptions
The Auth Vue Client Options
+ OptionalpluginOptions: Auth0PluginOptionsAdditional Plugin Configuration Options
+
Returns Auth0Plugin
An instance of Auth0Plugin
+- clientOptions: Auth0VueClientOptions
Function createAuthGuard
- create
Auth Guard(app?): ((to) => Promise<boolean>) Parameters
Optionalapp: App<any>The vue application
-
Returns ((to) => Promise<boolean>)
- (to): Promise<boolean>
Parameters
to: RouteLocation
Returns Promise<boolean>
- create
Auth Guard(options?): ((to) => Promise<boolean>) Parameters
Optionaloptions: AuthGuardOptionsThe options used when creating an AuthGuard.
-
Returns ((to) => Promise<boolean>)
- (to): Promise<boolean>
Parameters
to: RouteLocation
Returns Promise<boolean>
Function createAuthGuard
- create
Auth Guard(app?): ((to: RouteLocation) => Promise<boolean>) Parameters
Optionalapp: App<any>The vue application
+
Returns ((to: RouteLocation) => Promise<boolean>)
- (to): Promise<boolean>
Parameters
- to: RouteLocation
Returns Promise<boolean>
- create
Auth Guard(options?): ((to: RouteLocation) => Promise<boolean>) Parameters
Optionaloptions: AuthGuardOptionsThe options used when creating an AuthGuard.
+
Returns ((to: RouteLocation) => Promise<boolean>)
- (to): Promise<boolean>
Parameters
- to: RouteLocation
Returns Promise<boolean>
Function useAuth0
- use
Auth0(): Auth0VueClient Returns the registered Auth0 instance using Vue's
+inject.useAuth0 | @auth0/auth0-vue \ No newline at end of file +Function useAuth0
- use
Auth0(): Auth0VueClient Returns the registered Auth0 instance using Vue's
inject.Returns Auth0VueClient
An instance of Auth0VueClient
-
- use
diff --git a/docs/index.html b/docs/index.html
index 44723f5..aa231a5 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,30 +1,33 @@
-
@auth0/auth0-vue
@auth0/auth0-vue
+
+
-
+
📚 Documentation - 🚀 Getting Started - 💻 API Reference - 💬 Feedback
-Documentation
-
-
- Quickstart - our interactive guide for quickly adding login, logout and user information to a Vue 3 app using Auth0. -
- Sample App - a full-fledged Vue 3 application integrated with Auth0. -
- FAQs - frequently asked questions about the auth0-vue SDK. -
- Examples - code samples for common Vue 3 authentication scenario's. -
- Docs site - explore our docs site and learn more about Auth0. +
- Quickstart - our interactive guide for quickly adding login, logout and user information to a Vue 3 app using Auth0. +
- Sample App - a full-fledged Vue 3 application integrated with Auth0. +
- FAQs - frequently asked questions about the auth0-vue SDK. +
- Examples - code samples for common Vue 3 authentication scenario's. +
- Docs site - explore our docs site and learn more about Auth0.
Documentation
-
+
Getting started
Requirements
This library supports Vue 3 applications. -For integrating Auth0 with a Vue 2 application, please read the Vue 2 Tutorial.
-Installation
Using npm:
-npm install @auth0/auth0-vue
-Using yarn:
-yarn add @auth0/auth0-vue
-Configure Auth0
Create a Single Page Application in the Auth0 Dashboard.
+Getting started
Requirements
This library supports Vue 3 applications. +For integrating Auth0 with a Vue 2 application, please read the Vue 2 Tutorial.
+Installation
Using npm:
+npm install @auth0/auth0-vue
+Using yarn:
+yarn add @auth0/auth0-vue
+Configure Auth0
Create a Single Page Application in the Auth0 Dashboard.
-If you're using an existing application, verify that you have configured the following settings in your Single Page Application:
+If you're using an existing application, verify that you have configured the following settings in your Single Page Application:
-
- Click on the "Settings" tab of your application's page.
+- Click on the "Settings" tab of your application's page.
- Scroll down and click on the "Show Advanced Settings" link.
- Under "Advanced Settings", click on the "OAuth" tab.
- Ensure that "JsonWebToken Signature Algorithm" is set to
@@ -37,43 +40,45 @@RS256and that "OIDC Conformant" is enabled.- Allowed Web Origins:
http://localhost:3000--These URLs should reflect the origins that your application is running on. Allowed Callback URLs may also include a path, depending on where you're handling the callback (see below).
+These URLs should reflect the origins that your application is running on. Allowed Callback URLs may also include a path, depending on where you're handling the callback (see below).
Take note of the Client ID and Domain values under the "Basic Information" section. You'll need these values in the next step.
-Configure the SDK
Create an instance of the
-Auth0Pluginby callingcreateAuth0and pass it to Vue'sapp.use().-import { createAuth0 } from '@auth0/auth0-vue';
const app = createApp(App);
app.use(
createAuth0({
domain: '<AUTH0_DOMAIN>',
clientId: '<AUTH0_CLIENT_ID>',
authorizationParams: {
redirect_uri: '<MY_CALLBACK_URL>'
}
})
);
app.mount('#app'); -Add login to your application
In order to add login to your application you can use the
-loginWithRedirectfunction that is exposed on the return value ofuseAuth0, which you can access in your component'ssetupfunction.-<script>
import { useAuth0 } from '@auth0/auth0-vue';
export default {
setup() {
const { loginWithRedirect } = useAuth0();
return {
login: () => {
loginWithRedirect();
}
};
}
};
</script> -Once setup returns the correct method, you can call that method from your component's HTML.
-+<template>
<div>
<button @click="login">Log in</button>
</div>
</template> -Take note of the Client ID and Domain values under the "Basic Information" section. You'll need these values in the next step.
+Configure the SDK
Create an instance of the
+Auth0Pluginby callingcreateAuth0and pass it to Vue'sapp.use().+ +import { createAuth0 } from '@auth0/auth0-vue';
const app = createApp(App);
app.use(
createAuth0({
domain: '<AUTH0_DOMAIN>',
clientId: '<AUTH0_CLIENT_ID>',
authorizationParams: {
redirect_uri: '<MY_CALLBACK_URL>'
}
})
);
app.mount('#app'); +Add login to your application
In order to add login to your application you can use the
+loginWithRedirectfunction that is exposed on the return value ofuseAuth0, which you can access in your component'ssetupfunction.+ +<script>
import { useAuth0 } from '@auth0/auth0-vue';
export default {
setup() {
const { loginWithRedirect } = useAuth0();
return {
login: () => {
loginWithRedirect();
}
};
}
};
</script> +Once setup returns the correct method, you can call that method from your component's HTML.
++<template>
<div>
<button @click="login">Log in</button>
</div>
</template> +- -Using Options API
+-<template>
<div>
<button @click="login">Log in</button>
</div>
</template>
<script>
export default {
methods: {
login() {
this.$auth0.loginWithRedirect();
}
}
};
</script> +<template>
<div>
<button @click="login">Log in</button>
</div>
</template>
<script>
export default {
methods: {
login() {
this.$auth0.loginWithRedirect();
}
}
};
</script> -For more code samples on how to integrate the auth0-vue SDK in your Vue 3 application, have a look at our examples.
-API reference
Explore public API's available in auth0-vue.
+For more code samples on how to integrate the auth0-vue SDK in your Vue 3 application, have a look at our examples.
+API reference
Explore public API's available in auth0-vue.
-
-- createAuth0
-- createAuthGuard
-- useAuth0
-- Auth0PluginOptions
-- Auth0VueClientOptions
-- Auth0VueClient
+- createAuth0
+- createAuthGuard
+- useAuth0
+- Auth0PluginOptions
+- Auth0VueClientOptions
+- Auth0VueClient
Feedback
Contributing
We appreciate feedback and contribution to this repo! Before you get started, please see the following:
+Feedback
Contributing
We appreciate feedback and contribution to this repo! Before you get started, please see the following:
-
-- Auth0's general contribution guidelines
-- Auth0's code of conduct guidelines
-- This repo's contribution guide
+- Auth0's general contribution guidelines
+- Auth0's code of conduct guidelines
+- This repo's contribution guide
Raise an issue
To provide feedback or report a bug, please raise an issue on our issue tracker.
-Vulnerability Reporting
Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.
+Raise an issue
To provide feedback or report a bug, please raise an issue on our issue tracker.
+Vulnerability Reporting
Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.
@@ -84,4 +89,4 @@ 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 AppState
Indexable
[key: string]: any
Any custom parameter to be stored in appState
- Index
Properties
target?
-
Properties
Optional target
target?: string
Target path the app gets routed to after -handling the callback from Auth0 (defaults to '/')
-Interface AppState
Indexable
- [key: string]: any
Any custom parameter to be stored in appState
+
Index
Properties
target?
+
Interface Auth0PluginOptions
Additional Configuration for the Auth0 Vue plugin
- Index
Properties
Properties
Optional error
error
Path in your application to redirect to when the Authorization server +
Interface Auth0PluginOptions
Additional Configuration for the Auth0 Vue plugin
+ Index
Properties
Properties
Optionalerror
error
Path in your application to redirect to when the Authorization server
returns an error. Defaults to /
Optional skip
skip
By default, if the page URL has code and state parameters, the SDK will assume it should handle it and attempt to exchange the code for a token.
+Optionalskip
skip
By default, if the page URL has code and state parameters, the SDK will assume it should handle it and attempt to exchange the code for a token.
In situations where you are combining our SDK with other libraries that use the same code and state parameters,
you will need to ensure our SDK can differentiate between requests it should and should not handle.
In these cases you can instruct the client to ignore certain URLs by setting skipRedirectCallback.
createAuth0({}, {
skipRedirectCallback: window.location.pathname === '/other-callback'
})
-createAuth0({}, {
skipRedirectCallback: window.location.pathname === '/other-callback'
})
+Note: In the above example, /other-callback is an existing route, with a code (or error in case when something went wrong) and state, that will be handled
by any other SDK.
Interface Auth0VueClient
interface Auth0VueClient {
error: Ref<any>;
idTokenClaims: Ref<undefined | IdToken>;
isAuthenticated: Ref<boolean>;
isLoading: Ref<boolean>;
user: Ref<undefined | User>;
checkSession(options?): Promise<void>;
getAccessTokenSilently(options): Promise<GetTokenSilentlyVerboseResponse>;
getAccessTokenSilently(options?): Promise<string>;
getAccessTokenWithPopup(options?, config?): Promise<undefined | string>;
handleRedirectCallback(url?): Promise<RedirectLoginResult<AppState>>;
loginWithPopup(options?, config?): Promise<void>;
loginWithRedirect(options?): Promise<void>;
logout(options?): Promise<void>;
}
error: Ref<any>;
idTokenClaims: Ref<undefined | IdToken>;
isAuthenticated: Ref<boolean>;
isLoading: Ref<boolean>;
user: Ref<undefined | User>;
checkSession(options?): Promise<void>;
getAccessTokenSilently(options): Promise<GetTokenSilentlyVerboseResponse>;
getAccessTokenSilently(options?): Promise<string>;
getAccessTokenWithPopup(options?, config?): Promise<undefined | string>;
handleRedirectCallback(url?): Promise<RedirectLoginResult<AppState>>;
loginWithPopup(options?, config?): Promise<void>;
loginWithRedirect(options?): Promise<void>;
logout(options?): Promise<void>;
}
Index
Properties
Methods
Properties
error
error: Ref<any>
Contains an error that occured in the SDK
-id
Contains all claims from the id_token if available.
-is
is
The authentication state, true if the user is authenticated, false if not.
is
is
The loading state of the SDK, true if the SDK is still processing the PKCE flow, false if the SDK has finished processing the PKCE flow.
user
Contains the information of the user if available.
-Methods
check
- check
Session(options?): Promise<void>
+await checkSession(); -Auth0VueClient | @auth0/auth0-vue \ No newline at end of file +Read more about how Logout works at Auth0. +Interface Auth0VueClient
interface Auth0VueClient {
error: Ref<any, any>;
idTokenClaims: Ref<undefined | IdToken, undefined | IdToken>;
isAuthenticated: Ref<boolean, boolean>;
isLoading: Ref<boolean, boolean>;
user: Ref<undefined | User, undefined | User>;
checkSession(options?: GetTokenSilentlyOptions): Promise<void>;
createFetcher<TOutput>(config?: FetcherConfig<TOutput>): Fetcher<TOutput>;
generateDpopProof(params: {
accessToken: string;
method: string;
nonce?: string;
url: string;
}): Promise<string>;
getAccessTokenSilently(options: GetTokenSilentlyOptions & {
detailedResponse: true;
}): Promise<GetTokenSilentlyVerboseResponse>;
getAccessTokenSilently(options?: GetTokenSilentlyOptions): Promise<string>;
getAccessTokenWithPopup(options?: GetTokenWithPopupOptions, config?: PopupConfigOptions): Promise<undefined | string>;
getDpopNonce(id?: string): Promise<undefined | string>;
handleRedirectCallback(url?: string): Promise<RedirectLoginResult<AppState> | ConnectAccountRedirectResult<AppState>>;
loginWithPopup(options?: PopupLoginOptions, config?: PopupConfigOptions): Promise<void>;
loginWithRedirect(options?: RedirectLoginOptions<AppState>): Promise<void>;
logout(options?: LogoutOptions): Promise<void>;
setDpopNonce(nonce: string, id?: string): Promise<void>;
}Index
Properties
error
error: Ref<any, any>Contains an error that occured in the SDK
+id
Token Claims Contains all claims from the id_token if available.
+is
Authenticated isAuthenticated: Ref<boolean, boolean> The authentication state,
+trueif the user is authenticated,falseif not.is
Loading isLoading: Ref<boolean, boolean> The loading state of the SDK,
+trueif the SDK is still processing the PKCE flow,falseif the SDK has finished processing the PKCE flow.user
Contains the information of the user if available.
+Methods
check
Session - check
Session(options?): Promise<void>
+await checkSession(); +Check if the user is logged in using
getTokenSilently. The difference -withgetTokenSilentlyis that this doesn't return a token, but it will +withgetTokenSilentlyis that this doesn't return a token, but it will pre-fill the token cache.This method also heeds the
-auth0.{clientId}.is.authenticatedcookie, as an optimization - to prevent calling Auth0 unnecessarily. If the cookie is not present because +to prevent calling Auth0 unnecessarily. If the cookie is not present because there was no previous login (or it has expired) then tokens will not be refreshed.Parameters
Optionaloptions: GetTokenSilentlyOptions
Returns Promise<void>
get
Access Token Silently - get
Access Token Silently(options): Promise<GetTokenSilentlyVerboseResponse> Fetches a new access token and returns the response from the /oauth/token endpoint, omitting the refresh token.
-Parameters
options: GetTokenSilentlyOptions & {
detailedResponse: true;
}
Returns Promise<GetTokenSilentlyVerboseResponse>
- get
Access Token Silently(options?): Promise<string> Fetches a new access token and returns it.
-Parameters
Optionaloptions: GetTokenSilentlyOptions
Returns Promise<string>
get
Access Token With Popup - get
Access Token With Popup(options?, config?): Promise<undefined | string>
+const token = await getTokenWithPopup(options); -Parameters
Optionaloptions: GetTokenSilentlyOptions
Returns Promise<void>
create
Fetcher - create
Fetcher<TOutput>(config?): Fetcher<TOutput>
+ +const fetcher = createFetcher({
dpopNonceId: 'my-api',
baseUrl: 'https://api.example.com'
});
const response = await fetcher.fetchWithAuth('/data', {
method: 'GET'
});
const data = await response.json(); +Creates a fetcher instance that automatically handles authentication for API requests.
+The fetcher automatically:
+-
+
- Retrieves access tokens using
getAccessTokenSilently()
+ - Adds proper
Authorizationheaders
+ - Generates and includes DPoP proofs when using DPoP tokens +
- Manages DPoP nonces and retries on nonce errors +
- Handles token refreshing +
This is the recommended way to make authenticated API calls, especially when using DPoP.
+Type Parameters
- TOutput extends CustomFetchMinimalOutput = Response
Parameters
Optionalconfig: FetcherConfig<TOutput>Configuration options for the fetcher
+
Returns Fetcher<TOutput>
- Retrieves access tokens using
generate
Dpop Proof - generate
Dpop Proof(params): Promise<string>
+ +const proof = await generateDpopProof({
url: 'https://api.example.com/data',
method: 'GET',
accessToken: token
}); +Generates a DPoP proof JWT that cryptographically binds an access token to the current client.
+The proof is a signed JWT that demonstrates possession of the private key associated with +the public key in the access token. This prevents token theft and replay attacks.
+Note: Requires
+useDpop: truein the Auth0 client configuration. +Most developers should usecreateFetcher()instead, which handles proof generation automatically.Parameters
- params: {
accessToken: string;
method: string;
nonce?: string;
url: string;
}Configuration for generating the proof
+access
Token: string The access token to bind to the proof
+method: string
The HTTP method (GET, POST, etc.)
+Optionalnonce?: stringOptional nonce value from a previous server response
+url: string
The target URL for the API request
+
Returns Promise<string>
- params: {
get
Access Token Silently - get
Access Token Silently(options): Promise<GetTokenSilentlyVerboseResponse> Fetches a new access token and returns the response from the /oauth/token endpoint, omitting the refresh token.
+Parameters
- options: GetTokenSilentlyOptions & {
detailedResponse: true;
}
Returns Promise<GetTokenSilentlyVerboseResponse>
- options: GetTokenSilentlyOptions & {
- get
Access Token Silently(options?): Promise<string> Fetches a new access token and returns it.
+Parameters
Optionaloptions: GetTokenSilentlyOptions
Returns Promise<string>
get
Access Token With Popup - get
Access Token With Popup(options?, config?): Promise<undefined | string>
+const token = await getTokenWithPopup(options); +Opens a popup with the
-/authorizeURL using the parameters provided as arguments. Random and securestateandnonceparameters will be auto-generated. If the response is successful, results will be valid according to their expiration times.Parameters
Optionaloptions: GetTokenWithPopupOptionsOptionalconfig: PopupConfigOptions
Returns Promise<undefined | string>
handle
Redirect Callback - handle
Redirect Callback(url?): Promise<RedirectLoginResult<AppState>> After the browser redirects back to the callback page, +
Parameters
Optionaloptions: GetTokenWithPopupOptionsOptionalconfig: PopupConfigOptions
Returns Promise<undefined | string>
get
Dpop Nonce - get
Dpop Nonce(id?): Promise<undefined | string>
+ +const nonce = await getDpopNonce(); +Retrieves the current DPoP nonce value for a specific identifier.
+The nonce is used to prevent replay attacks when using DPoP (Demonstrating Proof-of-Possession). +It may return
+undefinedinitially before the first server response.Note: Requires
+useDpop: truein the Auth0 client configuration.Parameters
Optionalid: stringOptional identifier for the nonce. If omitted, returns the nonce for Auth0 requests. +Use a custom identifier for tracking nonces for different API endpoints.
+
Returns Promise<undefined | string>
handle
Redirect Callback - handle
Redirect Callback(url?): Promise<RedirectLoginResult<AppState> | ConnectAccountRedirectResult<AppState>> After the browser redirects back to the callback page, call
handleRedirectCallbackto handle success and error responses from Auth0. If the response is successful, results will be valid according to their expiration times.Note: The Auth0-Vue SDK handles this for you, unless you set
-skipRedirectCallbackto true. In that case, be sure to explicitly callhandleRedirectCallbackyourself.Parameters
Optionalurl: string
Returns Promise<RedirectLoginResult<AppState>>
login
With Popup - login
With Popup(options?, config?): Promise<void>
+try {
await loginWithPopup(options);
} catch(e) {
if (e instanceof PopupCancelledError) {
// Popup was closed before login completed
}
} -Parameters
Optionalurl: string
Returns Promise<RedirectLoginResult<AppState> | ConnectAccountRedirectResult<AppState>>
login
With Popup - login
With Popup(options?, config?): Promise<void>
+try {
await loginWithPopup(options);
} catch(e) {
if (e instanceof PopupCancelledError) {
// Popup was closed before login completed
}
} +Opens a popup with the
/authorizeURL using the parameters provided as arguments. Random and securestateandnonceparameters will be auto-generated. If the response is successful, @@ -46,13 +89,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.
-Parameters
Optionaloptions: PopupLoginOptionsOptionalconfig: PopupConfigOptions
Returns Promise<void>
login
With Redirect - login
With Redirect(options?): Promise<void>
+await loginWithRedirect(options); -Parameters
Optionaloptions: PopupLoginOptionsOptionalconfig: PopupConfigOptions
Returns Promise<void>
login
With Redirect - login
With Redirect(options?): Promise<void>
+await loginWithRedirect(options); +Performs a redirect to
-/authorizeusing the parameters provided as arguments. Random and securestateandnonceparameters will be auto-generated.Parameters
Optionaloptions: RedirectLoginOptions<AppState>
Returns Promise<void>
logout
- logout(options?): Promise<void>
+logout(); -Parameters
Optionaloptions: RedirectLoginOptions<AppState>
Returns Promise<void>
logout
- logout(options?): Promise<void>
+logout(); +Clears the application session and performs a redirect to
/v2/logout, using the parameters provided as arguments, to clear the Auth0 session.Note: If you are using a custom cache, and specifying
@@ -60,5 +105,15 @@ If thelocalOnly: true, and you want to perform actions or read state from the SDK immediately after logout, you shouldawaitthe result of callinglogout.localOnlyoption is specified, it only clears the application session. It is invalid to set both thefederatedandlocalOnlyoptions totrue, and an error will be thrown if you do. -Read more about how Logout works at Auth0. -Parameters
Optionaloptions: LogoutOptions
Returns Promise<void>
Parameters
Optionaloptions: LogoutOptions
Returns Promise<void>
- check
set
- set
Dpop Nonce(nonce, id?): Promise<void>
+ +await setDpopNonce('new-nonce-value', 'my-api'); +Stores a DPoP nonce value for future use with a specific identifier.
+This is typically called automatically when the server provides a new nonce +in the
+DPoP-Nonceresponse header. Manual usage is only needed for advanced scenarios.Note: Requires
+useDpop: truein the Auth0 client configuration.Parameters
- nonce: string
The nonce value to store
+ Optionalid: stringOptional identifier for the nonce. If omitted, sets the nonce for Auth0 requests. +Use a custom identifier for managing nonces for different API endpoints.
+
Returns Promise<void>
- nonce: string
Interface Auth0VueClientOptions
Configuration for the Auth0 Vue Client
-interface Auth0VueClientOptions {
auth0Client?: {
env?: {
[key: string]: string;
};
name: string;
version: string;
};
authorizationParams?: AuthorizationParams;
authorizeTimeoutInSeconds?: number;
cache?: ICache;
cacheLocation?: CacheLocation;
clientId: string;
cookieDomain?: string;
domain: string;
httpTimeoutInSeconds?: number;
issuer?: string;
leeway?: number;
legacySameSiteCookie?: boolean;
nowProvider?: (() => number | Promise<number>);
sessionCheckExpiryDays?: number;
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;
clientId: string;
cookieDomain?: string;
domain: string;
httpTimeoutInSeconds?: number;
issuer?: string;
leeway?: number;
legacySameSiteCookie?: boolean;
nowProvider?: (() => number | Promise<number>);
sessionCheckExpiryDays?: number;
useCookiesForTransactions?: boolean;
useFormData?: boolean;
useRefreshTokens?: boolean;
useRefreshTokensFallback?: boolean;
workerUrl?: string;
}
Hierarchy
- Auth0ClientOptions
- Auth0VueClientOptions
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 Auth0VueClientOptions
Configuration for the Auth0 Vue Client
+interface Auth0VueClientOptions {
auth0Client?: {
env?: {
[key: string]: string;
};
name: string;
version: string;
};
authorizationParams?: ClientAuthorizationParams;
authorizeTimeoutInSeconds?: number;
cache?: ICache;
cacheLocation?: CacheLocation;
clientId: string;
cookieDomain?: string;
domain: string;
httpTimeoutInSeconds?: number;
issuer?: string;
leeway?: number;
legacySameSiteCookie?: boolean;
nowProvider?: (() => number | Promise<number>);
sessionCheckExpiryDays?: number;
useCookiesForTransactions?: boolean;
useDpop?: boolean;
useFormData?: boolean;
useMrrt?: boolean;
useRefreshTokens?: boolean;
useRefreshTokensFallback?: boolean;
workerUrl?: string;
}
auth0Client?: {
env?: {
[key: string]: string;
};
name: string;
version: string;
};
authorizationParams?: ClientAuthorizationParams;
authorizeTimeoutInSeconds?: number;
cache?: ICache;
cacheLocation?: CacheLocation;
clientId: string;
cookieDomain?: string;
domain: string;
httpTimeoutInSeconds?: number;
issuer?: string;
leeway?: number;
legacySameSiteCookie?: boolean;
nowProvider?: (() => number | Promise<number>);
sessionCheckExpiryDays?: number;
useCookiesForTransactions?: boolean;
useDpop?: boolean;
useFormData?: boolean;
useMrrt?: boolean;
useRefreshTokens?: boolean;
useRefreshTokensFallback?: boolean;
workerUrl?: string;
}
Hierarchy
- Auth0ClientOptions
- Auth0VueClientOptions
Index
Properties
auth0
Properties
Optional Internalauth0
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.
+Optionalauthorization
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 +
Optionalauthorize
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.
+
Optionalcache
Specify a custom cache implementation to use for token storage and retrieval. This setting takes precedence over cacheLocation if they are both specified.
Optionalcache
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
-client
client
The Client ID found on your Application settings page
-Optional cookie
cookie
The domain the cookie is accessible from. If not set, the cookie is scoped to +
Read more about changing storage options in the Auth0 docs
+client
client
The Client ID found on your Application settings page
+Optionalcookie
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',
-'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. +
domain
domain: string
Your Auth0 account domain such as 'example.auth0.com',
+'example.eu.auth0.com' or , 'example.mycompany.com'
+(when using custom domains)
Optionalhttp
http
Specify the timeout for HTTP calls using fetch. The default is 10 seconds.
Optionalissuer
issuer?: string
The issuer to be used for validation of JWTs, optionally defaults to the domain above
+Optionalleeway
leeway?: number
The value in seconds used to account for clock skew in JWT expirations. Typically, this value is no more than a minute or two at maximum. Defaults to 60s.
-Optional legacy
legacy
Sets an additional cookie with no SameSite attribute to support legacy browsers +
Optionallegacy
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 +See https://www.chromium.org/updates/same-site/incompatible-clients Defaults to true
-Optional now
now
Type declaration
- (): number | Promise<number>
Modify the value used as the current time during the token validation.
+OptionalnowProvider nowProvider?: (() => number | Promise<number>) Modify the value used as the current time during the token validation.
Note: Using this improperly can potentially compromise the token validation.
-Returns number | Promise<number>
Optional session
session
Number of days until the cookie auth0.is.authenticated will expire
+
Optionalsession
session
Number of days until the cookie auth0.is.authenticated will expire
Defaults to 1.
Optional use
use
If true, the SDK will use a cookie when storing information about the auth transaction while
+
Optionaluse
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 +
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.
Optionaluse
use
If true, DPoP (OAuth 2.0 Demonstrating Proof of Possession, RFC9449)
+will be used to cryptographically bind tokens to this specific browser
+so they can't be used from a different device in case of a leak.
The default setting is false.
Optionaluse
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.
+
Optionaluse
use
If true, the SDK will allow the refreshing of tokens using MRRT
Optionaluse
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
+
Optionaluse
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).
+like when you're serving your application from the file system or a custom protocol (like in a Desktop or Native app).
In situations like this you can disable the iframe fallback and handle the failed refresh_token grant and prompt the user to login interactively with loginWithRedirect or loginWithPopup."
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
+
Optionalworker
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.
Note: The worker is only used when useRefreshTokens: true, cacheLocation: 'memory', and the cache is not custom.
\ No newline at end of file
+
Interface AuthGuardOptions
The options used when creating an AuthGuard.
+ Index
Properties
Interface AuthorizationParams
interface AuthorizationParams {
acr_values?: string;
audience?: string;
connection?: string;
display?: "page" | "touch" | "popup" | "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" | "touch" | "popup" | "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"
| "touch"
| "popup"
| "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"
| "touch"
| "popup"
| "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
Optionalacr_
acr_
Optionalaudience
audience?: string
The default audience to be used for requesting API access.
+Optionalconnection
connection?: string
The name of the connection configured for your application. If null, it will redirect to the Auth0 Login Page and show the Login Widget.
-Optional display
display?: "page" | "touch" | "popup" | "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
+
Optionaldisplay
display?:
| "page"
| "touch"
| "popup"
| "wap"
| "page"
| "touch"
| "popup"
| "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 +
Optionalid_
id_
Previously issued ID Token.
+Optionalinvitation
invitation?: string
The Id of an invitation to accept. This is available from the user invitation URL that is given when participating in a user invitation flow.
+Optionallogin_
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. +
Optionalmax_
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.
-This will specify an organization parameter in your user's login request.
Optionalorganization
organization?: string
The organization to log in to.
+This will specify an organization parameter in your user's login request.
-
-
- If you provide an Organization ID (a string with the prefix
org_), it will be validated against 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.
+ - 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. +To use an Organization Name you must have "Allow Organization Names in Authentication API" switched on in your Auth0 settings dashboard. +More information is available on the Auth0 documentation portal
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
+
Optionalprompt
prompt?:
| "none"
| "login"
| "consent"
| "select_account"
| "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 +
Optionalredirect_
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 +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.
+Optionalscope
scope?: string
The default scope to be used on authentication requests.
This defaults to profile email if not set. If you are setting extra scopes and require
profile and email to be included then you must include them in the provided scope.
Note: The openid scope is always applied regardless of this setting.
Optional screen_
screen_
Provides a hint to Auth0 as to what flow should be displayed. +
Optionalscreen_
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 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.
-For example: 'fr-CA fr en'.
Optionalui_
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?: "off" | "on" | "cache-only";
detailedResponse?: boolean;
timeoutInSeconds?: number;
}
authorizationParams?: {
audience?: string;
redirect_uri?: string;
scope?: string;
[key: string]: any;
};
cacheMode?: "off" | "on" | "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?: "off" | "on" | "cache-only";
detailedResponse?: boolean;
timeoutInSeconds?: number;
}
authorizationParams?: {
audience?: string;
redirect_uri?: string;
scope?: string;
[key: string]: any;
};
cacheMode?: "off" | "on" | "cache-only";
detailedResponse?: boolean;
timeoutInSeconds?: number;
}
Index
Properties
Properties
Optionalauthorization
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
-Optionalredirect_uri?: string There's no actual redirect when getting a token silently, +
Optionalaudience?: stringThe audience that was used in the authentication request
+Optionalredirect_uri?: string There's no actual redirect when getting a token silently, but, according to the spec, a
-redirect_uriparam is required. Auth0 uses this parameter to validate that the currentoriginmatches theredirect_urioriginwhen sending the response. 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
+Auth0 Application's settings.
Optionalscope?: string
The scope that was used in the authentication request
+Optionalcache
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 +
Optionaldetailed
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 +
Optionaltimeout
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?: "off" | "on" | "cache-only";
}
authorizationParams?: AuthorizationParams;
cacheMode?: "off" | "on" | "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 +
Interface GetTokenWithPopupOptions
interface GetTokenWithPopupOptions {
authorizationParams?: AuthorizationParams;
cacheMode?: "off" | "on" | "cache-only";
}
authorizationParams?: AuthorizationParams;
cacheMode?: "off" | "on" | "cache-only";
}
Hierarchy (view full)
- PopupLoginOptions
- GetTokenWithPopupOptions
Index
Properties
Properties
Optionalauthorization
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.
+
Optionalcache
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.
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>
diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html
index 11f999c..8c5242f 100644
--- a/docs/interfaces/IdToken.html
+++ b/docs/interfaces/IdToken.html
@@ -1,39 +1,39 @@
-
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
Optionalacr
acr?: string
Optionaladdress
address?: string
Optionalamr
amr?: string[]
Optionalat_
at_
Optionalaud
aud?: string
Optionalauth_
auth_
Optionalazp
azp?: string
Optionalbirthdate
birthdate?: string
Optionalc_
c_
Optionalcnf
cnf?: string
Optionalemail
email?: string
Optionalemail_
email_
Optionalexp
exp?: number
Optionalfamily_
family_
Optionalgender
gender?: string
Optionalgiven_
given_
Optionaliat
iat?: number
Optionaliss
iss?: string
Optionaljti
jti?: string
Optionallocale
locale?: string
Optionalmiddle_
middle_
Optionalname
name?: string
Optionalnbf
nbf?: number
Optionalnickname
nickname?: string
Optionalnonce
nonce?: string
Optionalorg_
org_
Optionalorg_
org_
Optionalphone_
phone_
Optionalphone_
phone_
Optionalpicture
picture?: string
Optionalpreferred_
preferred_
Optionalprofile
profile?: string
Optionalsid
sid?: string
Optionalsub_
sub_
Optionalupdated_
updated_
Optionalwebsite
website?: string
Optionalzoneinfo
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: string) => void | Promise<void>);
}
clientId?: null | string;
logoutParams?: {
federated?: boolean;
returnTo?: string;
[key: string]: any;
};
openUrl?: false | ((url: string) => void | Promise<void>);
}
Hierarchy
- Omit<SPALogoutOptions, "onRedirect">
- LogoutOptions
Index
Properties
Properties
Optionalclient
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 +
+Optionallogout
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, +
Optionalfederated?: booleanWhen supported by the upstream identity provider, forces the user to logout of their identity provider and from Auth0. -Read more about how federated logout works at Auth0
-OptionalreturnTo?: string The URL where Auth0 will redirect your browser to after the logout.
+Read more about how federated logout works at Auth0 +OptionalreturnTo?: string The URL where Auth0 will redirect your browser to after the logout.
Note: If the
- -client_idparameter is included, thereturnToURL that is provided must be listed in the -Application's "Allowed Logout URLs" in the Auth0 dashboard. +Application's "Allowed Logout URLs" in the Auth0 dashboard. However, if theclient_idparameter is not included, thereturnToURL 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.
+ +Optionalopen
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);
}
});
-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
Optionalclient
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 +
+Optionallogout
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, +
Optionalfederated?: booleanWhen supported by the upstream identity provider, forces the user to logout of their identity provider and from Auth0. -Read more about how federated logout works at Auth0
-OptionalreturnTo?: string The URL where Auth0 will redirect your browser to after the logout.
+Read more about how federated logout works at Auth0 +OptionalreturnTo?: string The URL where Auth0 will redirect your browser to after the logout.
Note: If the
- -client_idparameter is included, thereturnToURL that is provided must be listed in the -Application's "Allowed Logout URLs" in the Auth0 dashboard. +Application's "Allowed Logout URLs" in the Auth0 dashboard. However, if theclient_idparameter is not included, thereturnToURL 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
Optionalpopup
popup?: any
Accepts an already-created popup window to use. If not specified, the SDK will create its own. This may be useful for platforms like iOS that have security restrictions around when popups can be invoked (e.g. from a user click event)
-Optional timeout
timeout
The number of seconds to wait for a popup response before +
Optionaltimeout
timeout
The number of seconds to wait for a popup response before throwing a timeout error. Defaults to 60s
-Interface PopupLoginOptions
Hierarchy
- BaseLoginOptions
- PopupLoginOptions
Index
Properties
Properties
Optional authorization
URL parameters that will be sent back to the Authorization Server. This can be known parameters +
Interface PopupLoginOptions
Hierarchy (view full)
- BaseLoginOptions
- PopupLoginOptions
Index
Properties
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 +
Interface RedirectLoginOptions<TAppState>
interface RedirectLoginOptions<TAppState> {
appState?: TAppState;
authorizationParams?: AuthorizationParams;
fragment?: string;
openUrl?: ((url: string) => void | Promise<void>);
}
appState?: TAppState;
authorizationParams?: AuthorizationParams;
fragment?: string;
openUrl?: ((url: string) => void | Promise<void>);
}
Type Parameters
- TAppState = AppState
Hierarchy
- Omit<SPARedirectLoginOptions<TAppState>, "onRedirect">
- RedirectLoginOptions
Index
Properties
Properties
Optionalapp
Used to store state before doing the redirect
+Optionalauthorization
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
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 });
}
}); -
Optionalfragment
fragment?: string
Used to add to the URL fragment before redirecting
+Optionalopen
open
Used to control the redirect and not rely on the SDK to do the actual redirect.
+@auth0/auth0-vue
Index
Classes
Interfaces
Type Aliases
Variables
Functions
@auth0/auth0-vue
Index
Classes
Interfaces
Type Aliases
Variables
Functions
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
Type Alias CustomFetchMinimalOutput
Custom
headers: ResponseHeaders;
status: number;
}
headers: ResponseHeaders;
status: number;
}
Type Alias FetcherConfig<TOutput>
Fetcher
baseUrl?: string;
dpopNonceId?: string;
fetch?: CustomFetchImpl<TOutput>;
getAccessToken?: AccessTokenFactory;
}
baseUrl?: string;
dpopNonceId?: string;
fetch?: CustomFetchImpl<TOutput>;
getAccessToken?: AccessTokenFactory;
}
Type Parameters
- TOutput extends CustomFetchMinimalOutput
Variable AUTH0_INJECTION_KEYConst
Injection token used to provide the Auth0VueClient instance. Can be used to pass to inject()
inject(AUTH0_INJECTION_KEY)
-Variable AUTH0_INJECTION_KEYConst
Injection token used to provide the Auth0VueClient instance. Can be used to pass to inject()
inject(AUTH0_INJECTION_KEY)
+
Error thrown when the wrong DPoP nonce is used and a potential subsequent retry wasn't able to fix it.
+