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 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.5.1
@auth0/nextjs-auth0 - v4.6.0
The Auth0 Next.js SDK is a library for implementing user authentication in Next.js applications.
@@ -37,14 +37,14 @@
4. Add the authentication middleware
Create a middleware.ts file in the root of your project's directory:
import type { NextRequest } from "next/server"
import { auth0 } from "./lib/auth0"
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).*)",
],
}
+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).*)",
],
}
Note
If you're using a src/ directory, the middleware.ts file must be created inside the src/ directory.
You can now begin to authenticate your users by redirecting them to your application's /auth/login route:
-import { auth0 } from "@/lib/auth0"
export default async function Home() {
const session = await auth0.getSession()
if (!session) {
return (
<main>
<a href="/auth/login?screen_hint=signup">Sign up</a>
<a href="/auth/login">Log in</a>
</main>
)
}
return (
<main>
<h1>Welcome, {session.user.name}!</h1>
</main>
)
}
+import { auth0 } from "./lib/auth0" // Adjust path if your auth0 client is elsewhere
export default async function Home() {
const session = await auth0.getSession()
if (!session) {
return (
<main>
<a href="/auth/login?screen_hint=signup">Sign up</a>
<a href="/auth/login">Log in</a>
</main>
)
}
return (
<main>
<h1>Welcome, {session.user.name}!</h1>
</main>
)
}
Important
@@ -207,4 +207,4 @@
This project is licensed under the MIT license. See the LICENSE file for more info.
-
Interface AccessTokenForConnectionOptions
Options for retrieving a connection access token.
- Index
Properties
Interface AccessTokenForConnectionOptions
Options for retrieving a connection access token.
+ Index
Properties
Optionallogin_
An optional login hint to pass to the authorization server.
+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;
onCallback?: OnCallbackHook;
pushedAuthorizationRequests?: boolean;
routes?: Partial<
Pick<Routes, "login" | "callback" | "logout" | "backChannelLogout">,
>;
secret?: string;
session?: SessionConfiguration;
sessionStore?: SessionDataStore;
signInReturnToPath?: string;
transactionCookie?: TransactionCookieOptions;
}
Index
Properties
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;
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
Allow 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
The URL of your application (e.g.: http://localhost:3000).
Optionalapp
The 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
The algorithm used to sign the client assertion JWT. +
Optionalclient
The 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
Private key for use with private_key_jwt clients.
+
Optionalclient
Private 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
The Auth0 client ID.
+Optionalclient
The Auth0 client ID.
If it's not specified, it will be loaded from the AUTH0_CLIENT_ID environment variable.
Optionalclient
The Auth0 client secret.
+Optionalclient
The Auth0 client secret.
If it's not specified, it will be loaded from the AUTH0_CLIENT_SECRET environment variable.
Optionaldomain
The Auth0 domain for the tenant (e.g.: example.us.auth0.com).
Optionaldomain
The 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
Boolean value to enable the /auth/access-token endpoint for use in the client app.
Optionalenable
Boolean 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
Boolean value to opt-out of sending the library name and version to your authorization server +
Optionalenable
Boolean value to opt-out of sending the library name and version to your authorization server
via the Auth0-Client header. Defaults to true.
Optionalhttp
Integer value for the HTTP timeout in milliseconds for authentication requests. +
Optionalhttp
Integer value for the HTTP timeout in milliseconds for authentication requests.
Defaults to 5000 ms.
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
If 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
If 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
A 32-byte, hex-encoded secret used for encrypting cookies.
+Optionalsecret
A 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
The 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
The 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.
+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;
onCallback?: OnCallbackHook;
pushedAuthorizationRequests?: boolean;
routes?: Partial<
Pick<Routes, "login" | "callback" | "logout" | "backChannelLogout">,
>;
secret: string;
sessionStore: AbstractSessionStore;
signInReturnToPath?: string;
transactionStore: TransactionStore;
}
Index
Properties
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;
onCallback?: OnCallbackHook;
pushedAuthorizationRequests?: boolean;
routes?: Partial<
Pick<Routes, "login" | "callback" | "logout" | "backChannelLogout">,
>;
secret: string;
sessionStore: AbstractSessionStore;
signInReturnToPath?: string;
transactionStore: TransactionStore;
}
Index
Properties
Properties
Optionalallow
app
Optionalauthorization
Optionalbefore
Optionalclient
Optionalclient
client
Optionalclient
domain
Optionalenable
Optionalenable
Optionalfetch
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | URL | Request, init?: RequestInit): Promise<Response>;
}
Type declaration
- (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
Properties
Optionalallow
app
Optionalauthorization
Optionalbefore
Optionalclient
Optionalclient
client
Optionalclient
domain
Optionalenable
Optionalenable
Optionalfetch
(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
Optionaljwks
Optionalon
Optionalpushed
Optionalroutes
secret
session
Optionalsign
transaction
Parameters
- input: string | URL | Request
Optionalinit: RequestInit
Returns Promise<Response>
Optionalhttp
Optionaljwks
Optionalon
Optionalpushed
Optionalroutes
secret
session
Optionalsign
transaction
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
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
The unique identifier of the target API you want to access.
-Optionalmax_
The maximum amount of time, in seconds, after which a user must reauthenticate.
-Optionalredirect_
The URL to which the authorization server will redirect the user after granting authorization.
-Optionalscope
The scope of the access request, expressed as a list of space-delimited, case-sensitive strings. +
Optionalmax_
The maximum amount of time, in seconds, after which a user must reauthenticate.
+Optionalredirect_
The URL to which the authorization server will redirect the user after granting authorization.
+Optionalscope
The scope of the access request, expressed as a list of space-delimited, case-sensitive strings.
Defaults to "openid profile email offline_access".
Interface ConnectionTokenSet
accessToken: string;
connection: string;
expiresAt: number;
scope?: string;
[key: string]: unknown;
}
Indexable
- [key: string]: unknown
Index
Properties
Interface ConnectionTokenSet
accessToken: string;
connection: string;
expiresAt: number;
scope?: string;
[key: string]: unknown;
}
Indexable
- [key: string]: unknown
Index
Properties
Interface CookieOptions
domain?: string;
httpOnly: boolean;
maxAge?: number;
path: string;
sameSite: "lax" | "strict" | "none";
secure: boolean;
transient?: boolean;
}
Interface Routes
accessToken: string;
backChannelLogout: string;
callback: string;
login: string;
logout: string;
profile: string;
}
Index
Properties
Interface Routes
accessToken: string;
backChannelLogout: string;
callback: string;
login: string;
logout: string;
profile: string;
}
Index
Properties
Interface SessionConfiguration
absoluteDuration?: number;
cookie?: SessionCookieOptions;
inactivityDuration?: number;
rolling?: boolean;
}
Hierarchy (View Summary)
- SessionConfiguration
Index
Properties
Interface SessionConfiguration
absoluteDuration?: number;
cookie?: SessionCookieOptions;
inactivityDuration?: number;
rolling?: boolean;
}
Hierarchy (View Summary)
- SessionConfiguration
Index
Properties
Properties
Optionalabsolute
The 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
The duration of inactivity after which the session will expire. The value must be specified in seconds.
+Optionalcookie
The options for the session cookie.
+Optionalinactivity
The 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
A boolean indicating whether rolling sessions should be used or not.
+Optionalrolling
A 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.
Interface SessionCookieOptions
domain?: string;
name?: string;
path?: string;
sameSite?: "lax" | "strict" | "none";
secure?: boolean;
transient?: boolean;
}
Index
Properties
Interface SessionCookieOptions
domain?: string;
name?: string;
path?: string;
sameSite?: "lax" | "strict" | "none";
secure?: boolean;
transient?: boolean;
}
Properties
Optionaldomain
Specifies 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
The name of the session cookie.
+Optionalname
The name of the session cookie.
Default: __session.
Optionalpath
The path attribute of the session cookie. Will be set to '/' by default.
-Optionalsame
The sameSite attribute of the session cookie.
+Optionalpath
The path attribute of the session cookie. Will be set to '/' by default.
+Optionalsame
The sameSite attribute of the session cookie.
Default: lax.
Optionalsecure
The secure attribute of the session cookie.
+Optionalsecure
The 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
The transient attribute of the session cookie. When true, the cookie will not persist beyond the current session.
-Optionaltransient
The transient attribute of the session cookie. When true, the cookie will not persist beyond the current session.
+Interface SessionData
connectionTokenSets?: ConnectionTokenSet[];
internal: { createdAt: number; sid: string };
tokenSet: TokenSet;
user: User;
[key: string]: unknown;
}
Indexable
- [key: string]: unknown
Index
Properties
Interface SessionData
connectionTokenSets?: ConnectionTokenSet[];
internal: { createdAt: number; sid: string };
tokenSet: TokenSet;
user: User;
[key: string]: unknown;
}
Indexable
- [key: string]: unknown
Index
Properties
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
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>
Interface SessionStoreOptions
absoluteDuration?: number;
cookie?: SessionCookieOptions;
cookieOptions?: SessionCookieOptions;
inactivityDuration?: number;
rolling?: boolean;
secret: string;
store?: SessionDataStore;
}
Hierarchy (View Summary)
- SessionConfiguration
- SessionStoreOptions
Index
Properties
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
The 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
The 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
The 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
A boolean indicating whether rolling sessions should be used or not.
+Optionalrolling
A 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
Optionalstore
secret
Optionalstore
Interface StartInteractiveLoginOptions
authorizationParameters?: AuthorizationParameters;
returnTo?: string;
}
Index
Properties
Interface StartInteractiveLoginOptions
authorizationParameters?: AuthorizationParameters;
returnTo?: string;
}
Index
Properties
Optionalreturn
The URL to redirect to after a successful login.
+Interface TokenSet
accessToken: string;
expiresAt: number;
idToken?: string;
refreshToken?: string;
scope?: string;
}
Index
Properties
Interface TokenSet
accessToken: string;
expiresAt: number;
idToken?: string;
refreshToken?: string;
scope?: string;
}
Index
Properties
Interface TransactionCookieOptions
path?: string;
prefix?: string;
sameSite?: "lax" | "strict" | "none";
secure?: boolean;
}
Index
Properties
Interface TransactionCookieOptions
path?: string;
prefix?: string;
sameSite?: "lax" | "strict" | "none";
secure?: boolean;
}
Properties
Optionalpath
The path attribute of the transaction cookie. Will be set to '/' by default.
-Optionalprefix
The prefix of the cookie used to store the transaction state.
+Optionalprefix
The prefix of the cookie used to store the transaction state.
Default: __txn_{state}.
Optionalsame
The sameSite attribute of the transaction cookie.
+Optionalsame
The sameSite attribute of the transaction cookie.
Default: lax.
Optionalsecure
The secure attribute of the transaction cookie.
+Optionalsecure
The 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.
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
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
Interface TransactionStoreOptions
Index
Properties
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
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
Module client
Functions
Module client
Functions
Module server
Module server
Module types
Interfaces
- AccessTokenForConnectionOptions
- Auth0ClientOptions
- AuthClientOptions
- AuthorizationParameters
- ConnectionTokenSet
- CookieOptions
- Routes
- SessionConfiguration
- SessionCookieOptions
- SessionData
- SessionDataStore
- SessionStoreOptions
- StartInteractiveLoginOptions
- TokenSet
- TransactionCookieOptions
- TransactionState
- TransactionStoreOptions
- User
Module types
Interfaces
- AccessTokenForConnectionOptions
- Auth0ClientOptions
- AuthClientOptions
- AuthorizationParameters
- ConnectionTokenSet
- CookieOptions
- Routes
- SessionConfiguration
- SessionCookieOptions
- SessionData
- SessionDataStore
- SessionStoreOptions
- StartInteractiveLoginOptions
- TokenSet
- TransactionCookieOptions
- TransactionState
- TransactionStoreOptions
- User
Type Alias GenerateSessionCookieConfig
Type declaration
Type Alias BeforeSessionSavedHook
Type declaration
- (session: SessionData, idToken: string | null): Promise<SessionData>
Parameters
- session: SessionData
- idToken: string | null
Returns Promise<SessionData>
Type Alias BeforeSessionSavedHook
Type declaration
- (session: SessionData, idToken: string | null): Promise<SessionData>
Parameters
- session: SessionData
- idToken: string | null
Returns Promise<SessionData>
Type Alias 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>
- (
Type Alias 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>
- (
Type Alias PagesRouterRequest
Type Alias PagesRouterRequest
Type Alias PagesRouterResponse
Type Alias PagesRouterResponse
Type Alias ReadonlyRequestCookies
ResponseCookies,
"set"
| "delete",
>
Type Alias ReadonlyRequestCookies
ResponseCookies,
"set"
| "delete",
>
Error class representing an access token for connection error. +
- Preparing search index...
- The search index is not available
@auth0/nextjs-auth0 - v4.6.0Class 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