@auth0/nextjs-auth0 - v4.8.0
    Preparing search index...

    Class AuthClient

    Index

    Constructors

    Methods

    • Filters and processes ID token claims for a session.

      If a beforeSessionSaved callback 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

      Returns Promise<SessionData>

    • 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 the request to the authorization server's token endpoint.

      Parameters

      Returns Promise<[AccessTokenForConnectionError, null] | [null, ConnectionTokenSet]>

      A promise that resolves to a tuple. The first element is either an AccessTokenForConnectionError if an error occurred, or null if the request was successful. The second element is either null if an error occurred, or a ConnectionTokenSet object containing the access token, expiration time, and scope if the request was successful.

      If the refresh token is missing or if there is an error during the token exchange process.

    • 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
    • Parameters

      • req: NextRequest

      Returns Promise<NextResponse<unknown>>

    • Parameters

      • req: NextRequest

      Returns Promise<NextResponse<unknown>>

    • Parameters

      • req: NextRequest

      Returns Promise<NextResponse<unknown>>

    • Parameters

      • req: NextRequest

      Returns Promise<NextResponse<unknown>>

    • Parameters

      • req: NextRequest

      Returns Promise<NextResponse<unknown>>

    • Parameters

      • req: NextRequest

      Returns Promise<NextResponse<unknown>>

    • Parameters

      • req: NextRequest

      Returns Promise<NextResponse<unknown>>