- Navigates to the specified url. The router will be used if - one is available, otherwise it falls back to - window.history.replaceState. -
window.history.replaceState
The url to navigate to
+ Navigates to the specified url. The router will be used + if one is available, otherwise it falls back to + window.history.replaceState. +
Static
// app.module.ts// ---------------------------import { AuthModule, AuthClientConfig } from '@auth0/auth0-angular';// Provide an initializer function that returns a Promisefunction configInitializer( http: HttpClient, config: AuthClientConfig) { return () => http .get('/config') .toPromise() .then((loadedConfig: any) => config.set(loadedConfig)); // Set the config that was loaded asynchronously here}// Provide APP_INITIALIZER with this function. Note that there is no config passed to AuthModule.forRootimports: [ // other imports.. HttpClientModule, AuthModule.forRoot(), //<- don't pass any config here],providers: [ { provide: APP_INITIALIZER, useFactory: configInitializer, // <- pass your initializer function here deps: [HttpClient, AuthClientConfig], multi: true, },], -Copy
// app.module.ts// ---------------------------import { AuthModule, AuthClientConfig } from '@auth0/auth0-angular';// Provide an initializer function that returns a Promisefunction configInitializer( http: HttpClient, config: AuthClientConfig) { return () => http .get('/config') .toPromise() .then((loadedConfig: any) => config.set(loadedConfig)); // Set the config that was loaded asynchronously here}// Provide APP_INITIALIZER with this function. Note that there is no config passed to AuthModule.forRootimports: [ // other imports.. HttpClientModule, AuthModule.forRoot(), //<- don't pass any config here],providers: [ { provide: APP_INITIALIZER, useFactory: configInitializer, // <- pass your initializer function here deps: [HttpClient, AuthClientConfig], multi: true, },], -
// app.module.ts// ---------------------------import { AuthModule, AuthClientConfig } from '@auth0/auth0-angular';// Provide an initializer function that returns a Promisefunction configInitializer( http: HttpClient, config: AuthClientConfig) { return () => http .get('/config') .toPromise() .then((loadedConfig: any) => config.set(loadedConfig)); // Set the config that was loaded asynchronously here}// Provide APP_INITIALIZER with this function. Note that there is no config passed to AuthModule.forRootimports: [ // other imports.. HttpClientModule, AuthModule.forRoot(), //<- don't pass any config here],providers: [ { provide: APP_INITIALIZER, useFactory: configInitializer, // <- pass your initializer function here deps: [HttpClient, AuthClientConfig], multi: true, },], +Copy
// app.module.ts// ---------------------------import { AuthModule, AuthClientConfig } from '@auth0/auth0-angular';// Provide an initializer function that returns a Promisefunction configInitializer( http: HttpClient, config: AuthClientConfig) { return () => http .get('/config') .toPromise() .then((loadedConfig: any) => config.set(loadedConfig)); // Set the config that was loaded asynchronously here}// Provide APP_INITIALIZER with this function. Note that there is no config passed to AuthModule.forRootimports: [ // other imports.. HttpClientModule, AuthModule.forRoot(), //<- don't pass any config here],providers: [ { provide: APP_INITIALIZER, useFactory: configInitializer, // <- pass your initializer function here deps: [HttpClient, AuthClientConfig], multi: true, },], +
Optional
- Gets the config that has been set by other consumers of the - service -
- Sets configuration to be read by other consumers of the - service (see usage notes) -
The configuration to set
+ Sets configuration to be read by other consumers of the + service (see usage notes) +
Identifies and handles a given HTTP request.
The outgoing request object to handle.
+ The next interceptor in the chain, or the backend + if no interceptors remain in the chain. +
An observable of the event stream.
- Initialize the authentication module system. Configuration - can either be specified here, or by calling - AuthClientConfig.set (perhaps from an APP_INITIALIZER - factory function). -
The optional configuration for the SDK.
+ Initialize the authentication module system. + Configuration can either be specified here, or by + calling AuthClientConfig.set (perhaps from an + APP_INITIALIZER factory function). +
Readonly
+ Emits the value (if any) that was passed to the + loginWithRedirect method call but only + after handleRedirectCallback is + first called +
loginWithRedirect
handleRedirectCallback
+ Emits errors that occur during login, or when checking for an + active session on startup. +
+ Emits ID token claims when authenticated, or null if not + authenticated. +
- Emits the value (if any) that was passed to the - loginWithRedirect method call but only - after handleRedirectCallback is - first called -
- Emits errors that occur during login, or when checking for an - active session on startup. -
+ Emits boolean values indicating the authentication state of + the user. If true, it means a user has + authenticated. This depends on the value of + isLoading$, so there is no need to manually check + the loading state of the SDK. +
true
isLoading$
+ Emits boolean values indicating the loading state of the SDK. +
+ Emits details about the authenticated user, or null if not + authenticated. +
- Emits ID token claims when authenticated, or null if not - authenticated. -
- Emits boolean values indicating the authentication state of the - user. If true, it means a user has authenticated. - This depends on the value of isLoading$, so there - is no need to manually check the loading state of the SDK. -
- Emits boolean values indicating the loading state of the SDK. -
- Emits details about the authenticated user, or null if not - authenticated. -
- Fetches a new access token and returns the response from the - /oauth/token endpoint, omitting the refresh token. -
The options for configuring the token fetch.
getTokenWithPopup(options).subscribe(token => ...) +Copy
getTokenWithPopup(options).subscribe(token => ...) +
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. +
/authorize
state
nonce
Fetches a new access token and returns it.
getDpopNonce(id).subscribe(nonce => ...) +Copy
getDpopNonce(id).subscribe(nonce => ...) +
+ Gets the DPoP nonce for the specified domain or the + default domain. The nonce is used in DPoP proof + generation for token binding. +
+ Optional identifier for the domain. If not + provided, uses the default domain. +
+ An Observable that emits the DPoP nonce string or + undefined if not available. +
getTokenWithPopup(options).subscribe(token => ...) -Copy
getTokenWithPopup(options).subscribe(token => ...) -
- 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. -
handleRedirectCallback(url).subscribe(result => ...) -Copy
handleRedirectCallback(url).subscribe(result => ...) -
- 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. -
- Calling this method also refreshes the authentication and - user states. -
- The URL to that should be used to retrieve the - state and code values. - Defaults to window.location.href if not - given. -
code
window.location.href
await loginWithPopup(options); +Copy
await loginWithPopup(options); +
+ 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. +
The login options
Configuration for the popup window
await loginWithPopup(options); -Copy
await loginWithPopup(options); -
- IMPORTANT: This method has to be called from an event - handler that was started by the user like a button click, - for example, otherwise the popup will be blocked in most - browsers. -
loginWithRedirect(options); +Copy
loginWithRedirect(options); +
+ Performs a redirect to /authorize using the + parameters provided as arguments. Random and secure + state and nonce parameters + will be auto-generated. +
loginWithRedirect(options); -Copy
loginWithRedirect(options); -
- Performs a redirect to /authorize using the - parameters provided as arguments. Random and secure - state and nonce parameters will be - auto-generated. -
logout(); +Copy
logout(); +
+ Clears the application session and performs a redirect + to /v2/logout, using the parameters + provided as arguments, to clear the Auth0 session. If + the federated option is specified it also + clears the Identity Provider session. If the + openUrl option is set to false, it only + clears the application session. It is invalid to set + both the federated to true and + openUrl to false, and an error + will be thrown if you do. + Read more about how Logout works at Auth0. +
/v2/logout
federated
openUrl
false
The logout options
logout(); -Copy
logout(); -
- Clears the application session and performs a redirect to - /v2/logout, using the parameters provided as - arguments, to clear the Auth0 session. If the - federated option is specified it also clears - the Identity Provider session. If the - openUrl option is set to false, it only clears - the application session. It is invalid to set both the - federated to true and openUrl to - false, and an error will be thrown if you do. - Read more about how Logout works at Auth0. -
Called when the service is destroyed
setDpopNonce(nonce, id).subscribe(() => ...) +Copy
setDpopNonce(nonce, id).subscribe(() => ...) +
+ Sets the DPoP nonce for the specified domain or the + default domain. This is typically used after receiving a + new nonce from the authorization server. +
The DPoP nonce value to set.
An Observable that completes when the nonce is set.
Tracks the Authentication State for the SDK
- Refresh the state to ensure the - isAuthenticated, user$ and - idTokenClaims$ reflect the most up-to-date - values from Auth0Client. -
isAuthenticated
user$
idTokenClaims$
- Update the access token, doing so will also refresh the - state. -
The new Access Token
Emits the error in the error$ observable.
error$
The new error
Update the isLoading state using the provided value
The new value for isLoading
+ Refresh the state to ensure the + isAuthenticated, user$ and + idTokenClaims$ reflect the most up-to-date + values from Auth0Client. +
+ Update the access token, doing so will also refresh the + state. +
+ Emits the error in the error$ observable. +
Thrown when handling the redirect callback fails, will be one of - Auth0's Authentication API's Standard Error Responses: + Auth0's Authentication API's Standard Error Responses: https://auth0.com/docs/api/authentication?javascript#standard-error-responses
Optional override for formatting stack traces
- https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces -
Create .stack property on a target object
+ 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)). +
Error.stackTraceLimit
new Error().stack
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. +
10
+ If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +
+ Creates a .stack property on + targetObject, which when accessed returns a + string representing the location in the code at which + Error.captureStackTrace() was called. +
.stack
targetObject
Error.captureStackTrace()
const myObject = {};Error.captureStackTrace(myObject);myObject.stack; // Similar to `new Error().stack` +Copy
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}. +
${myObject.name}: ${myObject.message}
+ The optional constructorOpt argument + accepts a function. If given, all frames above + constructorOpt, including + constructorOpt, will be omitted from the + generated stack trace. +
constructorOpt
+ The constructorOpt argument 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(); +Copy
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(); +
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +
Protected
Thrown when network requests to the Auth server fail.
mfa_required
Error thrown when there is no refresh token to use