MonoCloud Authentication SDK
    Preparing search index...

    Interface ProtectPagePageOptions<P, Q>

    Options for configuring protectPage() in the Pages Router.

    interface ProtectPagePageOptions<
        P extends Record<string, any> = Record<string, any>,
        Q extends ParsedUrlQuery = ParsedUrlQuery,
    > {
        authParams?: ExtraAuthParams;
        getServerSideProps?: GetServerSideProps<P, Q>;
        groups?: string[];
        groupsClaim?: string;
        matchAll?: boolean;
        onAccessDenied?: ProtectPagePageOnAccessDeniedType<P, Q>;
        onGroupAccessDenied?: ProtectPagePageOnGroupAccessDeniedType<P, Q>;
        returnUrl?: string;
    }

    Type Parameters

    • P extends Record<string, any> = Record<string, any>

      Props returned from getServerSideProps.

    • Q extends ParsedUrlQuery = ParsedUrlQuery

      Query parameters parsed from the URL.

    Hierarchy

    Index

    Properties

    authParams? getServerSideProps? groups? groupsClaim? matchAll? onAccessDenied? onGroupAccessDenied? returnUrl?

    Properties

    authParams?: ExtraAuthParams

    Additional authorization parameters applied when redirecting the user to authenticate.

    getServerSideProps?: GetServerSideProps<P, Q>

    An optional getServerSideProps implementation that runs after authentication (and group checks, if configured). Use this to compute additional props for the page.

    groups?: string[]

    A list of group IDs or group names the authenticated user must belong to.

    Group membership is evaluated using the configured groupsClaim from the user session.

    groupsClaim?: string

    The name of the claim in the user profile that contains group information. This value is read from the authenticated user's session.

    'groups'
    matchAll?: boolean

    Determines how multiple groups are evaluated. When true, the user must belong to all specified groups for authorization to succeed. Otherwise, membership in any one group is sufficient.

    false
    onAccessDenied?: ProtectPagePageOnAccessDeniedType<P, Q>

    Called when no valid session exists.

    If not provided, the default behavior redirects the user to the sign-in flow.

    onGroupAccessDenied?: ProtectPagePageOnGroupAccessDeniedType<P, Q>

    Called when the user is authenticated but does not satisfy the group requirements.

    If not provided, the default behavior continues rendering and sets groupAccessDenied in the returned props, or applies the SDK’s default access-denied behavior.

    returnUrl?: string

    The URL the user should be returned to after successful authentication.

    Defaults to the current request URL.

    Settings

    On This Page

    Properties