MonoCloud Authentication SDK
    Preparing search index...

    Interface ProtectApiPageOptions

    Options for configuring protectApi() in the Pages Router.

    interface ProtectApiPageOptions {
        groups?: string[];
        groupsClaim?: string;
        matchAll?: boolean;
        onAccessDenied?: PageRouterApiOnAccessDeniedHandler;
        onGroupAccessDenied?: PageRouterApiOnGroupAccessDeniedHandler;
    }

    Hierarchy

    Index

    Properties

    groups? groupsClaim? matchAll? onAccessDenied? onGroupAccessDenied?

    Properties

    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?: PageRouterApiOnAccessDeniedHandler

    Alternate API handler invoked when the request is unauthenticated.

    onGroupAccessDenied?: PageRouterApiOnGroupAccessDeniedHandler

    Alternate API handler invoked when the user is authenticated but does not satisfy the configured group authorization rules.

    Settings

    On This Page

    Properties