diff --git a/docs/classes/session.sessioncache.html b/docs/classes/session.sessioncache.html index 9d130edb8..efef94506 100644 --- a/docs/classes/session.sessioncache.html +++ b/docs/classes/session.sessioncache.html @@ -118,7 +118,7 @@

constructor

  • Parameters

    @@ -147,7 +147,7 @@

    create

  • Parameters

    @@ -176,7 +176,7 @@

    delete

  • Parameters

    @@ -202,7 +202,7 @@

    fromTokenSet

  • Parameters

    @@ -225,7 +225,7 @@

    get

  • Parameters

    @@ -251,7 +251,7 @@

    getIdToken

  • Parameters

    @@ -277,7 +277,7 @@

    init

  • Parameters

    @@ -303,7 +303,7 @@

    isAuthenticated

  • Parameters

    @@ -329,7 +329,7 @@

    set

  • Parameters

    diff --git a/docs/classes/session_session.default.html b/docs/classes/session_session.default.html index b921e61f6..49ad2eece 100644 --- a/docs/classes/session_session.default.html +++ b/docs/classes/session_session.default.html @@ -126,7 +126,7 @@

    constructor

  • Parameters

    @@ -148,7 +148,7 @@

    Optional accessToken

    accessToken: undefined | string
    @@ -163,7 +163,7 @@

    Optional accessToken
    accessTokenExpiresAt: undefined | number
    @@ -178,7 +178,7 @@

    Optional accessToken
    accessTokenScope: undefined | string
    @@ -193,7 +193,7 @@

    Optional idToken

    idToken: undefined | string
    @@ -208,7 +208,7 @@

    Optional refreshToken

    refreshToken: undefined | string
    @@ -223,7 +223,7 @@

    user

    user: Claims
    diff --git a/docs/classes/utils_errors.accesstokenerror.html b/docs/classes/utils_errors.accesstokenerror.html index 32602ff14..87fe98342 100644 --- a/docs/classes/utils_errors.accesstokenerror.html +++ b/docs/classes/utils_errors.accesstokenerror.html @@ -117,7 +117,7 @@

    constructor

  • Parameters

    @@ -142,7 +142,7 @@

    code

    code: string
    diff --git a/docs/interfaces/config.authorizationparameters.html b/docs/interfaces/config.authorizationparameters.html index 0165a1293..cf63b9566 100644 --- a/docs/interfaces/config.authorizationparameters.html +++ b/docs/interfaces/config.authorizationparameters.html @@ -110,7 +110,7 @@

    response_mode

    response_mode: "query" | "form_post"
    @@ -120,7 +120,7 @@

    response_type

    response_type: "id_token" | "code id_token" | "code"
    @@ -130,7 +130,7 @@

    scope

    scope: string
    diff --git a/docs/interfaces/config.baseconfig.html b/docs/interfaces/config.baseconfig.html index 08586307d..c0433af5e 100644 --- a/docs/interfaces/config.baseconfig.html +++ b/docs/interfaces/config.baseconfig.html @@ -111,7 +111,7 @@

    auth0Logout

    auth0Logout: boolean
    @@ -127,7 +127,7 @@

    authorizationParams

    authorizationParams: AuthorizationParameters
    @@ -160,7 +160,7 @@

    baseURL

    baseURL: string
    @@ -178,7 +178,7 @@

    clientID

    clientID: string
    @@ -194,7 +194,7 @@

    Optional clientSecret

    clientSecret: undefined | string
    @@ -211,7 +211,7 @@

    clockTolerance

    clockTolerance: number
    @@ -228,7 +228,7 @@

    enableTelemetry

    enableTelemetry: boolean
    @@ -245,7 +245,7 @@

    getLoginState

    getLoginState: (req: IncomingMessage, options: LoginOptions) => Record<string, any>
    @@ -297,7 +297,7 @@

    httpTimeout

    httpTimeout: number
    @@ -314,7 +314,7 @@

    idTokenSigningAlg

    idTokenSigningAlg: string
    @@ -330,7 +330,7 @@

    identityClaimFilter

    identityClaimFilter: string[]
    @@ -346,7 +346,7 @@

    idpLogout

    idpLogout: boolean
    @@ -362,7 +362,7 @@

    issuerBaseURL

    issuerBaseURL: string
    @@ -379,7 +379,7 @@

    legacySameSiteCookie

    legacySameSiteCookie: boolean
    @@ -396,7 +396,7 @@

    routes

    routes: { callback: string; postLogoutRedirect: string }
    @@ -437,7 +437,7 @@

    secret

    secret: string | string[]
    @@ -455,7 +455,7 @@

    session

    session: SessionConfig
    diff --git a/docs/interfaces/config.cookieconfig.html b/docs/interfaces/config.cookieconfig.html index 2f1140012..1864c04ee 100644 --- a/docs/interfaces/config.cookieconfig.html +++ b/docs/interfaces/config.cookieconfig.html @@ -107,7 +107,7 @@

    Optional domain

    domain: undefined | string
    @@ -123,7 +123,7 @@

    httpOnly

    httpOnly: boolean
    @@ -140,7 +140,7 @@

    Optional path

    path: undefined | string
    @@ -158,7 +158,7 @@

    sameSite

    sameSite: "lax" | "strict" | "none"
    @@ -175,7 +175,7 @@

    Optional secure

    secure: undefined | boolean
    @@ -192,7 +192,7 @@

    transient

    transient: boolean
    diff --git a/docs/interfaces/config.nextconfig.html b/docs/interfaces/config.nextconfig.html index fc68f0ad1..ed5e9055b 100644 --- a/docs/interfaces/config.nextconfig.html +++ b/docs/interfaces/config.nextconfig.html @@ -102,7 +102,7 @@

    identityClaimFilter

    identityClaimFilter: string[]
    @@ -118,12 +118,12 @@

    Optional organization

    organization: undefined | string
    -

    Log users in to a specific organization (Organizations is currently a Closed Beta).

    +

    Log users in to a specific organization.

    This will specify an organization parameter in your user's login request and will add a step to validate the org_id claim in your user's ID Token.

    @@ -136,7 +136,7 @@

    routes

    routes: { login: string }
    diff --git a/docs/interfaces/config.sessionconfig.html b/docs/interfaces/config.sessionconfig.html index 9db7bddcf..f4f6e8342 100644 --- a/docs/interfaces/config.sessionconfig.html +++ b/docs/interfaces/config.sessionconfig.html @@ -106,7 +106,7 @@

    absoluteDuration

    absoluteDuration: number | boolean
    @@ -125,7 +125,7 @@

    cookie

    cookie: CookieConfig
    @@ -135,7 +135,7 @@

    name

    name: string
    @@ -153,7 +153,7 @@

    rolling

    rolling: boolean
    @@ -173,7 +173,7 @@

    rollingDuration

    rollingDuration: number
    diff --git a/docs/interfaces/frontend_use_user.userprofile.html b/docs/interfaces/frontend_use_user.userprofile.html index c88872e5d..d55050455 100644 --- a/docs/interfaces/frontend_use_user.userprofile.html +++ b/docs/interfaces/frontend_use_user.userprofile.html @@ -117,7 +117,7 @@

    Optional email

    email: undefined | null | string
    @@ -127,7 +127,7 @@

    Optional email_verifiedemail_verified: undefined | null | boolean

    @@ -137,7 +137,7 @@

    Optional name

    name: undefined | null | string
    @@ -147,7 +147,7 @@

    Optional nickname

    nickname: undefined | null | string
    @@ -157,7 +157,7 @@

    Optional picture

    picture: undefined | null | string
    @@ -167,7 +167,7 @@

    Optional sub

    sub: undefined | null | string
    @@ -177,7 +177,7 @@

    Optional updated_at

    updated_at: undefined | null | string
    diff --git a/docs/interfaces/frontend_with_page_auth_required.withpageauthrequiredoptions.html b/docs/interfaces/frontend_with_page_auth_required.withpageauthrequiredoptions.html index 2534247cc..c2cc96ce1 100644 --- a/docs/interfaces/frontend_with_page_auth_required.withpageauthrequiredoptions.html +++ b/docs/interfaces/frontend_with_page_auth_required.withpageauthrequiredoptions.html @@ -104,7 +104,7 @@

    Optional onError

    onError: undefined | ((error: Error) => Element)
    @@ -123,7 +123,7 @@

    Optional onRedirectingonRedirecting: undefined | (() => Element)

    @@ -142,7 +142,7 @@

    Optional returnTo

    returnTo: undefined | string
    diff --git a/docs/interfaces/handlers_auth.handlers.html b/docs/interfaces/handlers_auth.handlers.html index a3bfefc8d..3d7a42aa4 100644 --- a/docs/interfaces/handlers_auth.handlers.html +++ b/docs/interfaces/handlers_auth.handlers.html @@ -125,7 +125,7 @@

    callback

    callback: HandleCallback
    @@ -135,7 +135,7 @@

    login

    login: HandleLogin
    @@ -145,7 +145,7 @@

    logout

    logout: HandleLogout
    @@ -155,7 +155,7 @@

    profile

    profile: HandleProfile
    diff --git a/docs/interfaces/handlers_callback.callbackoptions.html b/docs/interfaces/handlers_callback.callbackoptions.html index f8d12b9a4..d4539f598 100644 --- a/docs/interfaces/handlers_callback.callbackoptions.html +++ b/docs/interfaces/handlers_callback.callbackoptions.html @@ -104,7 +104,7 @@

    Optional afterCallbackafterCallback: undefined | AfterCallback

    @@ -114,7 +114,7 @@

    Optional organization

    organization: undefined | string
    @@ -130,7 +130,7 @@

    Optional redirectUri

    redirectUri: undefined | string
    diff --git a/docs/interfaces/handlers_login.authorizationparams.html b/docs/interfaces/handlers_login.authorizationparams.html index 22bf6bdfd..cc6e3cb60 100644 --- a/docs/interfaces/handlers_login.authorizationparams.html +++ b/docs/interfaces/handlers_login.authorizationparams.html @@ -111,12 +111,12 @@

    Optional invitation

    invitation: undefined | string
    -

    The invitation id to join an organization (Organizations is currently a Closed Beta).

    +

    The invitation id to join an organization.

    To create a link for your user's to accept an organization invite, read the invitation and organization query params and pass them to the authorization server to log the user in:

    @@ -150,7 +150,7 @@

    Optional organization

    organization: undefined | string
    @@ -166,7 +166,7 @@

    Optional response_moderesponse_mode: undefined | "query" | "form_post"

    @@ -176,7 +176,7 @@

    Optional response_typeresponse_type: undefined | "id_token" | "code id_token" | "code"

    @@ -186,7 +186,7 @@

    Optional scope

    scope: undefined | string
    diff --git a/docs/interfaces/handlers_login.loginoptions.html b/docs/interfaces/handlers_login.loginoptions.html index cc8569e48..cc4f2377e 100644 --- a/docs/interfaces/handlers_login.loginoptions.html +++ b/docs/interfaces/handlers_login.loginoptions.html @@ -104,7 +104,7 @@

    Optional authorizationPar
    authorizationParams: undefined | AuthorizationParams
    @@ -119,7 +119,7 @@

    Optional getLoginSta
    getLoginState: undefined | GetLoginState
    @@ -134,7 +134,7 @@

    Optional returnTo

    returnTo: undefined | string
    diff --git a/docs/interfaces/handlers_logout.logoutoptions.html b/docs/interfaces/handlers_logout.logoutoptions.html index c04d888ca..9bb6bd37c 100644 --- a/docs/interfaces/handlers_logout.logoutoptions.html +++ b/docs/interfaces/handlers_logout.logoutoptions.html @@ -102,7 +102,7 @@

    Optional returnTo

    returnTo: undefined | string
    diff --git a/docs/interfaces/instance.signinwithauth0.html b/docs/interfaces/instance.signinwithauth0.html index 31cabe0c6..f704fff68 100644 --- a/docs/interfaces/instance.signinwithauth0.html +++ b/docs/interfaces/instance.signinwithauth0.html @@ -112,7 +112,7 @@

    getAccessToken

    getAccessToken: GetAccessToken
    @@ -127,7 +127,7 @@

    getSession

    getSession: GetSession
    @@ -142,7 +142,7 @@

    handleAuth

    handleAuth: HandleAuth
    @@ -157,7 +157,7 @@

    handleCallback

    handleCallback: HandleCallback
    @@ -172,7 +172,7 @@

    handleLogin

    handleLogin: HandleLogin
    @@ -187,7 +187,7 @@

    handleLogout

    handleLogout: HandleLogout
    @@ -202,7 +202,7 @@

    handleProfile

    handleProfile: HandleProfile
    @@ -217,7 +217,7 @@

    withApiAuthRequired

    withApiAuthRequired: WithApiAuthRequired
    @@ -232,7 +232,7 @@

    withPageAuthRequired

    withPageAuthRequired: WithPageAuthRequired
    diff --git a/docs/interfaces/session_get_access_token.accesstokenrequest.html b/docs/interfaces/session_get_access_token.accesstokenrequest.html index 5678d6409..eb0c43199 100644 --- a/docs/interfaces/session_get_access_token.accesstokenrequest.html +++ b/docs/interfaces/session_get_access_token.accesstokenrequest.html @@ -103,7 +103,7 @@

    Optional refresh

    refresh: undefined | boolean
    @@ -119,7 +119,7 @@

    Optional scopes

    scopes: undefined | string[]
    diff --git a/docs/interfaces/session_get_access_token.getaccesstokenresult.html b/docs/interfaces/session_get_access_token.getaccesstokenresult.html index 99170ad66..0f847ae92 100644 --- a/docs/interfaces/session_get_access_token.getaccesstokenresult.html +++ b/docs/interfaces/session_get_access_token.getaccesstokenresult.html @@ -102,7 +102,7 @@

    Optional accessToken

    accessToken: undefined | string
    diff --git a/docs/modules/config.html b/docs/modules/config.html index 1c6fe72e4..4eb48e3ca 100644 --- a/docs/modules/config.html +++ b/docs/modules/config.html @@ -97,7 +97,7 @@

    ConfigParameters

    ConfigParameters: DeepPartial<BaseConfig & NextConfig>
    diff --git a/docs/modules/frontend.html b/docs/modules/frontend.html index 4791d43e9..63e2fec82 100644 --- a/docs/modules/frontend.html +++ b/docs/modules/frontend.html @@ -128,7 +128,7 @@

    ConfigProviderProps

    ConfigProviderProps: React.PropsWithChildren<ConfigContext>
    @@ -176,7 +176,7 @@

    Const useConfig

  • Returns ConfigContext

    diff --git a/docs/modules/frontend_use_user.html b/docs/modules/frontend_use_user.html index 38fdb09e1..7dde1bb9c 100644 --- a/docs/modules/frontend_use_user.html +++ b/docs/modules/frontend_use_user.html @@ -99,7 +99,7 @@

    UseUser

    UseUser: () => UserContext
    @@ -143,7 +143,7 @@

    UserContext

    UserContext: { checkSession: () => Promise<void>; error?: Error; isLoading: boolean; user?: UserProfile }
    @@ -187,7 +187,7 @@

    UserProvider

    UserProvider: (props: UserProviderProps) => ReactElement<UserContext>
    @@ -223,7 +223,7 @@

    UserProviderProps

    UserProviderProps: React.PropsWithChildren<{ profileUrl?: string; user?: UserProfile } & ConfigContext>
    diff --git a/docs/modules/frontend_with_page_auth_required.html b/docs/modules/frontend_with_page_auth_required.html index c4739701e..7193a4424 100644 --- a/docs/modules/frontend_with_page_auth_required.html +++ b/docs/modules/frontend_with_page_auth_required.html @@ -90,7 +90,7 @@

    WithPageAuthRequired

    WithPageAuthRequired: <P>(Component: ComponentType<P>, options?: WithPageAuthRequiredOptions) => React.FC<P>
    diff --git a/docs/modules/handlers_auth.html b/docs/modules/handlers_auth.html index af9d745a2..d4c47d2a0 100644 --- a/docs/modules/handlers_auth.html +++ b/docs/modules/handlers_auth.html @@ -90,7 +90,7 @@

    HandleAuth

    HandleAuth: (userHandlers?: Partial<Handlers>) => NextApiHandler
    diff --git a/docs/modules/handlers_callback.html b/docs/modules/handlers_callback.html index 6e6aeda79..646fad46f 100644 --- a/docs/modules/handlers_callback.html +++ b/docs/modules/handlers_callback.html @@ -91,7 +91,7 @@

    AfterCallback

    AfterCallback: (req: NextApiRequest, res: NextApiResponse, session: default, state: {}) => Promise<default> | default
    @@ -187,7 +187,7 @@

    HandleCallback

    HandleCallback: (req: NextApiRequest, res: NextApiResponse, options?: CallbackOptions) => Promise<void>
    diff --git a/docs/modules/handlers_login.html b/docs/modules/handlers_login.html index 4efe4f4ce..4531c6ec6 100644 --- a/docs/modules/handlers_login.html +++ b/docs/modules/handlers_login.html @@ -92,7 +92,7 @@

    GetLoginState

    GetLoginState: (req: NextApiRequest, options: LoginOptions) => {}
    @@ -153,7 +153,7 @@

    HandleLogin

    HandleLogin: (req: NextApiRequest, res: NextApiResponse, options?: LoginOptions) => Promise<void>
    diff --git a/docs/modules/handlers_logout.html b/docs/modules/handlers_logout.html index e3c795914..b15db52d0 100644 --- a/docs/modules/handlers_logout.html +++ b/docs/modules/handlers_logout.html @@ -90,7 +90,7 @@

    HandleLogout

    HandleLogout: (req: NextApiRequest, res: NextApiResponse, options?: LogoutOptions) => Promise<void>
    diff --git a/docs/modules/handlers_profile.html b/docs/modules/handlers_profile.html index 9167101d3..0af9b2168 100644 --- a/docs/modules/handlers_profile.html +++ b/docs/modules/handlers_profile.html @@ -89,7 +89,7 @@

    AfterRefetch

    AfterRefetch: (req: NextApiRequest, res: NextApiResponse, session: default) => Promise<default> | default
    @@ -129,7 +129,7 @@

    HandleProfile

    HandleProfile: (req: NextApiRequest, res: NextApiResponse, options?: ProfileOptions) => Promise<void>
    @@ -171,7 +171,7 @@

    ProfileOptions

    ProfileOptions: { afterRefetch?: AfterRefetch; refetch?: boolean }
    diff --git a/docs/modules/helpers_with_api_auth_required.html b/docs/modules/helpers_with_api_auth_required.html index c64c0da2e..d260c1f05 100644 --- a/docs/modules/helpers_with_api_auth_required.html +++ b/docs/modules/helpers_with_api_auth_required.html @@ -84,7 +84,7 @@

    WithApiAuthRequired

    WithApiAuthRequired: (apiRoute: NextApiHandler) => NextApiHandler
    diff --git a/docs/modules/helpers_with_page_auth_required.html b/docs/modules/helpers_with_page_auth_required.html index 6da195ec1..d894db5c5 100644 --- a/docs/modules/helpers_with_page_auth_required.html +++ b/docs/modules/helpers_with_page_auth_required.html @@ -87,7 +87,7 @@

    GetServerSidePropsResultWithSession

    GetServerSidePropsResultWithSession: GetServerSidePropsResult<{ user?: Claims | null }>
    @@ -112,7 +112,7 @@

    PageRoute

    PageRoute: (cts: GetServerSidePropsContext) => Promise<GetServerSidePropsResultWithSession>
    @@ -148,7 +148,7 @@

    WithPageAuthRequired

    WithPageAuthRequired: { (opts?: WithPageAuthRequiredOptions): PageRoute; <P>(Component: ComponentType<P>, options?: WithPageAuthRequiredOptions): FC<P> }
    @@ -214,7 +214,7 @@

    WithPageAuthRequiredOptions

    WithPageAuthRequiredOptions: { getServerSideProps?: GetServerSideProps; returnTo?: string }
    diff --git a/docs/modules/instance.html b/docs/modules/instance.html index be7a22ae1..923ea0754 100644 --- a/docs/modules/instance.html +++ b/docs/modules/instance.html @@ -90,7 +90,7 @@

    InitAuth0

    InitAuth0: (params?: ConfigParameters) => SignInWithAuth0
    diff --git a/docs/modules/session_get_access_token.html b/docs/modules/session_get_access_token.html index 78121f0bf..5328794fd 100644 --- a/docs/modules/session_get_access_token.html +++ b/docs/modules/session_get_access_token.html @@ -91,7 +91,7 @@

    GetAccessToken

    GetAccessToken: (req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse, accessTokenRequest?: AccessTokenRequest) => Promise<GetAccessTokenResult>
    diff --git a/docs/modules/session_get_session.html b/docs/modules/session_get_session.html index 4b79aae38..e45378d97 100644 --- a/docs/modules/session_get_session.html +++ b/docs/modules/session_get_session.html @@ -84,7 +84,7 @@

    GetSession

    GetSession: (req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse) => default | null | undefined