Class Auth0Client

Index

Constructors

Methods

connectAccount createFetcher getAccessToken getAccessTokenForConnection getSession getTokenByBackchannelAuth middleware startInteractiveLogin updateSession withApiAuthRequired withPageAuthRequired

Constructors

constructor

new Auth0Client(options?: Auth0ClientOptions): Auth0Client
Parameters
- options: Auth0ClientOptions = {}
Returns Auth0Client
- Defined in src/server/client.ts:372

Methods

connectAccount

connectAccount(options: ConnectAccountOptions): Promise<NextResponse<unknown>>
Initiates the Connect Account flow to connect a third-party account to the user's profile. If the user does not have an active session, a ConnectAccountError is thrown.

This method first attempts to obtain an access token with the create:me:connected_accounts scope for the My Account API to create a connected account for the user.

The user will then be redirected to authorize the connection with the third-party provider.
Parameters
- options: ConnectAccountOptions
Returns Promise<NextResponse<unknown>>
- Defined in src/server/client.ts:1011

createFetcher

createFetcher<TOutput extends Response = Response>(
    req: undefined | NextRequest | PagesRouterRequest,
    options: {
        baseUrl?: string;
        fetch?: CustomFetchImpl<TOutput>;
        getAccessToken?: AccessTokenFactory;
        useDPoP?: boolean;
    },
): Promise<Fetcher<TOutput>>
Creates a configured Fetcher instance for making authenticated API requests.

This method creates a specialized HTTP client that handles:
- Automatic access token retrieval and injection
- DPoP (Demonstrating Proof-of-Possession) proof generation when enabled
- Token refresh and session management
- Error handling and retry logic for DPoP nonce errors
- Base URL resolution for relative requests
The fetcher provides a high-level interface for making requests to protected resources without manually handling authentication details.
Type Parameters
- TOutput extends Response = Response
  Response type that extends the standard Response interface
Parameters
- req: undefined | NextRequest | PagesRouterRequest
  Request object for session context (required for Pages Router, optional for App Router)
- options: {
      baseUrl?: string;
      fetch?: CustomFetchImpl<TOutput>;
      getAccessToken?: AccessTokenFactory;
      useDPoP?: boolean;
  }
  Configuration options for the fetcher
  - OptionalbaseUrl?: string
    Base URL for relative requests. Must be provided if using relative URLs
  - Optionalfetch?: CustomFetchImpl<TOutput>
    Custom fetch implementation. Falls back to global fetch if not provided
  - OptionalgetAccessToken?: AccessTokenFactory
    Custom access token factory function. If not provided, uses the default from hooks
  - OptionaluseDPoP?: boolean
    Enable DPoP for this fetcher instance (overrides global setting)
Returns Promise<Fetcher<TOutput>>
Promise that resolves to a configured Fetcher instance
Throws
AccessTokenError when no active session exists
Example
```
import { auth0 } from "@/lib/auth0";

const fetcher = await auth0.createFetcher(undefined, {
  baseUrl: "https://api.example.com",
  useDPoP: true
});

const response = await fetcher.fetchWithAuth("/users");
const users = await response.json();
```
See
- Fetcher for details on using the returned fetcher instance
- FetcherMinimalConfig for available configuration options
- Defined in src/server/client.ts:1245

getAccessToken

getAccessToken(
    options?: GetAccessTokenOptions,
): Promise<
    {
        audience?: string;
        expiresAt: number;
        scope?: string;
        token: string;
        token_type?: string;
    },
>
Parameters
- Optionaloptions: GetAccessTokenOptions
  Optional configuration for getting the access token.
  - Optionalaudience?: string | null
    Please note: If you are passing audience, ensure that the used audiences and scopes are part of the Application's Refresh Token Policies in Auth0 when configuring Multi-Resource Refresh Tokens (MRRT). Auth0 Documentation on Multi-resource Refresh Tokens
  - Optionalrefresh?: boolean | null
  - Optionalscope?: string | null
Returns Promise<
    {
        audience?: string;
        expiresAt: number;
        scope?: string;
        token: string;
        token_type?: string;
    },
>
- Defined in src/server/client.ts:557
getAccessToken(
    req: NextRequest | PagesRouterRequest,
    res: NextResponse<unknown> | PagesRouterResponse,
    options?: GetAccessTokenOptions,
): Promise<
    {
        audience?: string;
        expiresAt: number;
        scope?: string;
        token: string;
        token_type?: string;
    },
>
getAccessToken returns the access token.

This method can be used in middleware and getServerSideProps, API routes in the Pages Router.
Parameters
- req: NextRequest | PagesRouterRequest
  The request object.
- res: NextResponse<unknown> | PagesRouterResponse
  The response object.
- Optionaloptions: GetAccessTokenOptions
  Optional configuration for getting the access token.
  - Optionalaudience?: string | null
    Please note: If you are passing audience, ensure that the used audiences and scopes are part of the Application's Refresh Token Policies in Auth0 when configuring Multi-Resource Refresh Tokens (MRRT). Auth0 Documentation on Multi-resource Refresh Tokens
  - Optionalrefresh?: boolean | null
  - Optionalscope?: string | null
Returns Promise<
    {
        audience?: string;
        expiresAt: number;
        scope?: string;
        token: string;
        token_type?: string;
    },
>
- Defined in src/server/client.ts:575

getAccessTokenForConnection

getAccessTokenForConnection(
options: AccessTokenForConnectionOptions,
): Promise<{ expiresAt: number; token: string }>
Retrieves an access token for a connection.

This method can be used in Server Components, Server Actions, and Route Handlers in the App Router.

NOTE: Server Components cannot set cookies. Calling getAccessTokenForConnection() in a Server Component will cause the access token to be refreshed, if it is expired, and the updated token set will not to be persisted. It is recommended to call getAccessTokenForConnection(req, res) in the middleware if you need to retrieve the access token in a Server Component to ensure the updated token set is persisted.
Parameters
- options: AccessTokenForConnectionOptions
Returns Promise<{ expiresAt: number; token: string }>
- Defined in src/server/client.ts:737
getAccessTokenForConnection(
    options: AccessTokenForConnectionOptions,
    req: undefined | NextRequest | PagesRouterRequest,
    res: undefined | NextResponse<unknown> | PagesRouterResponse,
): Promise<{ expiresAt: number; token: string }>
Retrieves an access token for a connection.

This method can be used in middleware and getServerSideProps, API routes in the Pages Router.
Parameters
- options: AccessTokenForConnectionOptions
- req: undefined | NextRequest | PagesRouterRequest
- res: undefined | NextResponse<unknown> | PagesRouterResponse
Returns Promise<{ expiresAt: number; token: string }>
- Defined in src/server/client.ts:746

getSession

getSession(): Promise<null | SessionData>
getSession returns the session data for the current request.

This method can be used in Server Components, Server Actions, and Route Handlers in the App Router.

Returns Promise<null | SessionData>
- Defined in src/server/client.ts:514
getSession(req: NextRequest | PagesRouterRequest): Promise<null | SessionData>
getSession returns the session data for the current request.

This method can be used in middleware and getServerSideProps, API routes in the Pages Router.
Parameters
- req: NextRequest | PagesRouterRequest
Returns Promise<null | SessionData>
- Defined in src/server/client.ts:521

getTokenByBackchannelAuth

getTokenByBackchannelAuth(
options: BackchannelAuthenticationOptions,
): Promise<BackchannelAuthenticationResponse>
Authenticates using Client-Initiated Backchannel Authentication and returns the token set and optionally the ID token claims and authorization details.

This method will initialize the backchannel authentication process with Auth0, and poll the token endpoint until the authentication is complete.

Using Client-Initiated Backchannel Authentication requires the feature to be enabled in the Auth0 dashboard.
Parameters
- options: BackchannelAuthenticationOptions
Returns Promise<BackchannelAuthenticationResponse>
See
https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-initiated-backchannel-authentication-flow
- Defined in src/server/client.ts:991

middleware

middleware(req: NextRequest): Promise<NextResponse<unknown>>
middleware mounts the SDK routes to run as a middleware function.
Parameters
- req: NextRequest
Returns Promise<NextResponse<unknown>>
- Defined in src/server/client.ts:505

startInteractiveLogin

startInteractiveLogin(
options?: StartInteractiveLoginOptions,
): Promise<NextResponse<unknown>>
Parameters
- options: StartInteractiveLoginOptions = {}
Returns Promise<NextResponse<unknown>>
- Defined in src/server/client.ts:977

updateSession

updateSession(
    req: NextRequest | PagesRouterRequest,
    res: NextResponse<unknown> | PagesRouterResponse,
    session: SessionData,
): Promise<void>
updateSession updates the session of the currently authenticated user. If the user does not have a session, an error is thrown.

This method can be used in middleware and getServerSideProps, API routes, and middleware in the Pages Router.
Parameters
- req: NextRequest | PagesRouterRequest
- res: NextResponse<unknown> | PagesRouterResponse
- session: SessionData
Returns Promise<void>
- Defined in src/server/client.ts:848
updateSession(session: SessionData): Promise<void>
updateSession updates the session of the currently authenticated user. If the user does not have a session, an error is thrown.

This method can be used in Server Actions and Route Handlers in the App Router.
Parameters
- session: SessionData
Returns Promise<void>
- Defined in src/server/client.ts:859

withApiAuthRequired

withApiAuthRequired(
    apiRoute: AppRouteHandlerFn | NextApiHandler,
): (
    req: NextApiRequest | NextRequest,
    resOrParams: AppRouteHandlerFnContext | NextApiResponse,
) => unknown
Parameters
- apiRoute: AppRouteHandlerFn | NextApiHandler
Returns (
req: NextApiRequest | NextRequest,
resOrParams: AppRouteHandlerFnContext | NextApiResponse,
) => unknown
- Defined in src/server/client.ts:1063

withPageAuthRequired

withPageAuthRequired(
fnOrOpts?: AppRouterPageRoute | WithPageAuthRequiredPageRouterOptions,
opts?: WithPageAuthRequiredAppRouterOptions,
): AppRouterPageRoute | PageRoute<{ [key: string]: any }, ParsedUrlQuery>
Parameters
- OptionalfnOrOpts: AppRouterPageRoute | WithPageAuthRequiredPageRouterOptions
- Optionalopts: WithPageAuthRequiredAppRouterOptions
Returns AppRouterPageRoute | PageRoute<{ [key: string]: any }, ParsedUrlQuery>
- Defined in src/server/client.ts:1046

Class Auth0Client

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Auth0Client

Methods

connectAccount

Parameters

Returns Promise<NextResponse<unknown>>

createFetcher

Type Parameters

Parameters

OptionalbaseUrl?: string

Optionalfetch?: CustomFetchImpl<TOutput>

OptionalgetAccessToken?: AccessTokenFactory

OptionaluseDPoP?: boolean

Returns Promise<Fetcher<TOutput>>

Throws

Example

See

getAccessToken

Parameters

Optionalaudience?: string | null

Optionalrefresh?: boolean | null

Optionalscope?: string | null

Returns Promise< { audience?: string; expiresAt: number; scope?: string; token: string; token_type?: string; },>

Parameters

Optionalaudience?: string | null

Optionalrefresh?: boolean | null

Optionalscope?: string | null

Returns Promise< { audience?: string; expiresAt: number; scope?: string; token: string; token_type?: string; },>

getAccessTokenForConnection

Parameters

Returns Promise<{ expiresAt: number; token: string }>

Parameters

Returns Promise<{ expiresAt: number; token: string }>

getSession

Returns Promise<null | SessionData>

Parameters

Returns Promise<null | SessionData>

getTokenByBackchannelAuth

Parameters

Returns Promise<BackchannelAuthenticationResponse>

See

middleware

Parameters

Returns Promise<NextResponse<unknown>>

startInteractiveLogin

Parameters

Returns Promise<NextResponse<unknown>>

updateSession

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

withApiAuthRequired

Parameters

Returns ( req: NextApiRequest | NextRequest, resOrParams: AppRouteHandlerFnContext | NextApiResponse,) => unknown

withPageAuthRequired

Parameters

Returns AppRouterPageRoute | PageRoute<{ [key: string]: any }, ParsedUrlQuery>

Settings

On This Page

`Optional`baseUrl?: string

`Optional`fetch?: CustomFetchImpl<TOutput>

`Optional`getAccessToken?: AccessTokenFactory

`Optional`useDPoP?: boolean

`Optional`audience?: string | null

`Optional`refresh?: boolean | null

`Optional`scope?: string | null

Returns Promise<
{
audience?: string;
expiresAt: number;
scope?: string;
token: string;
token_type?: string;
},
>

`Optional`audience?: string | null

`Optional`refresh?: boolean | null

`Optional`scope?: string | null

Returns Promise<
{
audience?: string;
expiresAt: number;
scope?: string;
token: string;
token_type?: string;
},
>

Returns (
req: NextApiRequest | NextRequest,
resOrParams: AppRouteHandlerFnContext | NextApiResponse,
) => unknown