Class AuthClient
Index
Constructors
Class AuthClient
Index
Constructors
Methods
Constructors
constructor
Parameters
- options: AuthClientOptions
Returns AuthClient
Constructors
constructor
Parameters
- options: AuthClientOptions
Returns AuthClient
Methods
finalize
Filters and processes ID token claims for a session.
If a
-beforeSessionSavedcallback is configured, it will be invoked to allow custom processing of the session and ID token. Otherwise, default filtering will be applied to remove standard ID token claims from the user object.Parameters
- session: SessionData
OptionalidToken: string
Returns Promise<SessionData>
get
- getConnectionTokenSet(
tokenSet: TokenSet,
connectionTokenSet: undefined | ConnectionTokenSet,
options: AccessTokenForConnectionOptions,
): Promise<
[AccessTokenForConnectionError, null]
| [null, ConnectionTokenSet],
>Exchanges a refresh token for an access token for a connection.
+Parameters
- session: SessionData
OptionalidToken: string
Returns Promise<SessionData>
get
- getConnectionTokenSet(
tokenSet: TokenSet,
connectionTokenSet: undefined | ConnectionTokenSet,
options: AccessTokenForConnectionOptions,
): Promise<
[AccessTokenForConnectionError, null]
| [null, ConnectionTokenSet],
>Exchanges a refresh token for an access token for a connection.
This method performs a token exchange using the provided refresh token and connection details. It first checks if the refresh token is present in the
tokenSet. If not, it returns an error. Then, it constructs the necessary parameters for the token exchange request and performs @@ -24,11 +24,11 @@ The second element is eithernullif an error occurred, or aConnectionTokenSetobject containing the access token, expiration time, and scope if the request was successful.get
Token Set
get
- getTokenSet(
tokenSet: TokenSet,
forceRefresh?: boolean,
): Promise<[SdkError, null] | [null, GetTokenSetResponse]>Retrieves OAuth token sets, handling token refresh when necessary or if forced.
Parameters
- tokenSet: TokenSet
OptionalforceRefresh: boolean
Returns Promise<[SdkError, null] | [null, GetTokenSetResponse]>
A tuple containing either:
[SdkError, null]if an error occurred (missing refresh token, discovery failure, or refresh failure)[null, {tokenSet, idTokenClaims}]if a new token was retrieved, containing the new token set ID token claims[null, {tokenSet, }]if token refresh was not done and existing token was returned
handle
Parameters
- req: NextRequest
Returns Promise<NextResponse<unknown>>
handle
Parameters
- req: NextRequest
Returns Promise<NextResponse<unknown>>
handle
Parameters
- req: NextRequest
Returns Promise<NextResponse<unknown>>
handle
Parameters
- req: NextRequest
Returns Promise<NextResponse<unknown>>
handle
Parameters
- req: NextRequest
Returns Promise<NextResponse<unknown>>
handle
Parameters
- req: NextRequest
Returns Promise<NextResponse<unknown>>
handler
Parameters
- req: NextRequest
Returns Promise<NextResponse<unknown>>
start
Parameters
- options: StartInteractiveLoginOptions = {}
Returns Promise<NextResponse<unknown>>
handle
Parameters
- req: NextRequest
Returns Promise<NextResponse<unknown>>
handle
Parameters
- req: NextRequest
Returns Promise<NextResponse<unknown>>
handle
Parameters
- req: NextRequest
Returns Promise<NextResponse<unknown>>
handle
Parameters
- req: NextRequest
Returns Promise<NextResponse<unknown>>
handle
Parameters
- req: NextRequest
Returns Promise<NextResponse<unknown>>
handle
Parameters
- req: NextRequest
Returns Promise<NextResponse<unknown>>
handler
Parameters
- req: NextRequest
Returns Promise<NextResponse<unknown>>
start
Parameters
- options: StartInteractiveLoginOptions = {}
Returns Promise<NextResponse<unknown>>
Class TransactionStore
TransactionStore is responsible for storing the state required to successfully complete +
Class TransactionStore
TransactionStore is responsible for storing the state required to successfully complete an authentication transaction. The store relies on encrypted, stateless cookies to store the transaction state.
-Index
Constructors
Index
Constructors
Methods
Constructors
constructor
Parameters
- __namedParameters: TransactionStoreOptions
Returns TransactionStore
Methods
delete
Parameters
- resCookies: ResponseCookies
- state: string
Returns Promise<void>
delete
Deletes all transaction cookies based on the configured prefix.
-Parameters
- reqCookies: RequestCookies
- resCookies: ResponseCookies
Returns Promise<void>
get
- get(
reqCookies: RequestCookies,
state: string,
): Promise<null | JWTDecryptResult<TransactionState>>Parameters
- reqCookies: RequestCookies
- state: string
Returns Promise<null | JWTDecryptResult<TransactionState>>
get
Returns the configured prefix for transaction cookies.
-Returns string
save
Parameters
- resCookies: ResponseCookies
- transactionState: TransactionState
Returns Promise<void>
Constructors
constructor
Parameters
- __namedParameters: TransactionStoreOptions
Returns TransactionStore
Methods
delete
Parameters
- resCookies: ResponseCookies
- state: string
Returns Promise<void>
delete
Deletes all transaction cookies based on the configured prefix.
+Parameters
- reqCookies: RequestCookies
- resCookies: ResponseCookies
Returns Promise<void>
get
- get(
reqCookies: RequestCookies,
state: string,
): Promise<null | JWTDecryptResult<TransactionState>>Parameters
- reqCookies: RequestCookies
- state: string
Returns Promise<null | JWTDecryptResult<TransactionState>>
get
Returns the configured prefix for transaction cookies.
+Returns string
save
- save(
resCookies: ResponseCookies,
transactionState: TransactionState,
reqCookies?: RequestCookies,
): Promise<void>Saves the transaction state to an encrypted cookie.
+Parameters
- resCookies: ResponseCookies
The response cookies object to set the transaction cookie on
+ - transactionState: TransactionState
The transaction state to save
+ OptionalreqCookies: RequestCookiesOptional request cookies to check for existing transactions. +When provided and
+enableParallelTransactionsis false, +will check for existing transaction cookies. When omitted, +the existence check is skipped for performance optimization.
Returns Promise<void>
- resCookies: ResponseCookies
Enumeration AccessTokenErrorCode
Index
Enumeration Members
Enumeration AccessTokenErrorCode
Index
Enumeration Members
Enumeration AccessTokenForConnectionErrorCode
Enum representing error codes related to access tokens for connections.
-Index
Enumeration Members
Enumeration AccessTokenForConnectionErrorCode
Enum representing error codes related to access tokens for connections.
+Index
Enumeration Members
Enumeration Members
FAILED_
Failed to exchange the refresh token.
-MISSING_
The refresh token is missing.
-MISSING_
The session is missing.
-MISSING_
The refresh token is missing.
+MISSING_
The session is missing.
+Function useUser
- useUser(): | {
error: Error;
invalidate: () => Promise<undefined | User>;
isLoading: boolean;
user: null;
}
| {
error: null;
invalidate: () => Promise<undefined | User>;
isLoading: boolean;
user: User;
}
| {
error: undefined;
invalidate: () => Promise<undefined | User>;
isLoading: boolean;
user: undefined;
}Returns
| {
error: Error;
invalidate: () => Promise<undefined | User>;
isLoading: boolean;
user: null;
}
| {
error: null;
invalidate: () => Promise<undefined | User>;
isLoading: boolean;
user: User;
}
| {
error: undefined;
invalidate: () => Promise<undefined | User>;
isLoading: boolean;
user: undefined;
}
Function useUser
- useUser(): | {
error: Error;
invalidate: () => Promise<undefined | User>;
isLoading: boolean;
user: null;
}
| {
error: null;
invalidate: () => Promise<undefined | User>;
isLoading: boolean;
user: User;
}
| {
error: undefined;
invalidate: () => Promise<undefined | User>;
isLoading: boolean;
user: undefined;
}Returns
| {
error: Error;
invalidate: () => Promise<undefined | User>;
isLoading: boolean;
user: null;
}
| {
error: null;
invalidate: () => Promise<undefined | User>;
isLoading: boolean;
user: User;
}
| {
error: undefined;
invalidate: () => Promise<undefined | User>;
isLoading: boolean;
user: undefined;
}
Function filterDefaultIdTokenClaims
Filters the claims to only include those that are considered default.
+filterDefaultIdTokenClaims | @auth0/nextjs-auth0 - v4.9.0 +Function filterDefaultIdTokenClaims
Filters the claims to only include those that are considered default.
Parameters
- claims: { [key: string]: any }
The claims to filter.
Returns User
The filtered claims containing only default ID token claims.
-- claims: { [key: string]: any }
Function generateSessionCookie
- generateSessionCookie(
session: Partial<SessionData>,
config: GenerateSessionCookieConfig,
): Promise<string>Parameters
- session: Partial<SessionData>
- config: GenerateSessionCookieConfig
Returns Promise<string>
Function generateSessionCookie
- generateSessionCookie(
session: Partial<SessionData>,
config: GenerateSessionCookieConfig,
): Promise<string>Parameters
- session: Partial<SessionData>
- config: GenerateSessionCookieConfig
Returns Promise<string>
@auth0/nextjs-auth0 - v4.8.0
@auth0/nextjs-auth0 - v4.9.0
The Auth0 Next.js SDK is a library for implementing user authentication in Next.js applications.
3. Create the Aut
import { Auth0Client } from "@auth0/nextjs-auth0/server";
export const auth0 = new Auth0Client();
+Note
+The Auth0Client automatically uses safe defaults to manage authentication cookies. For advanced use cases, you can customize transaction cookie behavior by providing your own configuration. See Transaction Cookie Configuration for details.
+
4. Add the authentication middleware
import { Auth0Client } from "@auth0/nextjs-auth0/server";
export const auth0 = new Auth0Client();
+The Auth0Client automatically uses safe defaults to manage authentication cookies. For advanced use cases, you can customize transaction cookie behavior by providing your own configuration. See Transaction Cookie Configuration for details.
+Create a middleware.ts file in the root of your project's directory:
import type { NextRequest } from "next/server";
import { auth0 } from "./lib/auth0"; // Adjust path if your auth0 client is elsewhere
export async function middleware(request: NextRequest) {
return await auth0.middleware(request);
}
export const config = {
matcher: [
/*
* Match all request paths except for the ones starting with:
* - _next/static (static files)
* - _next/image (image optimization files)
* - favicon.ico, sitemap.xml, robots.txt (metadata files)
*/
"/((?!_next/static|_next/image|favicon.ico|sitemap.xml|robots.txt).*)"
]
};
Customizing the clientConfigure the session timeouts and whether to use rolling sessions or not. See Session configuration for additional details. Also allows configuration of cookie attributes like domain, path, secure, sameSite, and transient. If not specified, these can be configured using AUTH0_COOKIE_* environment variables. Note: httpOnly is always true. See Cookie Configuration for details.
+enableParallelTransactions
+booleanEnable support for multiple concurrent authentication flows by using unique transaction cookies per flow. When true (default), each authentication attempt gets its own transaction cookie with a unique state suffix. When false, uses a single shared transaction cookie, which may cause conflicts with concurrent auth attempts. See Transaction Cookie Configuration for details.
+
+
+transactionCookie
+TransactionCookieOptionsConfigure transaction cookie management for authentication flows. You can control cookie expiration and other cookie options. See Transaction Cookie Configuration for details.
+
+
beforeSessionSaved
BeforeSessionSavedHookA method to manipulate the session before persisting it. See beforeSessionSaved for additional details.
@@ -157,6 +170,21 @@ Customizing the client
+Customizing Auth Handlers
While the authentication routes are handled automatically by the middleware, you can still customize the authentication flow through two main approaches:
+
+- Run custom code before auth handlers: Intercept auth routes in your middleware to add custom logic before authentication actions
+- Run code after authentication: Use the
onCallback hook to add custom logic after authentication completes
+
+Additional customization options include:
+
+- Login parameters via query parameters or static configuration
+- Session data modification using the
beforeSessionSaved hook
+- Logout redirects using query parameters
+
+Important
+When customizing auth handlers, always validate user inputs (especially redirect URLs) to prevent security vulnerabilities like open redirects. Use relative URLs when possible and implement proper input sanitization.
+
+Quick Start: For detailed examples and step-by-step migration patterns from v3, see Customizing Auth Handlers.
Session Cookie Configuration
You can specify the following environment variables to configure the session cookie:
AUTH0_COOKIE_DOMAIN=
AUTH0_COOKIE_PATH=
@@ -217,4 +245,4 @@ What is Auth0?
This project is licensed under the MIT license. See the LICENSE file for more info.
-
+
diff --git a/docs/interfaces/client.WithPageAuthRequiredOptions.html b/docs/interfaces/client.WithPageAuthRequiredOptions.html
index 315addcf3..86385064f 100644
--- a/docs/interfaces/client.WithPageAuthRequiredOptions.html
+++ b/docs/interfaces/client.WithPageAuthRequiredOptions.html
@@ -1,17 +1,17 @@
-WithPageAuthRequiredOptions | @auth0/nextjs-auth0 - v4.8.0 Interface WithPageAuthRequiredOptions
Options to customize the withPageAuthRequired higher order component.
-
onError?: (error: Error) => Element;
onRedirecting?: () => Element;
returnTo?: string;
}Index
Properties
onWithPageAuthRequiredOptions | @auth0/nextjs-auth0 - v4.9.0 Interface WithPageAuthRequiredOptions
Options to customize the withPageAuthRequired higher order component.
+
onError?: (error: Error) => Element;
onRedirecting?: () => Element;
returnTo?: string;
}Index
Properties
Properties
Optionalon
onError?: (error: Error) => ElementwithPageAuthRequired(Profile, {
onError: error => <div>Error: {error.message}</div>
});
Render a fallback in case of error fetching the user from the profile API route.
-Optionalon
onRedirecting?: () => ElementwithPageAuthRequired(Profile, {
onRedirecting: () => <div>Redirecting...</div>
});
+
Optionalon
onRedirecting?: () => ElementwithPageAuthRequired(Profile, {
onRedirecting: () => <div>Redirecting...</div>
});
Render a message to show that the user is being redirected.
-Optionalreturn
returnTo?: stringwithPageAuthRequired(Profile, {
returnTo: '/profile'
});
+
Optionalreturn
returnTo?: stringwithPageAuthRequired(Profile, {
returnTo: '/profile'
});
Add a path to return the user to after login.
-AccessTokenForConnectionOptions | @auth0/nextjs-auth0 - v4.8.0 Interface AccessTokenForConnectionOptions
Options for retrieving a connection access token.
-Index
Properties
connection
+AccessTokenForConnectionOptions | @auth0/nextjs-auth0 - v4.9.0 Interface AccessTokenForConnectionOptions
Options for retrieving a connection access token.
+Index
Properties
Optionallogin_
login_hint?: stringAn optional login hint to pass to the authorization server.
+Auth0ClientOptions | @auth0/nextjs-auth0 - v4.8.0 Interface Auth0ClientOptions
interface Auth0ClientOptions {
allowInsecureRequests?: boolean;
appBaseUrl?: string;
authorizationParameters?: AuthorizationParameters;
beforeSessionSaved?: BeforeSessionSavedHook;
clientAssertionSigningAlg?: string;
clientAssertionSigningKey?: string | CryptoKey;
clientId?: string;
clientSecret?: string;
domain?: string;
enableAccessTokenEndpoint?: boolean;
enableTelemetry?: boolean;
httpTimeout?: number;
logoutStrategy?: LogoutStrategy;
noContentProfileResponseWhenUnauthenticated?: boolean;
onCallback?: OnCallbackHook;
pushedAuthorizationRequests?: boolean;
routes?: Partial<
Pick<Routes, "login" | "callback" | "logout" | "backChannelLogout">,
>;
secret?: string;
session?: SessionConfiguration;
sessionStore?: SessionDataStore;
signInReturnToPath?: string;
transactionCookie?: TransactionCookieOptions;
}Index
Properties
allowAuth0ClientOptions | @auth0/nextjs-auth0 - v4.9.0 Interface Auth0ClientOptions
interface Auth0ClientOptions {
allowInsecureRequests?: boolean;
appBaseUrl?: string;
authorizationParameters?: AuthorizationParameters;
beforeSessionSaved?: BeforeSessionSavedHook;
clientAssertionSigningAlg?: string;
clientAssertionSigningKey?: string | CryptoKey;
clientId?: string;
clientSecret?: string;
domain?: string;
enableAccessTokenEndpoint?: boolean;
enableParallelTransactions?: boolean;
enableTelemetry?: boolean;
httpTimeout?: number;
logoutStrategy?: LogoutStrategy;
noContentProfileResponseWhenUnauthenticated?: boolean;
onCallback?: OnCallbackHook;
pushedAuthorizationRequests?: boolean;
routes?: Partial<
Pick<Routes, "login" | "callback" | "logout" | "backChannelLogout">,
>;
secret?: string;
session?: SessionConfiguration;
sessionStore?: SessionDataStore;
signInReturnToPath?: string;
transactionCookie?: TransactionCookieOptions;
}Index
Properties
Properties
Optionalallow
allowInsecureRequests?: booleanAllow insecure requests to be made to the authorization server. This can be useful when testing
with a mock OIDC provider that does not support TLS, locally.
This option can only be used when NODE_ENV is not set to production.
-Optionalapp
appBaseUrl?: stringThe URL of your application (e.g.: http://localhost:3000).
+Optionalapp
appBaseUrl?: stringThe URL of your application (e.g.: http://localhost:3000).
If it's not specified, it will be loaded from the APP_BASE_URL environment variable.
-Optionalauthorization
Additional parameters to send to the /authorize endpoint.
-Optionalbefore
A method to manipulate the session before persisting it.
+Optionalauthorization
Additional parameters to send to the /authorize endpoint.
+Optionalbefore
A method to manipulate the session before persisting it.
See beforeSessionSaved for additional details
-Optionalclient
clientAssertionSigningAlg?: stringThe algorithm used to sign the client assertion JWT.
+
Optionalclient
clientAssertionSigningAlg?: stringThe algorithm used to sign the client assertion JWT.
Uses one of token_endpoint_auth_signing_alg_values_supported if not specified.
If the Authorization Server discovery document does not list token_endpoint_auth_signing_alg_values_supported
this property will be required.
-Optionalclient
clientAssertionSigningKey?: string | CryptoKeyPrivate key for use with private_key_jwt clients.
+
Optionalclient
clientAssertionSigningKey?: string | CryptoKeyPrivate key for use with private_key_jwt clients.
This should be a string that is the contents of a PEM file or a CryptoKey.
-Optionalclient
clientId?: stringThe Auth0 client ID.
+Optionalclient
clientId?: stringThe Auth0 client ID.
If it's not specified, it will be loaded from the AUTH0_CLIENT_ID environment variable.
-Optionalclient
clientSecret?: stringThe Auth0 client secret.
+Optionalclient
clientSecret?: stringThe Auth0 client secret.
If it's not specified, it will be loaded from the AUTH0_CLIENT_SECRET environment variable.
-Optionaldomain
domain?: stringThe Auth0 domain for the tenant (e.g.: example.us.auth0.com).
+Optionaldomain
domain?: stringThe Auth0 domain for the tenant (e.g.: example.us.auth0.com).
If it's not specified, it will be loaded from the AUTH0_DOMAIN environment variable.
-Optionalenable
enableAccessTokenEndpoint?: booleanBoolean value to enable the /auth/access-token endpoint for use in the client app.
+Optionalenable
enableAccessTokenEndpoint?: booleanBoolean value to enable the /auth/access-token endpoint for use in the client app.
Defaults to true.
NOTE: Set this to false if your client does not need to directly interact with resource servers (Token Mediating Backend). This will be false for most apps.
A security best practice is to disable this to avoid exposing access tokens to the client app.
-Optionalenable
enableTelemetry?: booleanBoolean value to opt-out of sending the library name and version to your authorization server
+
Optionalenable
enableParallelTransactions?: booleanOptionalenable
enableTelemetry?: booleanBoolean value to opt-out of sending the library name and version to your authorization server
via the Auth0-Client header. Defaults to true.
-Optionalhttp
httpTimeout?: numberInteger value for the HTTP timeout in milliseconds for authentication requests.
+
Optionalhttp
httpTimeout?: numberInteger value for the HTTP timeout in milliseconds for authentication requests.
Defaults to 5000 ms.
-Optionallogout
Configure the logout strategy to use.
+Optionallogout
Configure the logout strategy to use.
'auto' (default): Attempts OIDC RP-Initiated Logout first, falls back to /v2/logout if not supported'oidc': Always uses OIDC RP-Initiated Logout (requires RP-Initiated Logout to be enabled)'v2': Always uses the Auth0 /v2/logout endpoint (supports wildcards in allowed logout URLs)
-Optionalno
noContentProfileResponseWhenUnauthenticated?: booleanIf true, the profile endpoint will return a 204 No Content response when the user is not authenticated
+
Optionalno
noContentProfileResponseWhenUnauthenticated?: booleanIf true, the profile endpoint will return a 204 No Content response when the user is not authenticated
instead of returning a 401 Unauthorized response.
Defaults to false.
-Optionalon
A method to handle errors or manage redirects after attempting to authenticate.
+Optionalon
A method to handle errors or manage redirects after attempting to authenticate.
See onCallback for additional details
-Optionalpushed
pushedAuthorizationRequests?: booleanIf enabled, the SDK will use the Pushed Authorization Requests (PAR) protocol when communicating with the authorization server.
-Optionalroutes
Configure the paths for the authentication routes.
+Optionalpushed
pushedAuthorizationRequests?: booleanIf enabled, the SDK will use the Pushed Authorization Requests (PAR) protocol when communicating with the authorization server.
+Optionalroutes
Configure the paths for the authentication routes.
See Custom routes for additional details.
-Optionalsecret
secret?: stringA 32-byte, hex-encoded secret used for encrypting cookies.
+Optionalsecret
secret?: stringA 32-byte, hex-encoded secret used for encrypting cookies.
If it's not specified, it will be loaded from the AUTH0_SECRET environment variable.
-Optionalsession
Configure the session timeouts and whether to use rolling sessions or not.
+Optionalsession
Configure the session timeouts and whether to use rolling sessions or not.
See Session configuration for additional details.
-Optionalsession
A custom session store implementation used to persist sessions to a data store.
+Optionalsession
A custom session store implementation used to persist sessions to a data store.
See Database sessions for additional details.
-Optionalsign
signInReturnToPath?: stringThe path to redirect the user to after successfully authenticating. Defaults to /.
-Optionaltransaction
Configure the transaction cookie used to store the state of the authentication transaction.
-Optionalsign
signInReturnToPath?: stringThe path to redirect the user to after successfully authenticating. Defaults to /.
+Optionaltransaction
Configure the transaction cookie used to store the state of the authentication transaction.
+AuthClientOptions | @auth0/nextjs-auth0 - v4.8.0 Interface AuthClientOptions
interface AuthClientOptions {
allowInsecureRequests?: boolean;
appBaseUrl: string;
authorizationParameters?: AuthorizationParameters;
beforeSessionSaved?: BeforeSessionSavedHook;
clientAssertionSigningAlg?: string;
clientAssertionSigningKey?: string | CryptoKey;
clientId: string;
clientSecret?: string;
domain: string;
enableAccessTokenEndpoint?: boolean;
enableTelemetry?: boolean;
fetch?: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | URL | Request, init?: RequestInit): Promise<Response>;
};
httpTimeout?: number;
jwksCache?: JWKSCacheInput;
logoutStrategy?: LogoutStrategy;
noContentProfileResponseWhenUnauthenticated?: boolean;
onCallback?: OnCallbackHook;
pushedAuthorizationRequests?: boolean;
routes?: Partial<
Pick<Routes, "login" | "callback" | "logout" | "backChannelLogout">,
>;
secret: string;
sessionStore: AbstractSessionStore;
signInReturnToPath?: string;
transactionStore: TransactionStore;
}Index
Properties
allowAuthClientOptions | @auth0/nextjs-auth0 - v4.9.0 Interface AuthClientOptions
interface AuthClientOptions {
allowInsecureRequests?: boolean;
appBaseUrl: string;
authorizationParameters?: AuthorizationParameters;
beforeSessionSaved?: BeforeSessionSavedHook;
clientAssertionSigningAlg?: string;
clientAssertionSigningKey?: string | CryptoKey;
clientId: string;
clientSecret?: string;
domain: string;
enableAccessTokenEndpoint?: boolean;
enableTelemetry?: boolean;
fetch?: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
};
httpTimeout?: number;
jwksCache?: JWKSCacheInput;
logoutStrategy?: LogoutStrategy;
noContentProfileResponseWhenUnauthenticated?: boolean;
onCallback?: OnCallbackHook;
pushedAuthorizationRequests?: boolean;
routes: Routes;
secret: string;
sessionStore: AbstractSessionStore;
signInReturnToPath?: string;
transactionStore: TransactionStore;
}Properties
Optionalallow
allowInsecureRequests?: booleanapp
appBaseUrl: stringOptionalauthorization
Optionalbefore
Optionalclient
clientAssertionSigningAlg?: stringOptionalclient
clientAssertionSigningKey?: string | CryptoKeyclient
clientId: stringOptionalclient
clientSecret?: stringdomain
domain: stringOptionalenable
enableAccessTokenEndpoint?: booleanOptionalenable
enableTelemetry?: booleanOptionalfetch
fetch?: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | URL | Request, init?: RequestInit): Promise<Response>;
}Type declaration
- (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
Parameters
- input: URL | RequestInfo
Optionalinit: RequestInit
Returns Promise<Response>
- (input: string | URL | Request, init?: RequestInit): Promise<Response>
Parameters
- input: string | URL | Request
Optionalinit: RequestInit
Returns Promise<Response>
Optionalhttp
httpTimeout?: numberOptionaljwks
jwksCache?: JWKSCacheInputOptionallogout
Optionalno
noContentProfileResponseWhenUnauthenticated?: booleanOptionalon
Optionalpushed
pushedAuthorizationRequests?: booleanOptionalroutes
secret
secret: stringsession
Optionalsign
signInReturnToPath?: stringtransaction
Properties
Optionalallow
allowInsecureRequests?: booleanapp
appBaseUrl: stringOptionalauthorization
Optionalbefore
Optionalclient
clientAssertionSigningAlg?: stringOptionalclient
clientAssertionSigningKey?: string | CryptoKeyclient
clientId: stringOptionalclient
clientSecret?: stringdomain
domain: stringOptionalenable
enableAccessTokenEndpoint?: booleanOptionalenable
enableTelemetry?: booleanOptionalfetch
fetch?: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}Type declaration
- (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
Parameters
- input: URL | RequestInfo
Optionalinit: RequestInit
Returns Promise<Response>
- (input: string | Request | URL, init?: RequestInit): Promise<Response>
Parameters
- input: string | Request | URL
Optionalinit: RequestInit
Returns Promise<Response>
Optionalhttp
httpTimeout?: numberOptionaljwks
jwksCache?: JWKSCacheInputOptionallogout
Optionalno
noContentProfileResponseWhenUnauthenticated?: booleanOptionalon
Optionalpushed
pushedAuthorizationRequests?: booleanroutes
secret
secret: stringsession
Optionalsign
signInReturnToPath?: stringtransaction
AuthorizationParameters | @auth0/nextjs-auth0 - v4.8.0 Interface AuthorizationParameters
interface AuthorizationParameters {
audience?: null | string;
max_age?: number;
redirect_uri?: null | string;
scope?: null | string;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Additional authorization parameters.
-
Index
Properties
audience?
+AuthorizationParameters | @auth0/nextjs-auth0 - v4.9.0 Interface AuthorizationParameters
interface AuthorizationParameters {
audience?: null | string;
max_age?: number;
redirect_uri?: null | string;
scope?: null | string;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Additional authorization parameters.
+
Index
Properties
Properties
Optionalaudience
audience?: null | stringThe unique identifier of the target API you want to access.
-Optionalmax_
max_age?: numberThe maximum amount of time, in seconds, after which a user must reauthenticate.
-Optionalredirect_
redirect_uri?: null | stringThe URL to which the authorization server will redirect the user after granting authorization.
-Optionalscope
scope?: null | stringThe scope of the access request, expressed as a list of space-delimited, case-sensitive strings.
+
Optionalmax_
max_age?: numberThe maximum amount of time, in seconds, after which a user must reauthenticate.
+Optionalredirect_
redirect_uri?: null | stringThe URL to which the authorization server will redirect the user after granting authorization.
+Optionalscope
scope?: null | stringThe scope of the access request, expressed as a list of space-delimited, case-sensitive strings.
Defaults to "openid profile email offline_access".
-ConnectionTokenSet | @auth0/nextjs-auth0 - v4.8.0 Interface ConnectionTokenSet
interface ConnectionTokenSet {
accessToken: string;
connection: string;
expiresAt: number;
scope?: string;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Index
Properties
accessConnectionTokenSet | @auth0/nextjs-auth0 - v4.9.0 Interface ConnectionTokenSet
interface ConnectionTokenSet {
accessToken: string;
connection: string;
expiresAt: number;
scope?: string;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Index
Properties
CookieOptions | @auth0/nextjs-auth0 - v4.8.0 Interface CookieOptions
interface CookieOptions {
domain?: string;
httpOnly: boolean;
maxAge?: number;
path: string;
sameSite: "lax" | "strict" | "none";
secure: boolean;
transient?: boolean;
}Routes | @auth0/nextjs-auth0 - v4.8.0 Interface Routes
interface Routes {
accessToken: string;
backChannelLogout: string;
callback: string;
login: string;
logout: string;
profile: string;
}Index
Properties
accessRoutes | @auth0/nextjs-auth0 - v4.9.0 Interface Routes
interface Routes {
accessToken: string;
backChannelLogout: string;
callback: string;
login: string;
logout: string;
profile: string;
}Index
Properties
SessionConfiguration | @auth0/nextjs-auth0 - v4.8.0 Interface SessionConfiguration
interface SessionConfiguration {
absoluteDuration?: number;
cookie?: SessionCookieOptions;
inactivityDuration?: number;
rolling?: boolean;
}Hierarchy (View Summary)
- SessionConfiguration
Index
Properties
absoluteSessionConfiguration | @auth0/nextjs-auth0 - v4.9.0 Interface SessionConfiguration
interface SessionConfiguration {
absoluteDuration?: number;
cookie?: SessionCookieOptions;
inactivityDuration?: number;
rolling?: boolean;
}Hierarchy (View Summary)
- SessionConfiguration
Index
Properties
Properties
Optionalabsolute
absoluteDuration?: numberThe absolute duration after which the session will expire. The value must be specified in seconds..
Once the absolute duration has been reached, the session will no longer be extended.
Default: 3 days.
-Optionalcookie
The options for the session cookie.
-Optionalinactivity
inactivityDuration?: numberThe duration of inactivity after which the session will expire. The value must be specified in seconds.
+Optionalcookie
The options for the session cookie.
+Optionalinactivity
inactivityDuration?: numberThe duration of inactivity after which the session will expire. The value must be specified in seconds.
The session will be extended as long as it was active before the inactivity duration has been reached.
Default: 1 day.
-Optionalrolling
rolling?: booleanA boolean indicating whether rolling sessions should be used or not.
+Optionalrolling
rolling?: booleanA boolean indicating whether rolling sessions should be used or not.
When enabled, the session will continue to be extended as long as it is used within the inactivity duration.
Once the upper bound, set via the absoluteDuration, has been reached, the session will no longer be extended.
Default: true.
-SessionCookieOptions | @auth0/nextjs-auth0 - v4.8.0 Interface SessionCookieOptions
interface SessionCookieOptions {
domain?: string;
name?: string;
path?: string;
sameSite?: "lax" | "strict" | "none";
secure?: boolean;
transient?: boolean;
}Index
Properties
domain?
+SessionCookieOptions | @auth0/nextjs-auth0 - v4.9.0 Interface SessionCookieOptions
interface SessionCookieOptions {
domain?: string;
name?: string;
path?: string;
sameSite?: "lax" | "strict" | "none";
secure?: boolean;
transient?: boolean;
}Properties
Optionaldomain
domain?: stringSpecifies the value for the Set-Cookie attribute. By default, no
domain is set, and most clients will consider the cookie to apply to only
the current domain.
-Optionalname
name?: stringThe name of the session cookie.
+Optionalname
name?: stringThe name of the session cookie.
Default: __session.
-Optionalpath
path?: stringThe path attribute of the session cookie. Will be set to '/' by default.
-Optionalsame
sameSite?: "lax" | "strict" | "none"The sameSite attribute of the session cookie.
+Optionalpath
path?: stringThe path attribute of the session cookie. Will be set to '/' by default.
+Optionalsame
sameSite?: "lax" | "strict" | "none"The sameSite attribute of the session cookie.
Default: lax.
-Optionalsecure
secure?: booleanThe secure attribute of the session cookie.
+Optionalsecure
secure?: booleanThe secure attribute of the session cookie.
Default: depends on the protocol of the application's base URL. If the protocol is https, then true, otherwise false.
-Optionaltransient
transient?: booleanThe transient attribute of the session cookie. When true, the cookie will not persist beyond the current session.
-Optionaltransient
transient?: booleanThe transient attribute of the session cookie. When true, the cookie will not persist beyond the current session.
+SessionData | @auth0/nextjs-auth0 - v4.8.0 Interface SessionData
interface SessionData {
connectionTokenSets?: ConnectionTokenSet[];
internal: { createdAt: number; sid: string };
tokenSet: TokenSet;
user: User;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Index
Properties
connectionSessionData | @auth0/nextjs-auth0 - v4.9.0 Interface SessionData
interface SessionData {
connectionTokenSets?: ConnectionTokenSet[];
internal: { createdAt: number; sid: string };
tokenSet: TokenSet;
user: User;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Index
Properties
SessionDataStore | @auth0/nextjs-auth0 - v4.8.0 Interface SessionDataStore
interface SessionDataStore {
delete(id: string): Promise<void>;
deleteByLogoutToken(logoutToken: LogoutToken): Promise<void>;
get(id: string): Promise<null | SessionData>;
set(id: string, session: SessionData): Promise<void>;
}Index
Methods
delete
+SessionDataStore | @auth0/nextjs-auth0 - v4.9.0 Interface SessionDataStore
interface SessionDataStore {
delete(id: string): Promise<void>;
deleteByLogoutToken(logoutToken: LogoutToken): Promise<void>;
get(id: string): Promise<null | SessionData>;
set(id: string, session: SessionData): Promise<void>;
}Index
Methods
Methods
delete
Destroys the session with the given session ID.
-Parameters
- id: string
Returns Promise<void>
Optionaldelete
Deletes the session with the given logout token which may contain a session ID or a user ID, or both.
-Parameters
- logoutToken: LogoutToken
Returns Promise<void>
get
Gets the session from the store given a session ID.
-Parameters
- id: string
Returns Promise<null | SessionData>
set
Upsert a session in the store given a session ID and SessionData.
-Parameters
- id: string
- session: SessionData
Returns Promise<void>
Parameters
- id: string
Returns Promise<void>
Optionaldelete
Deletes the session with the given logout token which may contain a session ID or a user ID, or both.
+Parameters
- logoutToken: LogoutToken
Returns Promise<void>
get
Gets the session from the store given a session ID.
+Parameters
- id: string
Returns Promise<null | SessionData>
set
Upsert a session in the store given a session ID and SessionData.
+Parameters
- id: string
- session: SessionData
Returns Promise<void>
SessionStoreOptions | @auth0/nextjs-auth0 - v4.8.0 Interface SessionStoreOptions
interface SessionStoreOptions {
absoluteDuration?: number;
cookie?: SessionCookieOptions;
cookieOptions?: SessionCookieOptions;
inactivityDuration?: number;
rolling?: boolean;
secret: string;
store?: SessionDataStore;
}Hierarchy (View Summary)
- SessionConfiguration
- SessionStoreOptions
Index
Properties
absoluteSessionStoreOptions | @auth0/nextjs-auth0 - v4.9.0 Interface SessionStoreOptions
interface SessionStoreOptions {
absoluteDuration?: number;
cookie?: SessionCookieOptions;
cookieOptions?: SessionCookieOptions;
inactivityDuration?: number;
rolling?: boolean;
secret: string;
store?: SessionDataStore;
}Hierarchy (View Summary)
- SessionConfiguration
- SessionStoreOptions
Index
Properties
Properties
Optionalabsolute
absoluteDuration?: numberThe absolute duration after which the session will expire. The value must be specified in seconds..
Once the absolute duration has been reached, the session will no longer be extended.
Default: 3 days.
-Optionalcookie
The options for the session cookie.
-Optionalcookie
Optionalinactivity
inactivityDuration?: numberThe duration of inactivity after which the session will expire. The value must be specified in seconds.
+Optionalcookie
The options for the session cookie.
+Optionalcookie
Optionalinactivity
inactivityDuration?: numberThe duration of inactivity after which the session will expire. The value must be specified in seconds.
The session will be extended as long as it was active before the inactivity duration has been reached.
Default: 1 day.
-Optionalrolling
rolling?: booleanA boolean indicating whether rolling sessions should be used or not.
+Optionalrolling
rolling?: booleanA boolean indicating whether rolling sessions should be used or not.
When enabled, the session will continue to be extended as long as it is used within the inactivity duration.
Once the upper bound, set via the absoluteDuration, has been reached, the session will no longer be extended.
Default: true.
-secret
secret: stringOptionalstore
secret
secret: stringOptionalstore
StartInteractiveLoginOptions | @auth0/nextjs-auth0 - v4.8.0 Interface StartInteractiveLoginOptions
interface StartInteractiveLoginOptions {
authorizationParameters?: AuthorizationParameters;
returnTo?: string;
}Index
Properties
authorizationStartInteractiveLoginOptions | @auth0/nextjs-auth0 - v4.9.0 Interface StartInteractiveLoginOptions
interface StartInteractiveLoginOptions {
authorizationParameters?: AuthorizationParameters;
returnTo?: string;
}Index
Properties
Optionalreturn
returnTo?: stringThe URL to redirect to after a successful login.
+TokenSet | @auth0/nextjs-auth0 - v4.8.0 Interface TokenSet
interface TokenSet {
accessToken: string;
expiresAt: number;
idToken?: string;
refreshToken?: string;
scope?: string;
}Index
Properties
accessTokenSet | @auth0/nextjs-auth0 - v4.9.0 Interface TokenSet
interface TokenSet {
accessToken: string;
expiresAt: number;
idToken?: string;
refreshToken?: string;
scope?: string;
}Index
Properties
TransactionCookieOptions | @auth0/nextjs-auth0 - v4.8.0 Interface TransactionCookieOptions
interface TransactionCookieOptions {
path?: string;
prefix?: string;
sameSite?: "lax" | "strict" | "none";
secure?: boolean;
}Index
Properties
path?
+TransactionCookieOptions | @auth0/nextjs-auth0 - v4.9.0 Interface TransactionCookieOptions
interface TransactionCookieOptions {
domain?: string;
maxAge?: number;
path?: string;
prefix?: string;
sameSite?: "lax" | "strict" | "none";
secure?: boolean;
}Properties
Optionaldomain
domain?: stringSpecifies the value for the Set-Cookie attribute. By default, no
+domain is set, and most clients will consider the cookie to apply to only
+the current domain.
+Optionalmax
maxAge?: numberThe expiration time for transaction cookies in seconds.
+If not provided, defaults to 1 hour (3600 seconds).
+Optionalpath
path?: stringThe path attribute of the transaction cookie. Will be set to '/' by default.
+Optionalprefix
prefix?: stringThe prefix of the cookie used to store the transaction state.
Default: __txn_{state}.
-Optionalsame
sameSite?: "lax" | "strict" | "none"The sameSite attribute of the transaction cookie.
+Optionalsame
sameSite?: "lax" | "strict" | "none"The sameSite attribute of the transaction cookie.
Default: lax.
-Optionalsecure
secure?: booleanThe secure attribute of the transaction cookie.
+Optionalsecure
secure?: booleanThe secure attribute of the transaction cookie.
Default: depends on the protocol of the application's base URL. If the protocol is https, then true, otherwise false.
-TransactionState | @auth0/nextjs-auth0 - v4.8.0 Interface TransactionState
interface TransactionState {
codeVerifier: string;
maxAge?: number;
nonce: string;
responseType: string;
returnTo: string;
state: string;
[propName: string]: unknown;
}Hierarchy
- JWTPayload
- TransactionState
Indexable
- [propName: string]: unknown
Any other JWT Claim Set member.
-
Index
Properties
codeTransactionState | @auth0/nextjs-auth0 - v4.9.0 Interface TransactionState
interface TransactionState {
codeVerifier: string;
maxAge?: number;
nonce: string;
responseType: string;
returnTo: string;
state: string;
[propName: string]: unknown;
}Hierarchy
- JWTPayload
- TransactionState
Indexable
- [propName: string]: unknown
Any other JWT Claim Set member.
+
Index
Properties
TransactionStoreOptions | @auth0/nextjs-auth0 - v4.8.0 Interface TransactionStoreOptions
Index
Properties
cookieTransactionStoreOptions | @auth0/nextjs-auth0 - v4.9.0 Interface TransactionStoreOptions
interface TransactionStoreOptions {
cookieOptions?: TransactionCookieOptions;
enableParallelTransactions?: boolean;
secret: string;
}Index
Properties
Properties
Optionalcookie
Optionalenable
enableParallelTransactions?: booleanControls whether multiple parallel login transactions are allowed.
+When false, only one transaction cookie is maintained at a time.
+When true (default), multiple transaction cookies can coexist for multi-tab support.
+secret
secret: stringUser | @auth0/nextjs-auth0 - v4.8.0 Interface User
interface User {
email?: string;
email_verified?: boolean;
family_name?: string;
given_name?: string;
name?: string;
nickname?: string;
org_id?: string;
picture?: string;
sub: string;
[key: string]: any;
}Indexable
- [key: string]: any
Index
Properties
email?
+User | @auth0/nextjs-auth0 - v4.9.0 Interface User
interface User {
email?: string;
email_verified?: boolean;
family_name?: string;
given_name?: string;
name?: string;
nickname?: string;
org_id?: string;
picture?: string;
sub: string;
[key: string]: any;
}Indexable
- [key: string]: any
Index
Properties
@auth0/nextjs-auth0 - v4.8.0 @auth0/nextjs-auth0 - v4.9.0 client | @auth0/nextjs-auth0 - v4.8.0 Module client
Interfaces
Type Aliases
Variables
Functions
+client | @auth0/nextjs-auth0 - v4.9.0 Module client
Interfaces
Type Aliases
Variables
Functions
diff --git a/docs/modules/errors.html b/docs/modules/errors.html
index e945fe215..84f76cc92 100644
--- a/docs/modules/errors.html
+++ b/docs/modules/errors.html
@@ -1 +1 @@
-errors | @auth0/nextjs-auth0 - v4.8.0 errors | @auth0/nextjs-auth0 - v4.9.0 server | @auth0/nextjs-auth0 - v4.8.0 Module server
Variables
Functions
+server | @auth0/nextjs-auth0 - v4.9.0 Module server
Type Aliases
Variables
Functions
diff --git a/docs/modules/testing.html b/docs/modules/testing.html
index f7723ae53..bdf20a711 100644
--- a/docs/modules/testing.html
+++ b/docs/modules/testing.html
@@ -1 +1 @@
-testing | @auth0/nextjs-auth0 - v4.8.0 testing | @auth0/nextjs-auth0 - v4.9.0 types | @auth0/nextjs-auth0 - v4.8.0 Module types
Interfaces
- AccessTokenForConnectionOptions
- Auth0ClientOptions
- AuthClientOptions
- AuthorizationParameters
- ConnectionTokenSet
- CookieOptions
- Routes
- SessionConfiguration
- SessionCookieOptions
- SessionData
- SessionDataStore
- SessionStoreOptions
- StartInteractiveLoginOptions
- TokenSet
- TransactionCookieOptions
- TransactionState
- TransactionStoreOptions
- User
+types | @auth0/nextjs-auth0 - v4.9.0 Module types
Interfaces
- AccessTokenForConnectionOptions
- Auth0ClientOptions
- AuthClientOptions
- AuthorizationParameters
- ConnectionTokenSet
- CookieOptions
- Routes
- SessionConfiguration
- SessionCookieOptions
- SessionData
- SessionDataStore
- SessionStoreOptions
- StartInteractiveLoginOptions
- TokenSet
- TransactionCookieOptions
- TransactionState
- TransactionStoreOptions
- User
diff --git a/docs/types/client.WithPageAuthRequired.html b/docs/types/client.WithPageAuthRequired.html
index c78492370..963d15af0 100644
--- a/docs/types/client.WithPageAuthRequired.html
+++ b/docs/types/client.WithPageAuthRequired.html
@@ -1,6 +1,6 @@
-WithPageAuthRequired | @auth0/nextjs-auth0 - v4.8.0 Type Alias WithPageAuthRequired
WithPageAuthRequired: <P extends object>(
Component: ComponentType<P & UserProps>,
options?: WithPageAuthRequiredOptions,
) => React.FC<P>const MyProtectedPage = withPageAuthRequired(MyPage);
+WithPageAuthRequired | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequired
WithPageAuthRequired: <P extends object>(
Component: ComponentType<P & UserProps>,
options?: WithPageAuthRequiredOptions,
) => React.FC<P>const MyProtectedPage = withPageAuthRequired(MyPage);
When you wrap your pages in this higher order component and an anonymous user visits your page,
they will be redirected to the login page and then returned to the page they were redirected from (after login).
-Type declaration
- <P extends object>(
Component: ComponentType<P & UserProps>,
options?: WithPageAuthRequiredOptions,
): React.FC<P> Type Parameters
- P extends object
Parameters
- Component: ComponentType<P & UserProps>
Optionaloptions: WithPageAuthRequiredOptions
Returns React.FC<P>
+
Type declaration
- <P extends object>(
Component: ComponentType<P & UserProps>,
options?: WithPageAuthRequiredOptions,
): React.FC<P> Type Parameters
- P extends object
Parameters
- Component: ComponentType<P & UserProps>
Optionaloptions: WithPageAuthRequiredOptions
Returns React.FC<P>
diff --git a/docs/types/server.AppRouterPageRoute.html b/docs/types/server.AppRouterPageRoute.html
new file mode 100644
index 000000000..adfdf26ab
--- /dev/null
+++ b/docs/types/server.AppRouterPageRoute.html
@@ -0,0 +1,2 @@
+AppRouterPageRoute | @auth0/nextjs-auth0 - v4.9.0 Type Alias AppRouterPageRoute
An app route that has been augmented with WithPageAuthRequired.
+Type declaration
- (obj: AppRouterPageRouteOpts): Promise<React.JSX.Element>
Parameters
Returns Promise<React.JSX.Element>
diff --git a/docs/types/server.AppRouterPageRouteOpts.html b/docs/types/server.AppRouterPageRouteOpts.html
new file mode 100644
index 000000000..ba5f897f2
--- /dev/null
+++ b/docs/types/server.AppRouterPageRouteOpts.html
@@ -0,0 +1,4 @@
+AppRouterPageRouteOpts | @auth0/nextjs-auth0 - v4.9.0 Type Alias AppRouterPageRouteOpts
Objects containing the route parameters and search parameters of the page.
+
params?: Promise<Record<string, string | string[]>>;
searchParams?: Promise<{ [key: string]: undefined | string | string[] }>;
}Index
Properties
GetServerSidePropsResultWithSession | @auth0/nextjs-auth0 - v4.9.0 Type Alias GetServerSidePropsResultWithSession<P>
If you wrap your getServerSideProps with WithPageAuthRequired your props object will be augmented with
+the user property, which will be the User object.
+// pages/profile.js
import { auth0 } from "@/lib/auth0";
export default function Profile({ user }) {
return <div>Hello {user.name}</div>;
}
export const getServerSideProps = auth0.withPageAuthRequired();
+
+
+Type Parameters
- P = any
PageRoute | @auth0/nextjs-auth0 - v4.9.0 Type Alias PageRoute<P, Q>
A page route that has been augmented with WithPageAuthRequired.
+Type Parameters
- P
- Q extends ParsedUrlQuery = ParsedUrlQuery
Type declaration
- (
ctx: GetServerSidePropsContext<Q>,
): Promise<GetServerSidePropsResultWithSession<P>> Parameters
- ctx: GetServerSidePropsContext<Q>
Returns Promise<GetServerSidePropsResultWithSession<P>>
diff --git a/docs/types/server.WithPageAuthRequired.html b/docs/types/server.WithPageAuthRequired.html
new file mode 100644
index 000000000..145e08b5c
--- /dev/null
+++ b/docs/types/server.WithPageAuthRequired.html
@@ -0,0 +1,3 @@
+WithPageAuthRequired | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequired
Protects Page router pages WithPageAuthRequiredPageRouter or
+App router pages WithPageAuthRequiredAppRouter
+
diff --git a/docs/types/server.WithPageAuthRequiredAppRouter.html b/docs/types/server.WithPageAuthRequiredAppRouter.html
new file mode 100644
index 000000000..9d22e2a39
--- /dev/null
+++ b/docs/types/server.WithPageAuthRequiredAppRouter.html
@@ -0,0 +1,17 @@
+WithPageAuthRequiredAppRouter | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequiredAppRouter
WithPageAuthRequiredAppRouter: (
fn: AppRouterPageRoute,
opts?: WithPageAuthRequiredAppRouterOptions,
) => AppRouterPageRouteWrap your Server Component with this method to make sure the user is authenticated before
+visiting the page.
+// app/protected-page/page.js
import { auth0 } from "@/lib/auth0";
const ProtectedPage = auth0.withPageAuthRequired(async function ProtectedPage() {
return <div>Protected content</div>;
}, { returnTo: '/protected-page' });
export default ProtectedPage;
+
+
+If the user visits /protected-page without a valid session, it will redirect the user to the
+login page.
+Note: Server Components are not aware of the req or the url of the page. So if you want the user to return to the
+page after login, you must specify the returnTo option.
+You can specify a function to returnTo that accepts the params (A Promise that resolves to
+an object containing the dynamic route parameters) and searchParams (A Promise that resolves to an
+object containing the search parameters of the current URL)
+argument from the page, to preserve dynamic routes and search params.
+// app/protected-page/[slug]/page.js
import { AppRouterPageRouteOpts } from '@auth0/nextjs-auth0/server';
import { auth0 } from "@/lib/auth0";
const ProtectedPage = auth0.withPageAuthRequired(async function ProtectedPage({
params, searchParams
}: AppRouterPageRouteOpts) {
const slug = (await params)?.slug as string;
return <div>Protected content for {slug}</div>;
}, {
returnTo({ params }) {
return `/protected-page/${(await params)?.slug}`;
}
});
export default ProtectedPage;
+
+
+Type declaration
- (
fn: AppRouterPageRoute,
opts?: WithPageAuthRequiredAppRouterOptions,
): AppRouterPageRoute Parameters
- fn: AppRouterPageRoute
Optionalopts: WithPageAuthRequiredAppRouterOptions
Returns AppRouterPageRoute
diff --git a/docs/types/server.WithPageAuthRequiredAppRouterOptions.html b/docs/types/server.WithPageAuthRequiredAppRouterOptions.html
new file mode 100644
index 000000000..6e56fa0bb
--- /dev/null
+++ b/docs/types/server.WithPageAuthRequiredAppRouterOptions.html
@@ -0,0 +1,4 @@
+WithPageAuthRequiredAppRouterOptions | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequiredAppRouterOptions
Specify the URL to returnTo - this is important in app router pages because the server component
+won't know the URL of the page.
+
returnTo?:
| string
| ((obj: AppRouterPageRouteOpts) => Promise<string> | string);
}Index
Properties
WithPageAuthRequiredPageRouter | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequiredPageRouter
WithPageAuthRequiredPageRouter: <
P extends { [key: string]: any } = { [key: string]: any },
Q extends ParsedUrlQuery = ParsedUrlQuery,
>(
opts?: WithPageAuthRequiredPageRouterOptions<P, Q>,
) => PageRoute<P, Q>Wrap your getServerSideProps with this method to make sure the user is authenticated before
+visiting the page.
+// pages/protected-page.js
import { auth0 } from "@/lib/auth0";
export default function ProtectedPage() {
return <div>Protected content</div>;
}
export const getServerSideProps = auth0.withPageAuthRequired();
+
+
+If the user visits /protected-page without a valid session, it will redirect the user to the
+login page. Then they will be returned to /protected-page after login.
+Type declaration
- <
P extends { [key: string]: any } = { [key: string]: any },
Q extends ParsedUrlQuery = ParsedUrlQuery,
>(
opts?: WithPageAuthRequiredPageRouterOptions<P, Q>,
): PageRoute<P, Q> Type Parameters
- P extends { [key: string]: any } = { [key: string]: any }
- Q extends ParsedUrlQuery = ParsedUrlQuery
Parameters
Optionalopts: WithPageAuthRequiredPageRouterOptions<P, Q>
Returns PageRoute<P, Q>
diff --git a/docs/types/server.WithPageAuthRequiredPageRouterOptions.html b/docs/types/server.WithPageAuthRequiredPageRouterOptions.html
new file mode 100644
index 000000000..ca50a0936
--- /dev/null
+++ b/docs/types/server.WithPageAuthRequiredPageRouterOptions.html
@@ -0,0 +1,10 @@
+WithPageAuthRequiredPageRouterOptions | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequiredPageRouterOptions<P, Q>
If you have a custom returnTo url you should specify it in returnTo.
+You can pass in your own getServerSideProps method, the props returned from this will be
+merged with the user props. You can also access the user session data by calling getSession
+inside of this method. For example:
+// pages/protected-page.js
import { auth0 } from "@/lib/auth0";
export default function ProtectedPage({ user, customProp }) {
return <div>Protected content</div>;
}
export const getServerSideProps = auth0.withPageAuthRequired({
// returnTo: '/unauthorized',
async getServerSideProps(ctx) {
// access the user session if needed
// const session = await auth0.getSession(ctx.req);
return {
props: {
// customProp: 'bar',
}
};
}
});
+
+
+
P extends { [key: string]: any } = { [key: string]: any },
Q extends ParsedUrlQuery = ParsedUrlQuery,
> = {
getServerSideProps?: GetServerSideProps<P, Q>;
returnTo?: string;
}Type Parameters
- P extends { [key: string]: any } = { [key: string]: any }
- Q extends ParsedUrlQuery = ParsedUrlQuery
Index
Properties
GenerateSessionCookieConfig | @auth0/nextjs-auth0 - v4.8.0 Type Alias GenerateSessionCookieConfig
Index
Properties
BeforeSessionSavedHook | @auth0/nextjs-auth0 - v4.8.0 Type Alias BeforeSessionSavedHook
Type declaration
- (session: SessionData, idToken: string | null): Promise<SessionData>
Parameters
- session: SessionData
- idToken: string | null
Returns Promise<SessionData>
+BeforeSessionSavedHook | @auth0/nextjs-auth0 - v4.9.0 Type Alias BeforeSessionSavedHook
Type declaration
- (session: SessionData, idToken: string | null): Promise<SessionData>
Parameters
- session: SessionData
- idToken: string | null
Returns Promise<SessionData>
diff --git a/docs/types/types.LogoutStrategy.html b/docs/types/types.LogoutStrategy.html
index 75b863775..2f0882b9b 100644
--- a/docs/types/types.LogoutStrategy.html
+++ b/docs/types/types.LogoutStrategy.html
@@ -1,2 +1,2 @@
-LogoutStrategy | @auth0/nextjs-auth0 - v4.8.0 Type Alias LogoutStrategy
LogoutStrategy: "auto" | "oidc" | "v2"Logout strategy options for controlling logout endpoint selection.
-
+LogoutStrategy | @auth0/nextjs-auth0 - v4.9.0 Type Alias LogoutStrategy
LogoutStrategy: "auto" | "oidc" | "v2"Logout strategy options for controlling logout endpoint selection.
+
diff --git a/docs/types/types.LogoutToken.html b/docs/types/types.LogoutToken.html
index ba9bf450e..4a499369a 100644
--- a/docs/types/types.LogoutToken.html
+++ b/docs/types/types.LogoutToken.html
@@ -1,3 +1,3 @@
-LogoutToken | @auth0/nextjs-auth0 - v4.8.0 Type Alias LogoutToken
OnCallbackContext | @auth0/nextjs-auth0 - v4.8.0 OnCallbackContext | @auth0/nextjs-auth0 - v4.9.0 OnCallbackHook | @auth0/nextjs-auth0 - v4.8.0 Type Alias OnCallbackHook
OnCallbackHook: (
error: SdkError | null,
ctx: OnCallbackContext,
session: SessionData | null,
) => Promise<NextResponse>Type declaration
- (
error: SdkError | null,
ctx: OnCallbackContext,
session: SessionData | null,
): Promise<NextResponse> Parameters
- error: SdkError | null
- ctx: OnCallbackContext
- session: SessionData | null
Returns Promise<NextResponse>
+OnCallbackHook | @auth0/nextjs-auth0 - v4.9.0 Type Alias OnCallbackHook
OnCallbackHook: (
error: SdkError | null,
ctx: OnCallbackContext,
session: SessionData | null,
) => Promise<NextResponse>Type declaration
- (
error: SdkError | null,
ctx: OnCallbackContext,
session: SessionData | null,
): Promise<NextResponse> Parameters
- error: SdkError | null
- ctx: OnCallbackContext
- session: SessionData | null
Returns Promise<NextResponse>
diff --git a/docs/types/types.PagesRouterRequest.html b/docs/types/types.PagesRouterRequest.html
index b19e08f29..a36bbceac 100644
--- a/docs/types/types.PagesRouterRequest.html
+++ b/docs/types/types.PagesRouterRequest.html
@@ -1 +1 @@
-PagesRouterRequest | @auth0/nextjs-auth0 - v4.8.0 Type Alias PagesRouterRequest
PagesRouterRequest: IncomingMessage | NextApiRequest
+PagesRouterRequest | @auth0/nextjs-auth0 - v4.9.0 Type Alias PagesRouterRequest
PagesRouterRequest: IncomingMessage | NextApiRequest
diff --git a/docs/types/types.PagesRouterResponse.html b/docs/types/types.PagesRouterResponse.html
index b5780a729..f0ff82438 100644
--- a/docs/types/types.PagesRouterResponse.html
+++ b/docs/types/types.PagesRouterResponse.html
@@ -1 +1 @@
-PagesRouterResponse | @auth0/nextjs-auth0 - v4.8.0 Type Alias PagesRouterResponse
PagesRouterResponse: ServerResponse<IncomingMessage> | NextApiResponse
+PagesRouterResponse | @auth0/nextjs-auth0 - v4.9.0 Type Alias PagesRouterResponse
PagesRouterResponse: ServerResponse<IncomingMessage> | NextApiResponse
diff --git a/docs/types/types.ReadonlyRequestCookies.html b/docs/types/types.ReadonlyRequestCookies.html
index b3ce1cea0..e920fd124 100644
--- a/docs/types/types.ReadonlyRequestCookies.html
+++ b/docs/types/types.ReadonlyRequestCookies.html
@@ -1 +1 @@
-ReadonlyRequestCookies | @auth0/nextjs-auth0 - v4.8.0 Type Alias ReadonlyRequestCookies
ReadonlyRequestCookies: Omit<RequestCookies, "set" | "clear" | "delete"> & Pick<
ResponseCookies,
"set"
| "delete",
>
+ReadonlyRequestCookies | @auth0/nextjs-auth0 - v4.9.0 Type Alias ReadonlyRequestCookies
ReadonlyRequestCookies: Omit<RequestCookies, "set" | "clear" | "delete"> & Pick<
ResponseCookies,
"set"
| "delete",
>
diff --git a/docs/types/types.RoutesOptions.html b/docs/types/types.RoutesOptions.html
index a9c3226b3..e35f2e3ba 100644
--- a/docs/types/types.RoutesOptions.html
+++ b/docs/types/types.RoutesOptions.html
@@ -1 +1 @@
-RoutesOptions | @auth0/nextjs-auth0 - v4.8.0 Type Alias RoutesOptions
+RoutesOptions | @auth0/nextjs-auth0 - v4.9.0 Type Alias RoutesOptions
diff --git a/docs/variables/client.withPageAuthRequired.html b/docs/variables/client.withPageAuthRequired.html
index abb7be418..5dd0a608e 100644
--- a/docs/variables/client.withPageAuthRequired.html
+++ b/docs/variables/client.withPageAuthRequired.html
@@ -1 +1 @@
-withPageAuthRequired | @auth0/nextjs-auth0 - v4.8.0 Variable withPageAuthRequiredConst
+withPageAuthRequired | @auth0/nextjs-auth0 - v4.9.0 Variable withPageAuthRequiredConst
diff --git a/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html b/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html
index 22aa5d30d..afc49fb66 100644
--- a/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html
+++ b/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html
@@ -1,2 +1,2 @@
-DEFAULT_ID_TOKEN_CLAIMS | @auth0/nextjs-auth0 - v4.8.0 Variable DEFAULT_ID_TOKEN_CLAIMSConst
DEFAULT_ID_TOKEN_CLAIMS: string[] = ...Default claims for the ID token.
-
+DEFAULT_ID_TOKEN_CLAIMS | @auth0/nextjs-auth0 - v4.9.0 Variable DEFAULT_ID_TOKEN_CLAIMSConst
DEFAULT_ID_TOKEN_CLAIMS: string[] = ...Default claims for the ID token.
+
diff --git a/package.json b/package.json
index 227a3f231..bcb5ae0c0 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "@auth0/nextjs-auth0",
- "version": "4.8.0",
+ "version": "4.9.0",
"description": "Auth0 Next.js SDK",
"type": "module",
"scripts": {
booleantrue (default), each authentication attempt gets its own transaction cookie with a unique state suffix. When false, uses a single shared transaction cookie, which may cause conflicts with concurrent auth attempts. See Transaction Cookie Configuration for details.TransactionCookieOptionsBeforeSessionSavedHookCustomizing the client
+Customizing Auth Handlers
While the authentication routes are handled automatically by the middleware, you can still customize the authentication flow through two main approaches:
+
+- Run custom code before auth handlers: Intercept auth routes in your middleware to add custom logic before authentication actions
+- Run code after authentication: Use the
onCallback hook to add custom logic after authentication completes
+
+Additional customization options include:
+
+- Login parameters via query parameters or static configuration
+- Session data modification using the
beforeSessionSaved hook
+- Logout redirects using query parameters
+
+Important
+When customizing auth handlers, always validate user inputs (especially redirect URLs) to prevent security vulnerabilities like open redirects. Use relative URLs when possible and implement proper input sanitization.
+
+Quick Start: For detailed examples and step-by-step migration patterns from v3, see Customizing Auth Handlers.
Session Cookie Configuration
You can specify the following environment variables to configure the session cookie:
AUTH0_COOKIE_DOMAIN=
AUTH0_COOKIE_PATH=
@@ -217,4 +245,4 @@ What is Auth0?
This project is licensed under the MIT license. See the LICENSE file for more info.
-
+
diff --git a/docs/interfaces/client.WithPageAuthRequiredOptions.html b/docs/interfaces/client.WithPageAuthRequiredOptions.html
index 315addcf3..86385064f 100644
--- a/docs/interfaces/client.WithPageAuthRequiredOptions.html
+++ b/docs/interfaces/client.WithPageAuthRequiredOptions.html
@@ -1,17 +1,17 @@
-WithPageAuthRequiredOptions | @auth0/nextjs-auth0 - v4.8.0 Interface WithPageAuthRequiredOptions
Options to customize the withPageAuthRequired higher order component.
-
onError?: (error: Error) => Element;
onRedirecting?: () => Element;
returnTo?: string;
}Index
Properties
onWithPageAuthRequiredOptions | @auth0/nextjs-auth0 - v4.9.0 Interface WithPageAuthRequiredOptions
Options to customize the withPageAuthRequired higher order component.
+
onError?: (error: Error) => Element;
onRedirecting?: () => Element;
returnTo?: string;
}Index
Properties
Properties
Optionalon
onError?: (error: Error) => ElementwithPageAuthRequired(Profile, {
onError: error => <div>Error: {error.message}</div>
});
Render a fallback in case of error fetching the user from the profile API route.
-Optionalon
onRedirecting?: () => ElementwithPageAuthRequired(Profile, {
onRedirecting: () => <div>Redirecting...</div>
});
+
Optionalon
onRedirecting?: () => ElementwithPageAuthRequired(Profile, {
onRedirecting: () => <div>Redirecting...</div>
});
Render a message to show that the user is being redirected.
-Optionalreturn
returnTo?: stringwithPageAuthRequired(Profile, {
returnTo: '/profile'
});
+
Optionalreturn
returnTo?: stringwithPageAuthRequired(Profile, {
returnTo: '/profile'
});
Add a path to return the user to after login.
-AccessTokenForConnectionOptions | @auth0/nextjs-auth0 - v4.8.0 Interface AccessTokenForConnectionOptions
Options for retrieving a connection access token.
-Index
Properties
connection
+AccessTokenForConnectionOptions | @auth0/nextjs-auth0 - v4.9.0 Interface AccessTokenForConnectionOptions
Options for retrieving a connection access token.
+Index
Properties
Optionallogin_
login_hint?: stringAn optional login hint to pass to the authorization server.
+Auth0ClientOptions | @auth0/nextjs-auth0 - v4.8.0 Interface Auth0ClientOptions
interface Auth0ClientOptions {
allowInsecureRequests?: boolean;
appBaseUrl?: string;
authorizationParameters?: AuthorizationParameters;
beforeSessionSaved?: BeforeSessionSavedHook;
clientAssertionSigningAlg?: string;
clientAssertionSigningKey?: string | CryptoKey;
clientId?: string;
clientSecret?: string;
domain?: string;
enableAccessTokenEndpoint?: boolean;
enableTelemetry?: boolean;
httpTimeout?: number;
logoutStrategy?: LogoutStrategy;
noContentProfileResponseWhenUnauthenticated?: boolean;
onCallback?: OnCallbackHook;
pushedAuthorizationRequests?: boolean;
routes?: Partial<
Pick<Routes, "login" | "callback" | "logout" | "backChannelLogout">,
>;
secret?: string;
session?: SessionConfiguration;
sessionStore?: SessionDataStore;
signInReturnToPath?: string;
transactionCookie?: TransactionCookieOptions;
}Index
Properties
allowAuth0ClientOptions | @auth0/nextjs-auth0 - v4.9.0 Interface Auth0ClientOptions
interface Auth0ClientOptions {
allowInsecureRequests?: boolean;
appBaseUrl?: string;
authorizationParameters?: AuthorizationParameters;
beforeSessionSaved?: BeforeSessionSavedHook;
clientAssertionSigningAlg?: string;
clientAssertionSigningKey?: string | CryptoKey;
clientId?: string;
clientSecret?: string;
domain?: string;
enableAccessTokenEndpoint?: boolean;
enableParallelTransactions?: boolean;
enableTelemetry?: boolean;
httpTimeout?: number;
logoutStrategy?: LogoutStrategy;
noContentProfileResponseWhenUnauthenticated?: boolean;
onCallback?: OnCallbackHook;
pushedAuthorizationRequests?: boolean;
routes?: Partial<
Pick<Routes, "login" | "callback" | "logout" | "backChannelLogout">,
>;
secret?: string;
session?: SessionConfiguration;
sessionStore?: SessionDataStore;
signInReturnToPath?: string;
transactionCookie?: TransactionCookieOptions;
}Index
Properties
Properties
Optionalallow
allowInsecureRequests?: booleanAllow insecure requests to be made to the authorization server. This can be useful when testing
with a mock OIDC provider that does not support TLS, locally.
This option can only be used when NODE_ENV is not set to production.
-Optionalapp
appBaseUrl?: stringThe URL of your application (e.g.: http://localhost:3000).
+Optionalapp
appBaseUrl?: stringThe URL of your application (e.g.: http://localhost:3000).
If it's not specified, it will be loaded from the APP_BASE_URL environment variable.
-Optionalauthorization
Additional parameters to send to the /authorize endpoint.
-Optionalbefore
A method to manipulate the session before persisting it.
+Optionalauthorization
Additional parameters to send to the /authorize endpoint.
+Optionalbefore
A method to manipulate the session before persisting it.
See beforeSessionSaved for additional details
-Optionalclient
clientAssertionSigningAlg?: stringThe algorithm used to sign the client assertion JWT.
+
Optionalclient
clientAssertionSigningAlg?: stringThe algorithm used to sign the client assertion JWT.
Uses one of token_endpoint_auth_signing_alg_values_supported if not specified.
If the Authorization Server discovery document does not list token_endpoint_auth_signing_alg_values_supported
this property will be required.
-Optionalclient
clientAssertionSigningKey?: string | CryptoKeyPrivate key for use with private_key_jwt clients.
+
Optionalclient
clientAssertionSigningKey?: string | CryptoKeyPrivate key for use with private_key_jwt clients.
This should be a string that is the contents of a PEM file or a CryptoKey.
-Optionalclient
clientId?: stringThe Auth0 client ID.
+Optionalclient
clientId?: stringThe Auth0 client ID.
If it's not specified, it will be loaded from the AUTH0_CLIENT_ID environment variable.
-Optionalclient
clientSecret?: stringThe Auth0 client secret.
+Optionalclient
clientSecret?: stringThe Auth0 client secret.
If it's not specified, it will be loaded from the AUTH0_CLIENT_SECRET environment variable.
-Optionaldomain
domain?: stringThe Auth0 domain for the tenant (e.g.: example.us.auth0.com).
+Optionaldomain
domain?: stringThe Auth0 domain for the tenant (e.g.: example.us.auth0.com).
If it's not specified, it will be loaded from the AUTH0_DOMAIN environment variable.
-Optionalenable
enableAccessTokenEndpoint?: booleanBoolean value to enable the /auth/access-token endpoint for use in the client app.
+Optionalenable
enableAccessTokenEndpoint?: booleanBoolean value to enable the /auth/access-token endpoint for use in the client app.
Defaults to true.
NOTE: Set this to false if your client does not need to directly interact with resource servers (Token Mediating Backend). This will be false for most apps.
A security best practice is to disable this to avoid exposing access tokens to the client app.
-Optionalenable
enableTelemetry?: booleanBoolean value to opt-out of sending the library name and version to your authorization server
+
Optionalenable
enableParallelTransactions?: booleanOptionalenable
enableTelemetry?: booleanBoolean value to opt-out of sending the library name and version to your authorization server
via the Auth0-Client header. Defaults to true.
-Optionalhttp
httpTimeout?: numberInteger value for the HTTP timeout in milliseconds for authentication requests.
+
Optionalhttp
httpTimeout?: numberInteger value for the HTTP timeout in milliseconds for authentication requests.
Defaults to 5000 ms.
-Optionallogout
Configure the logout strategy to use.
+Optionallogout
Configure the logout strategy to use.
'auto' (default): Attempts OIDC RP-Initiated Logout first, falls back to /v2/logout if not supported'oidc': Always uses OIDC RP-Initiated Logout (requires RP-Initiated Logout to be enabled)'v2': Always uses the Auth0 /v2/logout endpoint (supports wildcards in allowed logout URLs)
-Optionalno
noContentProfileResponseWhenUnauthenticated?: booleanIf true, the profile endpoint will return a 204 No Content response when the user is not authenticated
+
Optionalno
noContentProfileResponseWhenUnauthenticated?: booleanIf true, the profile endpoint will return a 204 No Content response when the user is not authenticated
instead of returning a 401 Unauthorized response.
Defaults to false.
-Optionalon
A method to handle errors or manage redirects after attempting to authenticate.
+Optionalon
A method to handle errors or manage redirects after attempting to authenticate.
See onCallback for additional details
-Optionalpushed
pushedAuthorizationRequests?: booleanIf enabled, the SDK will use the Pushed Authorization Requests (PAR) protocol when communicating with the authorization server.
-Optionalroutes
Configure the paths for the authentication routes.
+Optionalpushed
pushedAuthorizationRequests?: booleanIf enabled, the SDK will use the Pushed Authorization Requests (PAR) protocol when communicating with the authorization server.
+Optionalroutes
Configure the paths for the authentication routes.
See Custom routes for additional details.
-Optionalsecret
secret?: stringA 32-byte, hex-encoded secret used for encrypting cookies.
+Optionalsecret
secret?: stringA 32-byte, hex-encoded secret used for encrypting cookies.
If it's not specified, it will be loaded from the AUTH0_SECRET environment variable.
-Optionalsession
Configure the session timeouts and whether to use rolling sessions or not.
+Optionalsession
Configure the session timeouts and whether to use rolling sessions or not.
See Session configuration for additional details.
-Optionalsession
A custom session store implementation used to persist sessions to a data store.
+Optionalsession
A custom session store implementation used to persist sessions to a data store.
See Database sessions for additional details.
-Optionalsign
signInReturnToPath?: stringThe path to redirect the user to after successfully authenticating. Defaults to /.
-Optionaltransaction
Configure the transaction cookie used to store the state of the authentication transaction.
-Optionalsign
signInReturnToPath?: stringThe path to redirect the user to after successfully authenticating. Defaults to /.
+Optionaltransaction
Configure the transaction cookie used to store the state of the authentication transaction.
+AuthClientOptions | @auth0/nextjs-auth0 - v4.8.0 Interface AuthClientOptions
interface AuthClientOptions {
allowInsecureRequests?: boolean;
appBaseUrl: string;
authorizationParameters?: AuthorizationParameters;
beforeSessionSaved?: BeforeSessionSavedHook;
clientAssertionSigningAlg?: string;
clientAssertionSigningKey?: string | CryptoKey;
clientId: string;
clientSecret?: string;
domain: string;
enableAccessTokenEndpoint?: boolean;
enableTelemetry?: boolean;
fetch?: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | URL | Request, init?: RequestInit): Promise<Response>;
};
httpTimeout?: number;
jwksCache?: JWKSCacheInput;
logoutStrategy?: LogoutStrategy;
noContentProfileResponseWhenUnauthenticated?: boolean;
onCallback?: OnCallbackHook;
pushedAuthorizationRequests?: boolean;
routes?: Partial<
Pick<Routes, "login" | "callback" | "logout" | "backChannelLogout">,
>;
secret: string;
sessionStore: AbstractSessionStore;
signInReturnToPath?: string;
transactionStore: TransactionStore;
}Index
Properties
allowAuthClientOptions | @auth0/nextjs-auth0 - v4.9.0 Interface AuthClientOptions
interface AuthClientOptions {
allowInsecureRequests?: boolean;
appBaseUrl: string;
authorizationParameters?: AuthorizationParameters;
beforeSessionSaved?: BeforeSessionSavedHook;
clientAssertionSigningAlg?: string;
clientAssertionSigningKey?: string | CryptoKey;
clientId: string;
clientSecret?: string;
domain: string;
enableAccessTokenEndpoint?: boolean;
enableTelemetry?: boolean;
fetch?: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
};
httpTimeout?: number;
jwksCache?: JWKSCacheInput;
logoutStrategy?: LogoutStrategy;
noContentProfileResponseWhenUnauthenticated?: boolean;
onCallback?: OnCallbackHook;
pushedAuthorizationRequests?: boolean;
routes: Routes;
secret: string;
sessionStore: AbstractSessionStore;
signInReturnToPath?: string;
transactionStore: TransactionStore;
}Properties
Optionalallow
allowInsecureRequests?: booleanapp
appBaseUrl: stringOptionalauthorization
Optionalbefore
Optionalclient
clientAssertionSigningAlg?: stringOptionalclient
clientAssertionSigningKey?: string | CryptoKeyclient
clientId: stringOptionalclient
clientSecret?: stringdomain
domain: stringOptionalenable
enableAccessTokenEndpoint?: booleanOptionalenable
enableTelemetry?: booleanOptionalfetch
fetch?: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | URL | Request, init?: RequestInit): Promise<Response>;
}Type declaration
- (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
Parameters
- input: URL | RequestInfo
Optionalinit: RequestInit
Returns Promise<Response>
- (input: string | URL | Request, init?: RequestInit): Promise<Response>
Parameters
- input: string | URL | Request
Optionalinit: RequestInit
Returns Promise<Response>
Optionalhttp
httpTimeout?: numberOptionaljwks
jwksCache?: JWKSCacheInputOptionallogout
Optionalno
noContentProfileResponseWhenUnauthenticated?: booleanOptionalon
Optionalpushed
pushedAuthorizationRequests?: booleanOptionalroutes
secret
secret: stringsession
Optionalsign
signInReturnToPath?: stringtransaction
Properties
Optionalallow
allowInsecureRequests?: booleanapp
appBaseUrl: stringOptionalauthorization
Optionalbefore
Optionalclient
clientAssertionSigningAlg?: stringOptionalclient
clientAssertionSigningKey?: string | CryptoKeyclient
clientId: stringOptionalclient
clientSecret?: stringdomain
domain: stringOptionalenable
enableAccessTokenEndpoint?: booleanOptionalenable
enableTelemetry?: booleanOptionalfetch
fetch?: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}Type declaration
- (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
Parameters
- input: URL | RequestInfo
Optionalinit: RequestInit
Returns Promise<Response>
- (input: string | Request | URL, init?: RequestInit): Promise<Response>
Parameters
- input: string | Request | URL
Optionalinit: RequestInit
Returns Promise<Response>
Optionalhttp
httpTimeout?: numberOptionaljwks
jwksCache?: JWKSCacheInputOptionallogout
Optionalno
noContentProfileResponseWhenUnauthenticated?: booleanOptionalon
Optionalpushed
pushedAuthorizationRequests?: booleanroutes
secret
secret: stringsession
Optionalsign
signInReturnToPath?: stringtransaction
AuthorizationParameters | @auth0/nextjs-auth0 - v4.8.0 Interface AuthorizationParameters
interface AuthorizationParameters {
audience?: null | string;
max_age?: number;
redirect_uri?: null | string;
scope?: null | string;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Additional authorization parameters.
-
Index
Properties
audience?
+AuthorizationParameters | @auth0/nextjs-auth0 - v4.9.0 Interface AuthorizationParameters
interface AuthorizationParameters {
audience?: null | string;
max_age?: number;
redirect_uri?: null | string;
scope?: null | string;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Additional authorization parameters.
+
Index
Properties
Properties
Optionalaudience
audience?: null | stringThe unique identifier of the target API you want to access.
-Optionalmax_
max_age?: numberThe maximum amount of time, in seconds, after which a user must reauthenticate.
-Optionalredirect_
redirect_uri?: null | stringThe URL to which the authorization server will redirect the user after granting authorization.
-Optionalscope
scope?: null | stringThe scope of the access request, expressed as a list of space-delimited, case-sensitive strings.
+
Optionalmax_
max_age?: numberThe maximum amount of time, in seconds, after which a user must reauthenticate.
+Optionalredirect_
redirect_uri?: null | stringThe URL to which the authorization server will redirect the user after granting authorization.
+Optionalscope
scope?: null | stringThe scope of the access request, expressed as a list of space-delimited, case-sensitive strings.
Defaults to "openid profile email offline_access".
-ConnectionTokenSet | @auth0/nextjs-auth0 - v4.8.0 Interface ConnectionTokenSet
interface ConnectionTokenSet {
accessToken: string;
connection: string;
expiresAt: number;
scope?: string;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Index
Properties
accessConnectionTokenSet | @auth0/nextjs-auth0 - v4.9.0 Interface ConnectionTokenSet
interface ConnectionTokenSet {
accessToken: string;
connection: string;
expiresAt: number;
scope?: string;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Index
Properties
CookieOptions | @auth0/nextjs-auth0 - v4.8.0 Interface CookieOptions
interface CookieOptions {
domain?: string;
httpOnly: boolean;
maxAge?: number;
path: string;
sameSite: "lax" | "strict" | "none";
secure: boolean;
transient?: boolean;
}Routes | @auth0/nextjs-auth0 - v4.8.0 Interface Routes
interface Routes {
accessToken: string;
backChannelLogout: string;
callback: string;
login: string;
logout: string;
profile: string;
}Index
Properties
accessRoutes | @auth0/nextjs-auth0 - v4.9.0 Interface Routes
interface Routes {
accessToken: string;
backChannelLogout: string;
callback: string;
login: string;
logout: string;
profile: string;
}Index
Properties
SessionConfiguration | @auth0/nextjs-auth0 - v4.8.0 Interface SessionConfiguration
interface SessionConfiguration {
absoluteDuration?: number;
cookie?: SessionCookieOptions;
inactivityDuration?: number;
rolling?: boolean;
}Hierarchy (View Summary)
- SessionConfiguration
Index
Properties
absoluteSessionConfiguration | @auth0/nextjs-auth0 - v4.9.0 Interface SessionConfiguration
interface SessionConfiguration {
absoluteDuration?: number;
cookie?: SessionCookieOptions;
inactivityDuration?: number;
rolling?: boolean;
}Hierarchy (View Summary)
- SessionConfiguration
Index
Properties
Properties
Optionalabsolute
absoluteDuration?: numberThe absolute duration after which the session will expire. The value must be specified in seconds..
Once the absolute duration has been reached, the session will no longer be extended.
Default: 3 days.
-Optionalcookie
The options for the session cookie.
-Optionalinactivity
inactivityDuration?: numberThe duration of inactivity after which the session will expire. The value must be specified in seconds.
+Optionalcookie
The options for the session cookie.
+Optionalinactivity
inactivityDuration?: numberThe duration of inactivity after which the session will expire. The value must be specified in seconds.
The session will be extended as long as it was active before the inactivity duration has been reached.
Default: 1 day.
-Optionalrolling
rolling?: booleanA boolean indicating whether rolling sessions should be used or not.
+Optionalrolling
rolling?: booleanA boolean indicating whether rolling sessions should be used or not.
When enabled, the session will continue to be extended as long as it is used within the inactivity duration.
Once the upper bound, set via the absoluteDuration, has been reached, the session will no longer be extended.
Default: true.
-SessionCookieOptions | @auth0/nextjs-auth0 - v4.8.0 Interface SessionCookieOptions
interface SessionCookieOptions {
domain?: string;
name?: string;
path?: string;
sameSite?: "lax" | "strict" | "none";
secure?: boolean;
transient?: boolean;
}Index
Properties
domain?
+SessionCookieOptions | @auth0/nextjs-auth0 - v4.9.0 Interface SessionCookieOptions
interface SessionCookieOptions {
domain?: string;
name?: string;
path?: string;
sameSite?: "lax" | "strict" | "none";
secure?: boolean;
transient?: boolean;
}Properties
Optionaldomain
domain?: stringSpecifies the value for the Set-Cookie attribute. By default, no
domain is set, and most clients will consider the cookie to apply to only
the current domain.
-Optionalname
name?: stringThe name of the session cookie.
+Optionalname
name?: stringThe name of the session cookie.
Default: __session.
-Optionalpath
path?: stringThe path attribute of the session cookie. Will be set to '/' by default.
-Optionalsame
sameSite?: "lax" | "strict" | "none"The sameSite attribute of the session cookie.
+Optionalpath
path?: stringThe path attribute of the session cookie. Will be set to '/' by default.
+Optionalsame
sameSite?: "lax" | "strict" | "none"The sameSite attribute of the session cookie.
Default: lax.
-Optionalsecure
secure?: booleanThe secure attribute of the session cookie.
+Optionalsecure
secure?: booleanThe secure attribute of the session cookie.
Default: depends on the protocol of the application's base URL. If the protocol is https, then true, otherwise false.
-Optionaltransient
transient?: booleanThe transient attribute of the session cookie. When true, the cookie will not persist beyond the current session.
-Optionaltransient
transient?: booleanThe transient attribute of the session cookie. When true, the cookie will not persist beyond the current session.
+SessionData | @auth0/nextjs-auth0 - v4.8.0 Interface SessionData
interface SessionData {
connectionTokenSets?: ConnectionTokenSet[];
internal: { createdAt: number; sid: string };
tokenSet: TokenSet;
user: User;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Index
Properties
connectionSessionData | @auth0/nextjs-auth0 - v4.9.0 Interface SessionData
interface SessionData {
connectionTokenSets?: ConnectionTokenSet[];
internal: { createdAt: number; sid: string };
tokenSet: TokenSet;
user: User;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Index
Properties
SessionDataStore | @auth0/nextjs-auth0 - v4.8.0 Interface SessionDataStore
interface SessionDataStore {
delete(id: string): Promise<void>;
deleteByLogoutToken(logoutToken: LogoutToken): Promise<void>;
get(id: string): Promise<null | SessionData>;
set(id: string, session: SessionData): Promise<void>;
}Index
Methods
delete
+SessionDataStore | @auth0/nextjs-auth0 - v4.9.0 Interface SessionDataStore
interface SessionDataStore {
delete(id: string): Promise<void>;
deleteByLogoutToken(logoutToken: LogoutToken): Promise<void>;
get(id: string): Promise<null | SessionData>;
set(id: string, session: SessionData): Promise<void>;
}Index
Methods
Methods
delete
Destroys the session with the given session ID.
-Parameters
- id: string
Returns Promise<void>
Optionaldelete
Deletes the session with the given logout token which may contain a session ID or a user ID, or both.
-Parameters
- logoutToken: LogoutToken
Returns Promise<void>
get
Gets the session from the store given a session ID.
-Parameters
- id: string
Returns Promise<null | SessionData>
set
Upsert a session in the store given a session ID and SessionData.
-Parameters
- id: string
- session: SessionData
Returns Promise<void>
Parameters
- id: string
Returns Promise<void>
Optionaldelete
Deletes the session with the given logout token which may contain a session ID or a user ID, or both.
+Parameters
- logoutToken: LogoutToken
Returns Promise<void>
get
Gets the session from the store given a session ID.
+Parameters
- id: string
Returns Promise<null | SessionData>
set
Upsert a session in the store given a session ID and SessionData.
+Parameters
- id: string
- session: SessionData
Returns Promise<void>
SessionStoreOptions | @auth0/nextjs-auth0 - v4.8.0 Interface SessionStoreOptions
interface SessionStoreOptions {
absoluteDuration?: number;
cookie?: SessionCookieOptions;
cookieOptions?: SessionCookieOptions;
inactivityDuration?: number;
rolling?: boolean;
secret: string;
store?: SessionDataStore;
}Hierarchy (View Summary)
- SessionConfiguration
- SessionStoreOptions
Index
Properties
absoluteSessionStoreOptions | @auth0/nextjs-auth0 - v4.9.0 Interface SessionStoreOptions
interface SessionStoreOptions {
absoluteDuration?: number;
cookie?: SessionCookieOptions;
cookieOptions?: SessionCookieOptions;
inactivityDuration?: number;
rolling?: boolean;
secret: string;
store?: SessionDataStore;
}Hierarchy (View Summary)
- SessionConfiguration
- SessionStoreOptions
Index
Properties
Properties
Optionalabsolute
absoluteDuration?: numberThe absolute duration after which the session will expire. The value must be specified in seconds..
Once the absolute duration has been reached, the session will no longer be extended.
Default: 3 days.
-Optionalcookie
The options for the session cookie.
-Optionalcookie
Optionalinactivity
inactivityDuration?: numberThe duration of inactivity after which the session will expire. The value must be specified in seconds.
+Optionalcookie
The options for the session cookie.
+Optionalcookie
Optionalinactivity
inactivityDuration?: numberThe duration of inactivity after which the session will expire. The value must be specified in seconds.
The session will be extended as long as it was active before the inactivity duration has been reached.
Default: 1 day.
-Optionalrolling
rolling?: booleanA boolean indicating whether rolling sessions should be used or not.
+Optionalrolling
rolling?: booleanA boolean indicating whether rolling sessions should be used or not.
When enabled, the session will continue to be extended as long as it is used within the inactivity duration.
Once the upper bound, set via the absoluteDuration, has been reached, the session will no longer be extended.
Default: true.
-secret
secret: stringOptionalstore
secret
secret: stringOptionalstore
StartInteractiveLoginOptions | @auth0/nextjs-auth0 - v4.8.0 Interface StartInteractiveLoginOptions
interface StartInteractiveLoginOptions {
authorizationParameters?: AuthorizationParameters;
returnTo?: string;
}Index
Properties
authorizationStartInteractiveLoginOptions | @auth0/nextjs-auth0 - v4.9.0 Interface StartInteractiveLoginOptions
interface StartInteractiveLoginOptions {
authorizationParameters?: AuthorizationParameters;
returnTo?: string;
}Index
Properties
Optionalreturn
returnTo?: stringThe URL to redirect to after a successful login.
+TokenSet | @auth0/nextjs-auth0 - v4.8.0 Interface TokenSet
interface TokenSet {
accessToken: string;
expiresAt: number;
idToken?: string;
refreshToken?: string;
scope?: string;
}Index
Properties
accessTokenSet | @auth0/nextjs-auth0 - v4.9.0 Interface TokenSet
interface TokenSet {
accessToken: string;
expiresAt: number;
idToken?: string;
refreshToken?: string;
scope?: string;
}Index
Properties
TransactionCookieOptions | @auth0/nextjs-auth0 - v4.8.0 Interface TransactionCookieOptions
interface TransactionCookieOptions {
path?: string;
prefix?: string;
sameSite?: "lax" | "strict" | "none";
secure?: boolean;
}Index
Properties
path?
+TransactionCookieOptions | @auth0/nextjs-auth0 - v4.9.0 Interface TransactionCookieOptions
interface TransactionCookieOptions {
domain?: string;
maxAge?: number;
path?: string;
prefix?: string;
sameSite?: "lax" | "strict" | "none";
secure?: boolean;
}Properties
Optionaldomain
domain?: stringSpecifies the value for the Set-Cookie attribute. By default, no
+domain is set, and most clients will consider the cookie to apply to only
+the current domain.
+Optionalmax
maxAge?: numberThe expiration time for transaction cookies in seconds.
+If not provided, defaults to 1 hour (3600 seconds).
+Optionalpath
path?: stringThe path attribute of the transaction cookie. Will be set to '/' by default.
+Optionalprefix
prefix?: stringThe prefix of the cookie used to store the transaction state.
Default: __txn_{state}.
-Optionalsame
sameSite?: "lax" | "strict" | "none"The sameSite attribute of the transaction cookie.
+Optionalsame
sameSite?: "lax" | "strict" | "none"The sameSite attribute of the transaction cookie.
Default: lax.
-Optionalsecure
secure?: booleanThe secure attribute of the transaction cookie.
+Optionalsecure
secure?: booleanThe secure attribute of the transaction cookie.
Default: depends on the protocol of the application's base URL. If the protocol is https, then true, otherwise false.
-TransactionState | @auth0/nextjs-auth0 - v4.8.0 Interface TransactionState
interface TransactionState {
codeVerifier: string;
maxAge?: number;
nonce: string;
responseType: string;
returnTo: string;
state: string;
[propName: string]: unknown;
}Hierarchy
- JWTPayload
- TransactionState
Indexable
- [propName: string]: unknown
Any other JWT Claim Set member.
-
Index
Properties
codeTransactionState | @auth0/nextjs-auth0 - v4.9.0 Interface TransactionState
interface TransactionState {
codeVerifier: string;
maxAge?: number;
nonce: string;
responseType: string;
returnTo: string;
state: string;
[propName: string]: unknown;
}Hierarchy
- JWTPayload
- TransactionState
Indexable
- [propName: string]: unknown
Any other JWT Claim Set member.
+
Index
Properties
TransactionStoreOptions | @auth0/nextjs-auth0 - v4.8.0 Interface TransactionStoreOptions
Index
Properties
cookieTransactionStoreOptions | @auth0/nextjs-auth0 - v4.9.0 Interface TransactionStoreOptions
interface TransactionStoreOptions {
cookieOptions?: TransactionCookieOptions;
enableParallelTransactions?: boolean;
secret: string;
}Index
Properties
Properties
Optionalcookie
Optionalenable
enableParallelTransactions?: booleanControls whether multiple parallel login transactions are allowed.
+When false, only one transaction cookie is maintained at a time.
+When true (default), multiple transaction cookies can coexist for multi-tab support.
+secret
secret: stringUser | @auth0/nextjs-auth0 - v4.8.0 Interface User
interface User {
email?: string;
email_verified?: boolean;
family_name?: string;
given_name?: string;
name?: string;
nickname?: string;
org_id?: string;
picture?: string;
sub: string;
[key: string]: any;
}Indexable
- [key: string]: any
Index
Properties
email?
+User | @auth0/nextjs-auth0 - v4.9.0 Interface User
interface User {
email?: string;
email_verified?: boolean;
family_name?: string;
given_name?: string;
name?: string;
nickname?: string;
org_id?: string;
picture?: string;
sub: string;
[key: string]: any;
}Indexable
- [key: string]: any
Index
Properties
@auth0/nextjs-auth0 - v4.8.0 @auth0/nextjs-auth0 - v4.9.0 client | @auth0/nextjs-auth0 - v4.8.0 Module client
Interfaces
Type Aliases
Variables
Functions
+client | @auth0/nextjs-auth0 - v4.9.0 Module client
Interfaces
Type Aliases
Variables
Functions
diff --git a/docs/modules/errors.html b/docs/modules/errors.html
index e945fe215..84f76cc92 100644
--- a/docs/modules/errors.html
+++ b/docs/modules/errors.html
@@ -1 +1 @@
-errors | @auth0/nextjs-auth0 - v4.8.0 errors | @auth0/nextjs-auth0 - v4.9.0 server | @auth0/nextjs-auth0 - v4.8.0 Module server
Variables
Functions
+server | @auth0/nextjs-auth0 - v4.9.0 Module server
Type Aliases
Variables
Functions
diff --git a/docs/modules/testing.html b/docs/modules/testing.html
index f7723ae53..bdf20a711 100644
--- a/docs/modules/testing.html
+++ b/docs/modules/testing.html
@@ -1 +1 @@
-testing | @auth0/nextjs-auth0 - v4.8.0 testing | @auth0/nextjs-auth0 - v4.9.0 types | @auth0/nextjs-auth0 - v4.8.0 Module types
Interfaces
- AccessTokenForConnectionOptions
- Auth0ClientOptions
- AuthClientOptions
- AuthorizationParameters
- ConnectionTokenSet
- CookieOptions
- Routes
- SessionConfiguration
- SessionCookieOptions
- SessionData
- SessionDataStore
- SessionStoreOptions
- StartInteractiveLoginOptions
- TokenSet
- TransactionCookieOptions
- TransactionState
- TransactionStoreOptions
- User
+types | @auth0/nextjs-auth0 - v4.9.0 Module types
Interfaces
- AccessTokenForConnectionOptions
- Auth0ClientOptions
- AuthClientOptions
- AuthorizationParameters
- ConnectionTokenSet
- CookieOptions
- Routes
- SessionConfiguration
- SessionCookieOptions
- SessionData
- SessionDataStore
- SessionStoreOptions
- StartInteractiveLoginOptions
- TokenSet
- TransactionCookieOptions
- TransactionState
- TransactionStoreOptions
- User
diff --git a/docs/types/client.WithPageAuthRequired.html b/docs/types/client.WithPageAuthRequired.html
index c78492370..963d15af0 100644
--- a/docs/types/client.WithPageAuthRequired.html
+++ b/docs/types/client.WithPageAuthRequired.html
@@ -1,6 +1,6 @@
-WithPageAuthRequired | @auth0/nextjs-auth0 - v4.8.0 Type Alias WithPageAuthRequired
WithPageAuthRequired: <P extends object>(
Component: ComponentType<P & UserProps>,
options?: WithPageAuthRequiredOptions,
) => React.FC<P>const MyProtectedPage = withPageAuthRequired(MyPage);
+WithPageAuthRequired | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequired
WithPageAuthRequired: <P extends object>(
Component: ComponentType<P & UserProps>,
options?: WithPageAuthRequiredOptions,
) => React.FC<P>const MyProtectedPage = withPageAuthRequired(MyPage);
When you wrap your pages in this higher order component and an anonymous user visits your page,
they will be redirected to the login page and then returned to the page they were redirected from (after login).
-Type declaration
- <P extends object>(
Component: ComponentType<P & UserProps>,
options?: WithPageAuthRequiredOptions,
): React.FC<P> Type Parameters
- P extends object
Parameters
- Component: ComponentType<P & UserProps>
Optionaloptions: WithPageAuthRequiredOptions
Returns React.FC<P>
+
Type declaration
- <P extends object>(
Component: ComponentType<P & UserProps>,
options?: WithPageAuthRequiredOptions,
): React.FC<P> Type Parameters
- P extends object
Parameters
- Component: ComponentType<P & UserProps>
Optionaloptions: WithPageAuthRequiredOptions
Returns React.FC<P>
diff --git a/docs/types/server.AppRouterPageRoute.html b/docs/types/server.AppRouterPageRoute.html
new file mode 100644
index 000000000..adfdf26ab
--- /dev/null
+++ b/docs/types/server.AppRouterPageRoute.html
@@ -0,0 +1,2 @@
+AppRouterPageRoute | @auth0/nextjs-auth0 - v4.9.0 Type Alias AppRouterPageRoute
An app route that has been augmented with WithPageAuthRequired.
+Type declaration
- (obj: AppRouterPageRouteOpts): Promise<React.JSX.Element>
Parameters
Returns Promise<React.JSX.Element>
diff --git a/docs/types/server.AppRouterPageRouteOpts.html b/docs/types/server.AppRouterPageRouteOpts.html
new file mode 100644
index 000000000..ba5f897f2
--- /dev/null
+++ b/docs/types/server.AppRouterPageRouteOpts.html
@@ -0,0 +1,4 @@
+AppRouterPageRouteOpts | @auth0/nextjs-auth0 - v4.9.0 Type Alias AppRouterPageRouteOpts
Objects containing the route parameters and search parameters of the page.
+
params?: Promise<Record<string, string | string[]>>;
searchParams?: Promise<{ [key: string]: undefined | string | string[] }>;
}Index
Properties
GetServerSidePropsResultWithSession | @auth0/nextjs-auth0 - v4.9.0 Type Alias GetServerSidePropsResultWithSession<P>
If you wrap your getServerSideProps with WithPageAuthRequired your props object will be augmented with
+the user property, which will be the User object.
+// pages/profile.js
import { auth0 } from "@/lib/auth0";
export default function Profile({ user }) {
return <div>Hello {user.name}</div>;
}
export const getServerSideProps = auth0.withPageAuthRequired();
+
+
+Type Parameters
- P = any
PageRoute | @auth0/nextjs-auth0 - v4.9.0 Type Alias PageRoute<P, Q>
A page route that has been augmented with WithPageAuthRequired.
+Type Parameters
- P
- Q extends ParsedUrlQuery = ParsedUrlQuery
Type declaration
- (
ctx: GetServerSidePropsContext<Q>,
): Promise<GetServerSidePropsResultWithSession<P>> Parameters
- ctx: GetServerSidePropsContext<Q>
Returns Promise<GetServerSidePropsResultWithSession<P>>
diff --git a/docs/types/server.WithPageAuthRequired.html b/docs/types/server.WithPageAuthRequired.html
new file mode 100644
index 000000000..145e08b5c
--- /dev/null
+++ b/docs/types/server.WithPageAuthRequired.html
@@ -0,0 +1,3 @@
+WithPageAuthRequired | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequired
Protects Page router pages WithPageAuthRequiredPageRouter or
+App router pages WithPageAuthRequiredAppRouter
+
diff --git a/docs/types/server.WithPageAuthRequiredAppRouter.html b/docs/types/server.WithPageAuthRequiredAppRouter.html
new file mode 100644
index 000000000..9d22e2a39
--- /dev/null
+++ b/docs/types/server.WithPageAuthRequiredAppRouter.html
@@ -0,0 +1,17 @@
+WithPageAuthRequiredAppRouter | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequiredAppRouter
WithPageAuthRequiredAppRouter: (
fn: AppRouterPageRoute,
opts?: WithPageAuthRequiredAppRouterOptions,
) => AppRouterPageRouteWrap your Server Component with this method to make sure the user is authenticated before
+visiting the page.
+// app/protected-page/page.js
import { auth0 } from "@/lib/auth0";
const ProtectedPage = auth0.withPageAuthRequired(async function ProtectedPage() {
return <div>Protected content</div>;
}, { returnTo: '/protected-page' });
export default ProtectedPage;
+
+
+If the user visits /protected-page without a valid session, it will redirect the user to the
+login page.
+Note: Server Components are not aware of the req or the url of the page. So if you want the user to return to the
+page after login, you must specify the returnTo option.
+You can specify a function to returnTo that accepts the params (A Promise that resolves to
+an object containing the dynamic route parameters) and searchParams (A Promise that resolves to an
+object containing the search parameters of the current URL)
+argument from the page, to preserve dynamic routes and search params.
+// app/protected-page/[slug]/page.js
import { AppRouterPageRouteOpts } from '@auth0/nextjs-auth0/server';
import { auth0 } from "@/lib/auth0";
const ProtectedPage = auth0.withPageAuthRequired(async function ProtectedPage({
params, searchParams
}: AppRouterPageRouteOpts) {
const slug = (await params)?.slug as string;
return <div>Protected content for {slug}</div>;
}, {
returnTo({ params }) {
return `/protected-page/${(await params)?.slug}`;
}
});
export default ProtectedPage;
+
+
+Type declaration
- (
fn: AppRouterPageRoute,
opts?: WithPageAuthRequiredAppRouterOptions,
): AppRouterPageRoute Parameters
- fn: AppRouterPageRoute
Optionalopts: WithPageAuthRequiredAppRouterOptions
Returns AppRouterPageRoute
diff --git a/docs/types/server.WithPageAuthRequiredAppRouterOptions.html b/docs/types/server.WithPageAuthRequiredAppRouterOptions.html
new file mode 100644
index 000000000..6e56fa0bb
--- /dev/null
+++ b/docs/types/server.WithPageAuthRequiredAppRouterOptions.html
@@ -0,0 +1,4 @@
+WithPageAuthRequiredAppRouterOptions | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequiredAppRouterOptions
Specify the URL to returnTo - this is important in app router pages because the server component
+won't know the URL of the page.
+
returnTo?:
| string
| ((obj: AppRouterPageRouteOpts) => Promise<string> | string);
}Index
Properties
WithPageAuthRequiredPageRouter | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequiredPageRouter
WithPageAuthRequiredPageRouter: <
P extends { [key: string]: any } = { [key: string]: any },
Q extends ParsedUrlQuery = ParsedUrlQuery,
>(
opts?: WithPageAuthRequiredPageRouterOptions<P, Q>,
) => PageRoute<P, Q>Wrap your getServerSideProps with this method to make sure the user is authenticated before
+visiting the page.
+// pages/protected-page.js
import { auth0 } from "@/lib/auth0";
export default function ProtectedPage() {
return <div>Protected content</div>;
}
export const getServerSideProps = auth0.withPageAuthRequired();
+
+
+If the user visits /protected-page without a valid session, it will redirect the user to the
+login page. Then they will be returned to /protected-page after login.
+Type declaration
- <
P extends { [key: string]: any } = { [key: string]: any },
Q extends ParsedUrlQuery = ParsedUrlQuery,
>(
opts?: WithPageAuthRequiredPageRouterOptions<P, Q>,
): PageRoute<P, Q> Type Parameters
- P extends { [key: string]: any } = { [key: string]: any }
- Q extends ParsedUrlQuery = ParsedUrlQuery
Parameters
Optionalopts: WithPageAuthRequiredPageRouterOptions<P, Q>
Returns PageRoute<P, Q>
diff --git a/docs/types/server.WithPageAuthRequiredPageRouterOptions.html b/docs/types/server.WithPageAuthRequiredPageRouterOptions.html
new file mode 100644
index 000000000..ca50a0936
--- /dev/null
+++ b/docs/types/server.WithPageAuthRequiredPageRouterOptions.html
@@ -0,0 +1,10 @@
+WithPageAuthRequiredPageRouterOptions | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequiredPageRouterOptions<P, Q>
If you have a custom returnTo url you should specify it in returnTo.
+You can pass in your own getServerSideProps method, the props returned from this will be
+merged with the user props. You can also access the user session data by calling getSession
+inside of this method. For example:
+// pages/protected-page.js
import { auth0 } from "@/lib/auth0";
export default function ProtectedPage({ user, customProp }) {
return <div>Protected content</div>;
}
export const getServerSideProps = auth0.withPageAuthRequired({
// returnTo: '/unauthorized',
async getServerSideProps(ctx) {
// access the user session if needed
// const session = await auth0.getSession(ctx.req);
return {
props: {
// customProp: 'bar',
}
};
}
});
+
+
+
P extends { [key: string]: any } = { [key: string]: any },
Q extends ParsedUrlQuery = ParsedUrlQuery,
> = {
getServerSideProps?: GetServerSideProps<P, Q>;
returnTo?: string;
}Type Parameters
- P extends { [key: string]: any } = { [key: string]: any }
- Q extends ParsedUrlQuery = ParsedUrlQuery
Index
Properties
GenerateSessionCookieConfig | @auth0/nextjs-auth0 - v4.8.0 Type Alias GenerateSessionCookieConfig
Index
Properties
BeforeSessionSavedHook | @auth0/nextjs-auth0 - v4.8.0 Type Alias BeforeSessionSavedHook
Type declaration
- (session: SessionData, idToken: string | null): Promise<SessionData>
Parameters
- session: SessionData
- idToken: string | null
Returns Promise<SessionData>
+BeforeSessionSavedHook | @auth0/nextjs-auth0 - v4.9.0 Type Alias BeforeSessionSavedHook
Type declaration
- (session: SessionData, idToken: string | null): Promise<SessionData>
Parameters
- session: SessionData
- idToken: string | null
Returns Promise<SessionData>
diff --git a/docs/types/types.LogoutStrategy.html b/docs/types/types.LogoutStrategy.html
index 75b863775..2f0882b9b 100644
--- a/docs/types/types.LogoutStrategy.html
+++ b/docs/types/types.LogoutStrategy.html
@@ -1,2 +1,2 @@
-LogoutStrategy | @auth0/nextjs-auth0 - v4.8.0 Type Alias LogoutStrategy
LogoutStrategy: "auto" | "oidc" | "v2"Logout strategy options for controlling logout endpoint selection.
-
+LogoutStrategy | @auth0/nextjs-auth0 - v4.9.0 Type Alias LogoutStrategy
LogoutStrategy: "auto" | "oidc" | "v2"Logout strategy options for controlling logout endpoint selection.
+
diff --git a/docs/types/types.LogoutToken.html b/docs/types/types.LogoutToken.html
index ba9bf450e..4a499369a 100644
--- a/docs/types/types.LogoutToken.html
+++ b/docs/types/types.LogoutToken.html
@@ -1,3 +1,3 @@
-LogoutToken | @auth0/nextjs-auth0 - v4.8.0 Type Alias LogoutToken
OnCallbackContext | @auth0/nextjs-auth0 - v4.8.0 OnCallbackContext | @auth0/nextjs-auth0 - v4.9.0 OnCallbackHook | @auth0/nextjs-auth0 - v4.8.0 Type Alias OnCallbackHook
OnCallbackHook: (
error: SdkError | null,
ctx: OnCallbackContext,
session: SessionData | null,
) => Promise<NextResponse>Type declaration
- (
error: SdkError | null,
ctx: OnCallbackContext,
session: SessionData | null,
): Promise<NextResponse> Parameters
- error: SdkError | null
- ctx: OnCallbackContext
- session: SessionData | null
Returns Promise<NextResponse>
+OnCallbackHook | @auth0/nextjs-auth0 - v4.9.0 Type Alias OnCallbackHook
OnCallbackHook: (
error: SdkError | null,
ctx: OnCallbackContext,
session: SessionData | null,
) => Promise<NextResponse>Type declaration
- (
error: SdkError | null,
ctx: OnCallbackContext,
session: SessionData | null,
): Promise<NextResponse> Parameters
- error: SdkError | null
- ctx: OnCallbackContext
- session: SessionData | null
Returns Promise<NextResponse>
diff --git a/docs/types/types.PagesRouterRequest.html b/docs/types/types.PagesRouterRequest.html
index b19e08f29..a36bbceac 100644
--- a/docs/types/types.PagesRouterRequest.html
+++ b/docs/types/types.PagesRouterRequest.html
@@ -1 +1 @@
-PagesRouterRequest | @auth0/nextjs-auth0 - v4.8.0 Type Alias PagesRouterRequest
PagesRouterRequest: IncomingMessage | NextApiRequest
+PagesRouterRequest | @auth0/nextjs-auth0 - v4.9.0 Type Alias PagesRouterRequest
PagesRouterRequest: IncomingMessage | NextApiRequest
diff --git a/docs/types/types.PagesRouterResponse.html b/docs/types/types.PagesRouterResponse.html
index b5780a729..f0ff82438 100644
--- a/docs/types/types.PagesRouterResponse.html
+++ b/docs/types/types.PagesRouterResponse.html
@@ -1 +1 @@
-PagesRouterResponse | @auth0/nextjs-auth0 - v4.8.0 Type Alias PagesRouterResponse
PagesRouterResponse: ServerResponse<IncomingMessage> | NextApiResponse
+PagesRouterResponse | @auth0/nextjs-auth0 - v4.9.0 Type Alias PagesRouterResponse
PagesRouterResponse: ServerResponse<IncomingMessage> | NextApiResponse
diff --git a/docs/types/types.ReadonlyRequestCookies.html b/docs/types/types.ReadonlyRequestCookies.html
index b3ce1cea0..e920fd124 100644
--- a/docs/types/types.ReadonlyRequestCookies.html
+++ b/docs/types/types.ReadonlyRequestCookies.html
@@ -1 +1 @@
-ReadonlyRequestCookies | @auth0/nextjs-auth0 - v4.8.0 Type Alias ReadonlyRequestCookies
ReadonlyRequestCookies: Omit<RequestCookies, "set" | "clear" | "delete"> & Pick<
ResponseCookies,
"set"
| "delete",
>
+ReadonlyRequestCookies | @auth0/nextjs-auth0 - v4.9.0 Type Alias ReadonlyRequestCookies
ReadonlyRequestCookies: Omit<RequestCookies, "set" | "clear" | "delete"> & Pick<
ResponseCookies,
"set"
| "delete",
>
diff --git a/docs/types/types.RoutesOptions.html b/docs/types/types.RoutesOptions.html
index a9c3226b3..e35f2e3ba 100644
--- a/docs/types/types.RoutesOptions.html
+++ b/docs/types/types.RoutesOptions.html
@@ -1 +1 @@
-RoutesOptions | @auth0/nextjs-auth0 - v4.8.0 Type Alias RoutesOptions
+RoutesOptions | @auth0/nextjs-auth0 - v4.9.0 Type Alias RoutesOptions
diff --git a/docs/variables/client.withPageAuthRequired.html b/docs/variables/client.withPageAuthRequired.html
index abb7be418..5dd0a608e 100644
--- a/docs/variables/client.withPageAuthRequired.html
+++ b/docs/variables/client.withPageAuthRequired.html
@@ -1 +1 @@
-withPageAuthRequired | @auth0/nextjs-auth0 - v4.8.0 Variable withPageAuthRequiredConst
+withPageAuthRequired | @auth0/nextjs-auth0 - v4.9.0 Variable withPageAuthRequiredConst
diff --git a/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html b/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html
index 22aa5d30d..afc49fb66 100644
--- a/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html
+++ b/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html
@@ -1,2 +1,2 @@
-DEFAULT_ID_TOKEN_CLAIMS | @auth0/nextjs-auth0 - v4.8.0 Variable DEFAULT_ID_TOKEN_CLAIMSConst
DEFAULT_ID_TOKEN_CLAIMS: string[] = ...Default claims for the ID token.
-
+DEFAULT_ID_TOKEN_CLAIMS | @auth0/nextjs-auth0 - v4.9.0 Variable DEFAULT_ID_TOKEN_CLAIMSConst
DEFAULT_ID_TOKEN_CLAIMS: string[] = ...Default claims for the ID token.
+
diff --git a/package.json b/package.json
index 227a3f231..bcb5ae0c0 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "@auth0/nextjs-auth0",
- "version": "4.8.0",
+ "version": "4.9.0",
"description": "Auth0 Next.js SDK",
"type": "module",
"scripts": {
onCallback hook to add custom logic after authentication completesbeforeSessionSaved hook+When customizing auth handlers, always validate user inputs (especially redirect URLs) to prevent security vulnerabilities like open redirects. Use relative URLs when possible and implement proper input sanitization.
+AUTH0_COOKIE_DOMAIN=
AUTH0_COOKIE_PATH=
@@ -217,4 +245,4 @@ What is Auth0?
This project is licensed under the MIT license. See the LICENSE file for more info.
-
+
diff --git a/docs/interfaces/client.WithPageAuthRequiredOptions.html b/docs/interfaces/client.WithPageAuthRequiredOptions.html
index 315addcf3..86385064f 100644
--- a/docs/interfaces/client.WithPageAuthRequiredOptions.html
+++ b/docs/interfaces/client.WithPageAuthRequiredOptions.html
@@ -1,17 +1,17 @@
-WithPageAuthRequiredOptions | @auth0/nextjs-auth0 - v4.8.0 Interface WithPageAuthRequiredOptions
Options to customize the withPageAuthRequired higher order component.
-
onError?: (error: Error) => Element;
onRedirecting?: () => Element;
returnTo?: string;
}Index
Properties
onWithPageAuthRequiredOptions | @auth0/nextjs-auth0 - v4.9.0 Interface WithPageAuthRequiredOptions
Options to customize the withPageAuthRequired higher order component.
+
onError?: (error: Error) => Element;
onRedirecting?: () => Element;
returnTo?: string;
}Index
Properties
Properties
Optionalon
onError?: (error: Error) => ElementwithPageAuthRequired(Profile, {
onError: error => <div>Error: {error.message}</div>
});
Render a fallback in case of error fetching the user from the profile API route.
-Optionalon
onRedirecting?: () => ElementwithPageAuthRequired(Profile, {
onRedirecting: () => <div>Redirecting...</div>
});
+
Optionalon
onRedirecting?: () => ElementwithPageAuthRequired(Profile, {
onRedirecting: () => <div>Redirecting...</div>
});
Render a message to show that the user is being redirected.
-Optionalreturn
returnTo?: stringwithPageAuthRequired(Profile, {
returnTo: '/profile'
});
+
Optionalreturn
returnTo?: stringwithPageAuthRequired(Profile, {
returnTo: '/profile'
});
Add a path to return the user to after login.
-AccessTokenForConnectionOptions | @auth0/nextjs-auth0 - v4.8.0 Interface AccessTokenForConnectionOptions
Options for retrieving a connection access token.
-Index
Properties
connection
+AccessTokenForConnectionOptions | @auth0/nextjs-auth0 - v4.9.0 Interface AccessTokenForConnectionOptions
Options for retrieving a connection access token.
+Index
Properties
Optionallogin_
login_hint?: stringAn optional login hint to pass to the authorization server.
+Auth0ClientOptions | @auth0/nextjs-auth0 - v4.8.0 Interface Auth0ClientOptions
interface Auth0ClientOptions {
allowInsecureRequests?: boolean;
appBaseUrl?: string;
authorizationParameters?: AuthorizationParameters;
beforeSessionSaved?: BeforeSessionSavedHook;
clientAssertionSigningAlg?: string;
clientAssertionSigningKey?: string | CryptoKey;
clientId?: string;
clientSecret?: string;
domain?: string;
enableAccessTokenEndpoint?: boolean;
enableTelemetry?: boolean;
httpTimeout?: number;
logoutStrategy?: LogoutStrategy;
noContentProfileResponseWhenUnauthenticated?: boolean;
onCallback?: OnCallbackHook;
pushedAuthorizationRequests?: boolean;
routes?: Partial<
Pick<Routes, "login" | "callback" | "logout" | "backChannelLogout">,
>;
secret?: string;
session?: SessionConfiguration;
sessionStore?: SessionDataStore;
signInReturnToPath?: string;
transactionCookie?: TransactionCookieOptions;
}Index
Properties
allowAuth0ClientOptions | @auth0/nextjs-auth0 - v4.9.0 Interface Auth0ClientOptions
interface Auth0ClientOptions {
allowInsecureRequests?: boolean;
appBaseUrl?: string;
authorizationParameters?: AuthorizationParameters;
beforeSessionSaved?: BeforeSessionSavedHook;
clientAssertionSigningAlg?: string;
clientAssertionSigningKey?: string | CryptoKey;
clientId?: string;
clientSecret?: string;
domain?: string;
enableAccessTokenEndpoint?: boolean;
enableParallelTransactions?: boolean;
enableTelemetry?: boolean;
httpTimeout?: number;
logoutStrategy?: LogoutStrategy;
noContentProfileResponseWhenUnauthenticated?: boolean;
onCallback?: OnCallbackHook;
pushedAuthorizationRequests?: boolean;
routes?: Partial<
Pick<Routes, "login" | "callback" | "logout" | "backChannelLogout">,
>;
secret?: string;
session?: SessionConfiguration;
sessionStore?: SessionDataStore;
signInReturnToPath?: string;
transactionCookie?: TransactionCookieOptions;
}Index
Properties
Properties
Optionalallow
allowInsecureRequests?: booleanAllow insecure requests to be made to the authorization server. This can be useful when testing
with a mock OIDC provider that does not support TLS, locally.
This option can only be used when NODE_ENV is not set to production.
-Optionalapp
appBaseUrl?: stringThe URL of your application (e.g.: http://localhost:3000).
+Optionalapp
appBaseUrl?: stringThe URL of your application (e.g.: http://localhost:3000).
If it's not specified, it will be loaded from the APP_BASE_URL environment variable.
-Optionalauthorization
Additional parameters to send to the /authorize endpoint.
-Optionalbefore
A method to manipulate the session before persisting it.
+Optionalauthorization
Additional parameters to send to the /authorize endpoint.
+Optionalbefore
A method to manipulate the session before persisting it.
See beforeSessionSaved for additional details
-Optionalclient
clientAssertionSigningAlg?: stringThe algorithm used to sign the client assertion JWT.
+
Optionalclient
clientAssertionSigningAlg?: stringThe algorithm used to sign the client assertion JWT.
Uses one of token_endpoint_auth_signing_alg_values_supported if not specified.
If the Authorization Server discovery document does not list token_endpoint_auth_signing_alg_values_supported
this property will be required.
-Optionalclient
clientAssertionSigningKey?: string | CryptoKeyPrivate key for use with private_key_jwt clients.
+
Optionalclient
clientAssertionSigningKey?: string | CryptoKeyPrivate key for use with private_key_jwt clients.
This should be a string that is the contents of a PEM file or a CryptoKey.
-Optionalclient
clientId?: stringThe Auth0 client ID.
+Optionalclient
clientId?: stringThe Auth0 client ID.
If it's not specified, it will be loaded from the AUTH0_CLIENT_ID environment variable.
-Optionalclient
clientSecret?: stringThe Auth0 client secret.
+Optionalclient
clientSecret?: stringThe Auth0 client secret.
If it's not specified, it will be loaded from the AUTH0_CLIENT_SECRET environment variable.
-Optionaldomain
domain?: stringThe Auth0 domain for the tenant (e.g.: example.us.auth0.com).
+Optionaldomain
domain?: stringThe Auth0 domain for the tenant (e.g.: example.us.auth0.com).
If it's not specified, it will be loaded from the AUTH0_DOMAIN environment variable.
-Optionalenable
enableAccessTokenEndpoint?: booleanBoolean value to enable the /auth/access-token endpoint for use in the client app.
+Optionalenable
enableAccessTokenEndpoint?: booleanBoolean value to enable the /auth/access-token endpoint for use in the client app.
Defaults to true.
NOTE: Set this to false if your client does not need to directly interact with resource servers (Token Mediating Backend). This will be false for most apps.
A security best practice is to disable this to avoid exposing access tokens to the client app.
-Optionalenable
enableTelemetry?: booleanBoolean value to opt-out of sending the library name and version to your authorization server
+
Optionalenable
enableParallelTransactions?: booleanOptionalenable
enableTelemetry?: booleanBoolean value to opt-out of sending the library name and version to your authorization server
via the Auth0-Client header. Defaults to true.
-Optionalhttp
httpTimeout?: numberInteger value for the HTTP timeout in milliseconds for authentication requests.
+
Optionalhttp
httpTimeout?: numberInteger value for the HTTP timeout in milliseconds for authentication requests.
Defaults to 5000 ms.
-Optionallogout
Configure the logout strategy to use.
+Optionallogout
Configure the logout strategy to use.
'auto' (default): Attempts OIDC RP-Initiated Logout first, falls back to /v2/logout if not supported'oidc': Always uses OIDC RP-Initiated Logout (requires RP-Initiated Logout to be enabled)'v2': Always uses the Auth0 /v2/logout endpoint (supports wildcards in allowed logout URLs)
-Optionalno
noContentProfileResponseWhenUnauthenticated?: booleanIf true, the profile endpoint will return a 204 No Content response when the user is not authenticated
+
Optionalno
noContentProfileResponseWhenUnauthenticated?: booleanIf true, the profile endpoint will return a 204 No Content response when the user is not authenticated
instead of returning a 401 Unauthorized response.
Defaults to false.
-Optionalon
A method to handle errors or manage redirects after attempting to authenticate.
+Optionalon
A method to handle errors or manage redirects after attempting to authenticate.
See onCallback for additional details
-Optionalpushed
pushedAuthorizationRequests?: booleanIf enabled, the SDK will use the Pushed Authorization Requests (PAR) protocol when communicating with the authorization server.
-Optionalroutes
Configure the paths for the authentication routes.
+Optionalpushed
pushedAuthorizationRequests?: booleanIf enabled, the SDK will use the Pushed Authorization Requests (PAR) protocol when communicating with the authorization server.
+Optionalroutes
Configure the paths for the authentication routes.
See Custom routes for additional details.
-Optionalsecret
secret?: stringA 32-byte, hex-encoded secret used for encrypting cookies.
+Optionalsecret
secret?: stringA 32-byte, hex-encoded secret used for encrypting cookies.
If it's not specified, it will be loaded from the AUTH0_SECRET environment variable.
-Optionalsession
Configure the session timeouts and whether to use rolling sessions or not.
+Optionalsession
Configure the session timeouts and whether to use rolling sessions or not.
See Session configuration for additional details.
-Optionalsession
A custom session store implementation used to persist sessions to a data store.
+Optionalsession
A custom session store implementation used to persist sessions to a data store.
See Database sessions for additional details.
-Optionalsign
signInReturnToPath?: stringThe path to redirect the user to after successfully authenticating. Defaults to /.
-Optionaltransaction
Configure the transaction cookie used to store the state of the authentication transaction.
-Optionalsign
signInReturnToPath?: stringThe path to redirect the user to after successfully authenticating. Defaults to /.
+Optionaltransaction
Configure the transaction cookie used to store the state of the authentication transaction.
+AuthClientOptions | @auth0/nextjs-auth0 - v4.8.0 Interface AuthClientOptions
interface AuthClientOptions {
allowInsecureRequests?: boolean;
appBaseUrl: string;
authorizationParameters?: AuthorizationParameters;
beforeSessionSaved?: BeforeSessionSavedHook;
clientAssertionSigningAlg?: string;
clientAssertionSigningKey?: string | CryptoKey;
clientId: string;
clientSecret?: string;
domain: string;
enableAccessTokenEndpoint?: boolean;
enableTelemetry?: boolean;
fetch?: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | URL | Request, init?: RequestInit): Promise<Response>;
};
httpTimeout?: number;
jwksCache?: JWKSCacheInput;
logoutStrategy?: LogoutStrategy;
noContentProfileResponseWhenUnauthenticated?: boolean;
onCallback?: OnCallbackHook;
pushedAuthorizationRequests?: boolean;
routes?: Partial<
Pick<Routes, "login" | "callback" | "logout" | "backChannelLogout">,
>;
secret: string;
sessionStore: AbstractSessionStore;
signInReturnToPath?: string;
transactionStore: TransactionStore;
}Index
Properties
allowAuthClientOptions | @auth0/nextjs-auth0 - v4.9.0 Interface AuthClientOptions
interface AuthClientOptions {
allowInsecureRequests?: boolean;
appBaseUrl: string;
authorizationParameters?: AuthorizationParameters;
beforeSessionSaved?: BeforeSessionSavedHook;
clientAssertionSigningAlg?: string;
clientAssertionSigningKey?: string | CryptoKey;
clientId: string;
clientSecret?: string;
domain: string;
enableAccessTokenEndpoint?: boolean;
enableTelemetry?: boolean;
fetch?: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
};
httpTimeout?: number;
jwksCache?: JWKSCacheInput;
logoutStrategy?: LogoutStrategy;
noContentProfileResponseWhenUnauthenticated?: boolean;
onCallback?: OnCallbackHook;
pushedAuthorizationRequests?: boolean;
routes: Routes;
secret: string;
sessionStore: AbstractSessionStore;
signInReturnToPath?: string;
transactionStore: TransactionStore;
}Properties
Optionalallow
allowInsecureRequests?: booleanapp
appBaseUrl: stringOptionalauthorization
Optionalbefore
Optionalclient
clientAssertionSigningAlg?: stringOptionalclient
clientAssertionSigningKey?: string | CryptoKeyclient
clientId: stringOptionalclient
clientSecret?: stringdomain
domain: stringOptionalenable
enableAccessTokenEndpoint?: booleanOptionalenable
enableTelemetry?: booleanOptionalfetch
fetch?: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | URL | Request, init?: RequestInit): Promise<Response>;
}Type declaration
- (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
Parameters
- input: URL | RequestInfo
Optionalinit: RequestInit
Returns Promise<Response>
- (input: string | URL | Request, init?: RequestInit): Promise<Response>
Parameters
- input: string | URL | Request
Optionalinit: RequestInit
Returns Promise<Response>
Optionalhttp
httpTimeout?: numberOptionaljwks
jwksCache?: JWKSCacheInputOptionallogout
Optionalno
noContentProfileResponseWhenUnauthenticated?: booleanOptionalon
Optionalpushed
pushedAuthorizationRequests?: booleanOptionalroutes
secret
secret: stringsession
Optionalsign
signInReturnToPath?: stringtransaction
Properties
Optionalallow
allowInsecureRequests?: booleanapp
appBaseUrl: stringOptionalauthorization
Optionalbefore
Optionalclient
clientAssertionSigningAlg?: stringOptionalclient
clientAssertionSigningKey?: string | CryptoKeyclient
clientId: stringOptionalclient
clientSecret?: stringdomain
domain: stringOptionalenable
enableAccessTokenEndpoint?: booleanOptionalenable
enableTelemetry?: booleanOptionalfetch
fetch?: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}Type declaration
- (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
Parameters
- input: URL | RequestInfo
Optionalinit: RequestInit
Returns Promise<Response>
- (input: string | Request | URL, init?: RequestInit): Promise<Response>
Parameters
- input: string | Request | URL
Optionalinit: RequestInit
Returns Promise<Response>
Optionalhttp
httpTimeout?: numberOptionaljwks
jwksCache?: JWKSCacheInputOptionallogout
Optionalno
noContentProfileResponseWhenUnauthenticated?: booleanOptionalon
Optionalpushed
pushedAuthorizationRequests?: booleanroutes
secret
secret: stringsession
Optionalsign
signInReturnToPath?: stringtransaction
AuthorizationParameters | @auth0/nextjs-auth0 - v4.8.0 Interface AuthorizationParameters
interface AuthorizationParameters {
audience?: null | string;
max_age?: number;
redirect_uri?: null | string;
scope?: null | string;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Additional authorization parameters.
-
Index
Properties
audience?
+AuthorizationParameters | @auth0/nextjs-auth0 - v4.9.0 Interface AuthorizationParameters
interface AuthorizationParameters {
audience?: null | string;
max_age?: number;
redirect_uri?: null | string;
scope?: null | string;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Additional authorization parameters.
+
Index
Properties
Properties
Optionalaudience
audience?: null | stringThe unique identifier of the target API you want to access.
-Optionalmax_
max_age?: numberThe maximum amount of time, in seconds, after which a user must reauthenticate.
-Optionalredirect_
redirect_uri?: null | stringThe URL to which the authorization server will redirect the user after granting authorization.
-Optionalscope
scope?: null | stringThe scope of the access request, expressed as a list of space-delimited, case-sensitive strings.
+
Optionalmax_
max_age?: numberThe maximum amount of time, in seconds, after which a user must reauthenticate.
+Optionalredirect_
redirect_uri?: null | stringThe URL to which the authorization server will redirect the user after granting authorization.
+Optionalscope
scope?: null | stringThe scope of the access request, expressed as a list of space-delimited, case-sensitive strings.
Defaults to "openid profile email offline_access".
-ConnectionTokenSet | @auth0/nextjs-auth0 - v4.8.0 Interface ConnectionTokenSet
interface ConnectionTokenSet {
accessToken: string;
connection: string;
expiresAt: number;
scope?: string;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Index
Properties
accessConnectionTokenSet | @auth0/nextjs-auth0 - v4.9.0 Interface ConnectionTokenSet
interface ConnectionTokenSet {
accessToken: string;
connection: string;
expiresAt: number;
scope?: string;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Index
Properties
CookieOptions | @auth0/nextjs-auth0 - v4.8.0 Interface CookieOptions
interface CookieOptions {
domain?: string;
httpOnly: boolean;
maxAge?: number;
path: string;
sameSite: "lax" | "strict" | "none";
secure: boolean;
transient?: boolean;
}Routes | @auth0/nextjs-auth0 - v4.8.0 Interface Routes
interface Routes {
accessToken: string;
backChannelLogout: string;
callback: string;
login: string;
logout: string;
profile: string;
}Index
Properties
accessRoutes | @auth0/nextjs-auth0 - v4.9.0 Interface Routes
interface Routes {
accessToken: string;
backChannelLogout: string;
callback: string;
login: string;
logout: string;
profile: string;
}Index
Properties
SessionConfiguration | @auth0/nextjs-auth0 - v4.8.0 Interface SessionConfiguration
interface SessionConfiguration {
absoluteDuration?: number;
cookie?: SessionCookieOptions;
inactivityDuration?: number;
rolling?: boolean;
}Hierarchy (View Summary)
- SessionConfiguration
Index
Properties
absoluteSessionConfiguration | @auth0/nextjs-auth0 - v4.9.0 Interface SessionConfiguration
interface SessionConfiguration {
absoluteDuration?: number;
cookie?: SessionCookieOptions;
inactivityDuration?: number;
rolling?: boolean;
}Hierarchy (View Summary)
- SessionConfiguration
Index
Properties
Properties
Optionalabsolute
absoluteDuration?: numberThe absolute duration after which the session will expire. The value must be specified in seconds..
Once the absolute duration has been reached, the session will no longer be extended.
Default: 3 days.
-Optionalcookie
The options for the session cookie.
-Optionalinactivity
inactivityDuration?: numberThe duration of inactivity after which the session will expire. The value must be specified in seconds.
+Optionalcookie
The options for the session cookie.
+Optionalinactivity
inactivityDuration?: numberThe duration of inactivity after which the session will expire. The value must be specified in seconds.
The session will be extended as long as it was active before the inactivity duration has been reached.
Default: 1 day.
-Optionalrolling
rolling?: booleanA boolean indicating whether rolling sessions should be used or not.
+Optionalrolling
rolling?: booleanA boolean indicating whether rolling sessions should be used or not.
When enabled, the session will continue to be extended as long as it is used within the inactivity duration.
Once the upper bound, set via the absoluteDuration, has been reached, the session will no longer be extended.
Default: true.
-SessionCookieOptions | @auth0/nextjs-auth0 - v4.8.0 Interface SessionCookieOptions
interface SessionCookieOptions {
domain?: string;
name?: string;
path?: string;
sameSite?: "lax" | "strict" | "none";
secure?: boolean;
transient?: boolean;
}Index
Properties
domain?
+SessionCookieOptions | @auth0/nextjs-auth0 - v4.9.0 Interface SessionCookieOptions
interface SessionCookieOptions {
domain?: string;
name?: string;
path?: string;
sameSite?: "lax" | "strict" | "none";
secure?: boolean;
transient?: boolean;
}Properties
Optionaldomain
domain?: stringSpecifies the value for the Set-Cookie attribute. By default, no
domain is set, and most clients will consider the cookie to apply to only
the current domain.
-Optionalname
name?: stringThe name of the session cookie.
+Optionalname
name?: stringThe name of the session cookie.
Default: __session.
-Optionalpath
path?: stringThe path attribute of the session cookie. Will be set to '/' by default.
-Optionalsame
sameSite?: "lax" | "strict" | "none"The sameSite attribute of the session cookie.
+Optionalpath
path?: stringThe path attribute of the session cookie. Will be set to '/' by default.
+Optionalsame
sameSite?: "lax" | "strict" | "none"The sameSite attribute of the session cookie.
Default: lax.
-Optionalsecure
secure?: booleanThe secure attribute of the session cookie.
+Optionalsecure
secure?: booleanThe secure attribute of the session cookie.
Default: depends on the protocol of the application's base URL. If the protocol is https, then true, otherwise false.
-Optionaltransient
transient?: booleanThe transient attribute of the session cookie. When true, the cookie will not persist beyond the current session.
-Optionaltransient
transient?: booleanThe transient attribute of the session cookie. When true, the cookie will not persist beyond the current session.
+SessionData | @auth0/nextjs-auth0 - v4.8.0 Interface SessionData
interface SessionData {
connectionTokenSets?: ConnectionTokenSet[];
internal: { createdAt: number; sid: string };
tokenSet: TokenSet;
user: User;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Index
Properties
connectionSessionData | @auth0/nextjs-auth0 - v4.9.0 Interface SessionData
interface SessionData {
connectionTokenSets?: ConnectionTokenSet[];
internal: { createdAt: number; sid: string };
tokenSet: TokenSet;
user: User;
[key: string]: unknown;
}Indexable
- [key: string]: unknown
Index
Properties
SessionDataStore | @auth0/nextjs-auth0 - v4.8.0 Interface SessionDataStore
interface SessionDataStore {
delete(id: string): Promise<void>;
deleteByLogoutToken(logoutToken: LogoutToken): Promise<void>;
get(id: string): Promise<null | SessionData>;
set(id: string, session: SessionData): Promise<void>;
}Index
Methods
delete
+SessionDataStore | @auth0/nextjs-auth0 - v4.9.0 Interface SessionDataStore
interface SessionDataStore {
delete(id: string): Promise<void>;
deleteByLogoutToken(logoutToken: LogoutToken): Promise<void>;
get(id: string): Promise<null | SessionData>;
set(id: string, session: SessionData): Promise<void>;
}Index
Methods
Methods
delete
Destroys the session with the given session ID.
-Parameters
- id: string
Returns Promise<void>
Optionaldelete
Deletes the session with the given logout token which may contain a session ID or a user ID, or both.
-Parameters
- logoutToken: LogoutToken
Returns Promise<void>
get
Gets the session from the store given a session ID.
-Parameters
- id: string
Returns Promise<null | SessionData>
set
Upsert a session in the store given a session ID and SessionData.
-Parameters
- id: string
- session: SessionData
Returns Promise<void>
Parameters
- id: string
Returns Promise<void>
Optionaldelete
Deletes the session with the given logout token which may contain a session ID or a user ID, or both.
+Parameters
- logoutToken: LogoutToken
Returns Promise<void>
get
Gets the session from the store given a session ID.
+Parameters
- id: string
Returns Promise<null | SessionData>
set
Upsert a session in the store given a session ID and SessionData.
+Parameters
- id: string
- session: SessionData
Returns Promise<void>
SessionStoreOptions | @auth0/nextjs-auth0 - v4.8.0 Interface SessionStoreOptions
interface SessionStoreOptions {
absoluteDuration?: number;
cookie?: SessionCookieOptions;
cookieOptions?: SessionCookieOptions;
inactivityDuration?: number;
rolling?: boolean;
secret: string;
store?: SessionDataStore;
}Hierarchy (View Summary)
- SessionConfiguration
- SessionStoreOptions
Index
Properties
absoluteSessionStoreOptions | @auth0/nextjs-auth0 - v4.9.0 Interface SessionStoreOptions
interface SessionStoreOptions {
absoluteDuration?: number;
cookie?: SessionCookieOptions;
cookieOptions?: SessionCookieOptions;
inactivityDuration?: number;
rolling?: boolean;
secret: string;
store?: SessionDataStore;
}Hierarchy (View Summary)
- SessionConfiguration
- SessionStoreOptions
Index
Properties
Properties
Optionalabsolute
absoluteDuration?: numberThe absolute duration after which the session will expire. The value must be specified in seconds..
Once the absolute duration has been reached, the session will no longer be extended.
Default: 3 days.
-Optionalcookie
The options for the session cookie.
-Optionalcookie
Optionalinactivity
inactivityDuration?: numberThe duration of inactivity after which the session will expire. The value must be specified in seconds.
+Optionalcookie
The options for the session cookie.
+Optionalcookie
Optionalinactivity
inactivityDuration?: numberThe duration of inactivity after which the session will expire. The value must be specified in seconds.
The session will be extended as long as it was active before the inactivity duration has been reached.
Default: 1 day.
-Optionalrolling
rolling?: booleanA boolean indicating whether rolling sessions should be used or not.
+Optionalrolling
rolling?: booleanA boolean indicating whether rolling sessions should be used or not.
When enabled, the session will continue to be extended as long as it is used within the inactivity duration.
Once the upper bound, set via the absoluteDuration, has been reached, the session will no longer be extended.
Default: true.
-secret
secret: stringOptionalstore
secret
secret: stringOptionalstore
StartInteractiveLoginOptions | @auth0/nextjs-auth0 - v4.8.0 Interface StartInteractiveLoginOptions
interface StartInteractiveLoginOptions {
authorizationParameters?: AuthorizationParameters;
returnTo?: string;
}Index
Properties
authorizationStartInteractiveLoginOptions | @auth0/nextjs-auth0 - v4.9.0 Interface StartInteractiveLoginOptions
interface StartInteractiveLoginOptions {
authorizationParameters?: AuthorizationParameters;
returnTo?: string;
}Index
Properties
Optionalreturn
returnTo?: stringThe URL to redirect to after a successful login.
+TokenSet | @auth0/nextjs-auth0 - v4.8.0 Interface TokenSet
interface TokenSet {
accessToken: string;
expiresAt: number;
idToken?: string;
refreshToken?: string;
scope?: string;
}Index
Properties
accessTokenSet | @auth0/nextjs-auth0 - v4.9.0 Interface TokenSet
interface TokenSet {
accessToken: string;
expiresAt: number;
idToken?: string;
refreshToken?: string;
scope?: string;
}Index
Properties
TransactionCookieOptions | @auth0/nextjs-auth0 - v4.8.0 Interface TransactionCookieOptions
interface TransactionCookieOptions {
path?: string;
prefix?: string;
sameSite?: "lax" | "strict" | "none";
secure?: boolean;
}Index
Properties
path?
+TransactionCookieOptions | @auth0/nextjs-auth0 - v4.9.0 Interface TransactionCookieOptions
interface TransactionCookieOptions {
domain?: string;
maxAge?: number;
path?: string;
prefix?: string;
sameSite?: "lax" | "strict" | "none";
secure?: boolean;
}Properties
Optionaldomain
domain?: stringSpecifies the value for the Set-Cookie attribute. By default, no
+domain is set, and most clients will consider the cookie to apply to only
+the current domain.
+Optionalmax
maxAge?: numberThe expiration time for transaction cookies in seconds.
+If not provided, defaults to 1 hour (3600 seconds).
+Optionalpath
path?: stringThe path attribute of the transaction cookie. Will be set to '/' by default.
+Optionalprefix
prefix?: stringThe prefix of the cookie used to store the transaction state.
Default: __txn_{state}.
-Optionalsame
sameSite?: "lax" | "strict" | "none"The sameSite attribute of the transaction cookie.
+Optionalsame
sameSite?: "lax" | "strict" | "none"The sameSite attribute of the transaction cookie.
Default: lax.
-Optionalsecure
secure?: booleanThe secure attribute of the transaction cookie.
+Optionalsecure
secure?: booleanThe secure attribute of the transaction cookie.
Default: depends on the protocol of the application's base URL. If the protocol is https, then true, otherwise false.
-TransactionState | @auth0/nextjs-auth0 - v4.8.0 Interface TransactionState
interface TransactionState {
codeVerifier: string;
maxAge?: number;
nonce: string;
responseType: string;
returnTo: string;
state: string;
[propName: string]: unknown;
}Hierarchy
- JWTPayload
- TransactionState
Indexable
- [propName: string]: unknown
Any other JWT Claim Set member.
-
Index
Properties
codeTransactionState | @auth0/nextjs-auth0 - v4.9.0 Interface TransactionState
interface TransactionState {
codeVerifier: string;
maxAge?: number;
nonce: string;
responseType: string;
returnTo: string;
state: string;
[propName: string]: unknown;
}Hierarchy
- JWTPayload
- TransactionState
Indexable
- [propName: string]: unknown
Any other JWT Claim Set member.
+
Index
Properties
TransactionStoreOptions | @auth0/nextjs-auth0 - v4.8.0 Interface TransactionStoreOptions
Index
Properties
cookieTransactionStoreOptions | @auth0/nextjs-auth0 - v4.9.0 Interface TransactionStoreOptions
interface TransactionStoreOptions {
cookieOptions?: TransactionCookieOptions;
enableParallelTransactions?: boolean;
secret: string;
}Index
Properties
Properties
Optionalcookie
Optionalenable
enableParallelTransactions?: booleanControls whether multiple parallel login transactions are allowed.
+When false, only one transaction cookie is maintained at a time.
+When true (default), multiple transaction cookies can coexist for multi-tab support.
+secret
secret: stringUser | @auth0/nextjs-auth0 - v4.8.0 Interface User
interface User {
email?: string;
email_verified?: boolean;
family_name?: string;
given_name?: string;
name?: string;
nickname?: string;
org_id?: string;
picture?: string;
sub: string;
[key: string]: any;
}Indexable
- [key: string]: any
Index
Properties
email?
+User | @auth0/nextjs-auth0 - v4.9.0 Interface User
interface User {
email?: string;
email_verified?: boolean;
family_name?: string;
given_name?: string;
name?: string;
nickname?: string;
org_id?: string;
picture?: string;
sub: string;
[key: string]: any;
}Indexable
- [key: string]: any
Index
Properties
@auth0/nextjs-auth0 - v4.8.0 @auth0/nextjs-auth0 - v4.9.0 client | @auth0/nextjs-auth0 - v4.8.0 Module client
Interfaces
Type Aliases
Variables
Functions
+client | @auth0/nextjs-auth0 - v4.9.0 Module client
Interfaces
Type Aliases
Variables
Functions
diff --git a/docs/modules/errors.html b/docs/modules/errors.html
index e945fe215..84f76cc92 100644
--- a/docs/modules/errors.html
+++ b/docs/modules/errors.html
@@ -1 +1 @@
-errors | @auth0/nextjs-auth0 - v4.8.0 errors | @auth0/nextjs-auth0 - v4.9.0 server | @auth0/nextjs-auth0 - v4.8.0 Module server
Variables
Functions
+server | @auth0/nextjs-auth0 - v4.9.0 Module server
Type Aliases
Variables
Functions
diff --git a/docs/modules/testing.html b/docs/modules/testing.html
index f7723ae53..bdf20a711 100644
--- a/docs/modules/testing.html
+++ b/docs/modules/testing.html
@@ -1 +1 @@
-testing | @auth0/nextjs-auth0 - v4.8.0 testing | @auth0/nextjs-auth0 - v4.9.0 types | @auth0/nextjs-auth0 - v4.8.0 Module types
Interfaces
- AccessTokenForConnectionOptions
- Auth0ClientOptions
- AuthClientOptions
- AuthorizationParameters
- ConnectionTokenSet
- CookieOptions
- Routes
- SessionConfiguration
- SessionCookieOptions
- SessionData
- SessionDataStore
- SessionStoreOptions
- StartInteractiveLoginOptions
- TokenSet
- TransactionCookieOptions
- TransactionState
- TransactionStoreOptions
- User
+types | @auth0/nextjs-auth0 - v4.9.0 Module types
Interfaces
- AccessTokenForConnectionOptions
- Auth0ClientOptions
- AuthClientOptions
- AuthorizationParameters
- ConnectionTokenSet
- CookieOptions
- Routes
- SessionConfiguration
- SessionCookieOptions
- SessionData
- SessionDataStore
- SessionStoreOptions
- StartInteractiveLoginOptions
- TokenSet
- TransactionCookieOptions
- TransactionState
- TransactionStoreOptions
- User
diff --git a/docs/types/client.WithPageAuthRequired.html b/docs/types/client.WithPageAuthRequired.html
index c78492370..963d15af0 100644
--- a/docs/types/client.WithPageAuthRequired.html
+++ b/docs/types/client.WithPageAuthRequired.html
@@ -1,6 +1,6 @@
-WithPageAuthRequired | @auth0/nextjs-auth0 - v4.8.0 Type Alias WithPageAuthRequired
WithPageAuthRequired: <P extends object>(
Component: ComponentType<P & UserProps>,
options?: WithPageAuthRequiredOptions,
) => React.FC<P>const MyProtectedPage = withPageAuthRequired(MyPage);
+WithPageAuthRequired | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequired
WithPageAuthRequired: <P extends object>(
Component: ComponentType<P & UserProps>,
options?: WithPageAuthRequiredOptions,
) => React.FC<P>const MyProtectedPage = withPageAuthRequired(MyPage);
When you wrap your pages in this higher order component and an anonymous user visits your page,
they will be redirected to the login page and then returned to the page they were redirected from (after login).
-Type declaration
- <P extends object>(
Component: ComponentType<P & UserProps>,
options?: WithPageAuthRequiredOptions,
): React.FC<P> Type Parameters
- P extends object
Parameters
- Component: ComponentType<P & UserProps>
Optionaloptions: WithPageAuthRequiredOptions
Returns React.FC<P>
+
Type declaration
- <P extends object>(
Component: ComponentType<P & UserProps>,
options?: WithPageAuthRequiredOptions,
): React.FC<P> Type Parameters
- P extends object
Parameters
- Component: ComponentType<P & UserProps>
Optionaloptions: WithPageAuthRequiredOptions
Returns React.FC<P>
diff --git a/docs/types/server.AppRouterPageRoute.html b/docs/types/server.AppRouterPageRoute.html
new file mode 100644
index 000000000..adfdf26ab
--- /dev/null
+++ b/docs/types/server.AppRouterPageRoute.html
@@ -0,0 +1,2 @@
+AppRouterPageRoute | @auth0/nextjs-auth0 - v4.9.0 Type Alias AppRouterPageRoute
An app route that has been augmented with WithPageAuthRequired.
+Type declaration
- (obj: AppRouterPageRouteOpts): Promise<React.JSX.Element>
Parameters
Returns Promise<React.JSX.Element>
diff --git a/docs/types/server.AppRouterPageRouteOpts.html b/docs/types/server.AppRouterPageRouteOpts.html
new file mode 100644
index 000000000..ba5f897f2
--- /dev/null
+++ b/docs/types/server.AppRouterPageRouteOpts.html
@@ -0,0 +1,4 @@
+AppRouterPageRouteOpts | @auth0/nextjs-auth0 - v4.9.0 Type Alias AppRouterPageRouteOpts
Objects containing the route parameters and search parameters of the page.
+
params?: Promise<Record<string, string | string[]>>;
searchParams?: Promise<{ [key: string]: undefined | string | string[] }>;
}Index
Properties
GetServerSidePropsResultWithSession | @auth0/nextjs-auth0 - v4.9.0 Type Alias GetServerSidePropsResultWithSession<P>
If you wrap your getServerSideProps with WithPageAuthRequired your props object will be augmented with
+the user property, which will be the User object.
+// pages/profile.js
import { auth0 } from "@/lib/auth0";
export default function Profile({ user }) {
return <div>Hello {user.name}</div>;
}
export const getServerSideProps = auth0.withPageAuthRequired();
+
+
+Type Parameters
- P = any
PageRoute | @auth0/nextjs-auth0 - v4.9.0 Type Alias PageRoute<P, Q>
A page route that has been augmented with WithPageAuthRequired.
+Type Parameters
- P
- Q extends ParsedUrlQuery = ParsedUrlQuery
Type declaration
- (
ctx: GetServerSidePropsContext<Q>,
): Promise<GetServerSidePropsResultWithSession<P>> Parameters
- ctx: GetServerSidePropsContext<Q>
Returns Promise<GetServerSidePropsResultWithSession<P>>
diff --git a/docs/types/server.WithPageAuthRequired.html b/docs/types/server.WithPageAuthRequired.html
new file mode 100644
index 000000000..145e08b5c
--- /dev/null
+++ b/docs/types/server.WithPageAuthRequired.html
@@ -0,0 +1,3 @@
+WithPageAuthRequired | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequired
Protects Page router pages WithPageAuthRequiredPageRouter or
+App router pages WithPageAuthRequiredAppRouter
+
diff --git a/docs/types/server.WithPageAuthRequiredAppRouter.html b/docs/types/server.WithPageAuthRequiredAppRouter.html
new file mode 100644
index 000000000..9d22e2a39
--- /dev/null
+++ b/docs/types/server.WithPageAuthRequiredAppRouter.html
@@ -0,0 +1,17 @@
+WithPageAuthRequiredAppRouter | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequiredAppRouter
WithPageAuthRequiredAppRouter: (
fn: AppRouterPageRoute,
opts?: WithPageAuthRequiredAppRouterOptions,
) => AppRouterPageRouteWrap your Server Component with this method to make sure the user is authenticated before
+visiting the page.
+// app/protected-page/page.js
import { auth0 } from "@/lib/auth0";
const ProtectedPage = auth0.withPageAuthRequired(async function ProtectedPage() {
return <div>Protected content</div>;
}, { returnTo: '/protected-page' });
export default ProtectedPage;
+
+
+If the user visits /protected-page without a valid session, it will redirect the user to the
+login page.
+Note: Server Components are not aware of the req or the url of the page. So if you want the user to return to the
+page after login, you must specify the returnTo option.
+You can specify a function to returnTo that accepts the params (A Promise that resolves to
+an object containing the dynamic route parameters) and searchParams (A Promise that resolves to an
+object containing the search parameters of the current URL)
+argument from the page, to preserve dynamic routes and search params.
+// app/protected-page/[slug]/page.js
import { AppRouterPageRouteOpts } from '@auth0/nextjs-auth0/server';
import { auth0 } from "@/lib/auth0";
const ProtectedPage = auth0.withPageAuthRequired(async function ProtectedPage({
params, searchParams
}: AppRouterPageRouteOpts) {
const slug = (await params)?.slug as string;
return <div>Protected content for {slug}</div>;
}, {
returnTo({ params }) {
return `/protected-page/${(await params)?.slug}`;
}
});
export default ProtectedPage;
+
+
+Type declaration
- (
fn: AppRouterPageRoute,
opts?: WithPageAuthRequiredAppRouterOptions,
): AppRouterPageRoute Parameters
- fn: AppRouterPageRoute
Optionalopts: WithPageAuthRequiredAppRouterOptions
Returns AppRouterPageRoute
diff --git a/docs/types/server.WithPageAuthRequiredAppRouterOptions.html b/docs/types/server.WithPageAuthRequiredAppRouterOptions.html
new file mode 100644
index 000000000..6e56fa0bb
--- /dev/null
+++ b/docs/types/server.WithPageAuthRequiredAppRouterOptions.html
@@ -0,0 +1,4 @@
+WithPageAuthRequiredAppRouterOptions | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequiredAppRouterOptions
Specify the URL to returnTo - this is important in app router pages because the server component
+won't know the URL of the page.
+
returnTo?:
| string
| ((obj: AppRouterPageRouteOpts) => Promise<string> | string);
}Index
Properties
WithPageAuthRequiredPageRouter | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequiredPageRouter
WithPageAuthRequiredPageRouter: <
P extends { [key: string]: any } = { [key: string]: any },
Q extends ParsedUrlQuery = ParsedUrlQuery,
>(
opts?: WithPageAuthRequiredPageRouterOptions<P, Q>,
) => PageRoute<P, Q>Wrap your getServerSideProps with this method to make sure the user is authenticated before
+visiting the page.
+// pages/protected-page.js
import { auth0 } from "@/lib/auth0";
export default function ProtectedPage() {
return <div>Protected content</div>;
}
export const getServerSideProps = auth0.withPageAuthRequired();
+
+
+If the user visits /protected-page without a valid session, it will redirect the user to the
+login page. Then they will be returned to /protected-page after login.
+Type declaration
- <
P extends { [key: string]: any } = { [key: string]: any },
Q extends ParsedUrlQuery = ParsedUrlQuery,
>(
opts?: WithPageAuthRequiredPageRouterOptions<P, Q>,
): PageRoute<P, Q> Type Parameters
- P extends { [key: string]: any } = { [key: string]: any }
- Q extends ParsedUrlQuery = ParsedUrlQuery
Parameters
Optionalopts: WithPageAuthRequiredPageRouterOptions<P, Q>
Returns PageRoute<P, Q>
diff --git a/docs/types/server.WithPageAuthRequiredPageRouterOptions.html b/docs/types/server.WithPageAuthRequiredPageRouterOptions.html
new file mode 100644
index 000000000..ca50a0936
--- /dev/null
+++ b/docs/types/server.WithPageAuthRequiredPageRouterOptions.html
@@ -0,0 +1,10 @@
+WithPageAuthRequiredPageRouterOptions | @auth0/nextjs-auth0 - v4.9.0 Type Alias WithPageAuthRequiredPageRouterOptions<P, Q>
If you have a custom returnTo url you should specify it in returnTo.
+You can pass in your own getServerSideProps method, the props returned from this will be
+merged with the user props. You can also access the user session data by calling getSession
+inside of this method. For example:
+// pages/protected-page.js
import { auth0 } from "@/lib/auth0";
export default function ProtectedPage({ user, customProp }) {
return <div>Protected content</div>;
}
export const getServerSideProps = auth0.withPageAuthRequired({
// returnTo: '/unauthorized',
async getServerSideProps(ctx) {
// access the user session if needed
// const session = await auth0.getSession(ctx.req);
return {
props: {
// customProp: 'bar',
}
};
}
});
+
+
+
P extends { [key: string]: any } = { [key: string]: any },
Q extends ParsedUrlQuery = ParsedUrlQuery,
> = {
getServerSideProps?: GetServerSideProps<P, Q>;
returnTo?: string;
}Type Parameters
- P extends { [key: string]: any } = { [key: string]: any }
- Q extends ParsedUrlQuery = ParsedUrlQuery
Index
Properties
GenerateSessionCookieConfig | @auth0/nextjs-auth0 - v4.8.0 Type Alias GenerateSessionCookieConfig
Index
Properties
BeforeSessionSavedHook | @auth0/nextjs-auth0 - v4.8.0 Type Alias BeforeSessionSavedHook
Type declaration
- (session: SessionData, idToken: string | null): Promise<SessionData>
Parameters
- session: SessionData
- idToken: string | null
Returns Promise<SessionData>
+BeforeSessionSavedHook | @auth0/nextjs-auth0 - v4.9.0 Type Alias BeforeSessionSavedHook
Type declaration
- (session: SessionData, idToken: string | null): Promise<SessionData>
Parameters
- session: SessionData
- idToken: string | null
Returns Promise<SessionData>
diff --git a/docs/types/types.LogoutStrategy.html b/docs/types/types.LogoutStrategy.html
index 75b863775..2f0882b9b 100644
--- a/docs/types/types.LogoutStrategy.html
+++ b/docs/types/types.LogoutStrategy.html
@@ -1,2 +1,2 @@
-LogoutStrategy | @auth0/nextjs-auth0 - v4.8.0 Type Alias LogoutStrategy
LogoutStrategy: "auto" | "oidc" | "v2"Logout strategy options for controlling logout endpoint selection.
-
+LogoutStrategy | @auth0/nextjs-auth0 - v4.9.0 Type Alias LogoutStrategy
LogoutStrategy: "auto" | "oidc" | "v2"Logout strategy options for controlling logout endpoint selection.
+
diff --git a/docs/types/types.LogoutToken.html b/docs/types/types.LogoutToken.html
index ba9bf450e..4a499369a 100644
--- a/docs/types/types.LogoutToken.html
+++ b/docs/types/types.LogoutToken.html
@@ -1,3 +1,3 @@
-LogoutToken | @auth0/nextjs-auth0 - v4.8.0 Type Alias LogoutToken
OnCallbackContext | @auth0/nextjs-auth0 - v4.8.0 OnCallbackContext | @auth0/nextjs-auth0 - v4.9.0 OnCallbackHook | @auth0/nextjs-auth0 - v4.8.0 Type Alias OnCallbackHook
OnCallbackHook: (
error: SdkError | null,
ctx: OnCallbackContext,
session: SessionData | null,
) => Promise<NextResponse>Type declaration
- (
error: SdkError | null,
ctx: OnCallbackContext,
session: SessionData | null,
): Promise<NextResponse> Parameters
- error: SdkError | null
- ctx: OnCallbackContext
- session: SessionData | null
Returns Promise<NextResponse>
+OnCallbackHook | @auth0/nextjs-auth0 - v4.9.0 Type Alias OnCallbackHook
OnCallbackHook: (
error: SdkError | null,
ctx: OnCallbackContext,
session: SessionData | null,
) => Promise<NextResponse>Type declaration
- (
error: SdkError | null,
ctx: OnCallbackContext,
session: SessionData | null,
): Promise<NextResponse> Parameters
- error: SdkError | null
- ctx: OnCallbackContext
- session: SessionData | null
Returns Promise<NextResponse>
diff --git a/docs/types/types.PagesRouterRequest.html b/docs/types/types.PagesRouterRequest.html
index b19e08f29..a36bbceac 100644
--- a/docs/types/types.PagesRouterRequest.html
+++ b/docs/types/types.PagesRouterRequest.html
@@ -1 +1 @@
-PagesRouterRequest | @auth0/nextjs-auth0 - v4.8.0 Type Alias PagesRouterRequest
PagesRouterRequest: IncomingMessage | NextApiRequest
+PagesRouterRequest | @auth0/nextjs-auth0 - v4.9.0 Type Alias PagesRouterRequest
PagesRouterRequest: IncomingMessage | NextApiRequest
diff --git a/docs/types/types.PagesRouterResponse.html b/docs/types/types.PagesRouterResponse.html
index b5780a729..f0ff82438 100644
--- a/docs/types/types.PagesRouterResponse.html
+++ b/docs/types/types.PagesRouterResponse.html
@@ -1 +1 @@
-PagesRouterResponse | @auth0/nextjs-auth0 - v4.8.0 Type Alias PagesRouterResponse
PagesRouterResponse: ServerResponse<IncomingMessage> | NextApiResponse
+PagesRouterResponse | @auth0/nextjs-auth0 - v4.9.0 Type Alias PagesRouterResponse
PagesRouterResponse: ServerResponse<IncomingMessage> | NextApiResponse
diff --git a/docs/types/types.ReadonlyRequestCookies.html b/docs/types/types.ReadonlyRequestCookies.html
index b3ce1cea0..e920fd124 100644
--- a/docs/types/types.ReadonlyRequestCookies.html
+++ b/docs/types/types.ReadonlyRequestCookies.html
@@ -1 +1 @@
-ReadonlyRequestCookies | @auth0/nextjs-auth0 - v4.8.0 Type Alias ReadonlyRequestCookies
ReadonlyRequestCookies: Omit<RequestCookies, "set" | "clear" | "delete"> & Pick<
ResponseCookies,
"set"
| "delete",
>
+ReadonlyRequestCookies | @auth0/nextjs-auth0 - v4.9.0 Type Alias ReadonlyRequestCookies
ReadonlyRequestCookies: Omit<RequestCookies, "set" | "clear" | "delete"> & Pick<
ResponseCookies,
"set"
| "delete",
>
diff --git a/docs/types/types.RoutesOptions.html b/docs/types/types.RoutesOptions.html
index a9c3226b3..e35f2e3ba 100644
--- a/docs/types/types.RoutesOptions.html
+++ b/docs/types/types.RoutesOptions.html
@@ -1 +1 @@
-RoutesOptions | @auth0/nextjs-auth0 - v4.8.0 Type Alias RoutesOptions
+RoutesOptions | @auth0/nextjs-auth0 - v4.9.0 Type Alias RoutesOptions
diff --git a/docs/variables/client.withPageAuthRequired.html b/docs/variables/client.withPageAuthRequired.html
index abb7be418..5dd0a608e 100644
--- a/docs/variables/client.withPageAuthRequired.html
+++ b/docs/variables/client.withPageAuthRequired.html
@@ -1 +1 @@
-withPageAuthRequired | @auth0/nextjs-auth0 - v4.8.0 Variable withPageAuthRequiredConst
+withPageAuthRequired | @auth0/nextjs-auth0 - v4.9.0 Variable withPageAuthRequiredConst
diff --git a/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html b/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html
index 22aa5d30d..afc49fb66 100644
--- a/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html
+++ b/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html
@@ -1,2 +1,2 @@
-DEFAULT_ID_TOKEN_CLAIMS | @auth0/nextjs-auth0 - v4.8.0 Variable DEFAULT_ID_TOKEN_CLAIMSConst
DEFAULT_ID_TOKEN_CLAIMS: string[] = ...Default claims for the ID token.
-
+DEFAULT_ID_TOKEN_CLAIMS | @auth0/nextjs-auth0 - v4.9.0 Variable DEFAULT_ID_TOKEN_CLAIMSConst
DEFAULT_ID_TOKEN_CLAIMS: string[] = ...Default claims for the ID token.
+
diff --git a/package.json b/package.json
index 227a3f231..bcb5ae0c0 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "@auth0/nextjs-auth0",
- "version": "4.8.0",
+ "version": "4.9.0",
"description": "Auth0 Next.js SDK",
"type": "module",
"scripts": {
Error class representing an access token for connection error. +
Class AccessTokenForConnectionError
Error class representing an access token for connection error. Extends the
-SdkErrorclass.Hierarchy (View Summary)
Index
Constructors
Hierarchy (View Summary)
Index
Constructors
Properties
Constructors
constructor
code: string,
message: string,
cause?: OAuth2Error,
): AccessTokenForConnectionError
Constructs a new
AccessTokenForConnectionErrorinstance.Parameters
The error code.
The error message.
Optionalcause: OAuth2ErrorThe OAuth2 cause of the error.
-Returns AccessTokenForConnectionError
Properties
Optionalcausecode
The error code associated with the access token error.
-Settings
On This Page
Constructors
Properties
Returns AccessTokenForConnectionError