MonoCloud Authentication SDK
    Preparing search index...

    Interface ProtectClientPageOptions

    Options for configuring page protection.

    interface ProtectClientPageOptions {
        authParams?: ExtraAuthParams;
        groups?: string[];
        groupsClaim?: string;
        matchAll?: boolean;
        onAccessDenied?: () => ReactNode;
        onError?: (error: Error) => ReactNode;
        onGroupAccessDenied?: (user: MonoCloudUser) => ReactNode;
        returnUrl?: string;
    }

    Hierarchy

    Index

    Properties

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

    Properties

    authParams?: ExtraAuthParams

    Authorization parameters to be used during authentication.

    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?: () => ReactNode

    A custom react element to render when the user is not authenticated.

    onError?: (error: Error) => ReactNode

    Callback function to handle errors. If not provided, errors will be thrown.

    Type Declaration

      • (error: Error): ReactNode

      • Parameters

        • error: Error

          The error object.

        Returns ReactNode

        JSX element to handle the error.

    onGroupAccessDenied?: (user: MonoCloudUser) => ReactNode

    A custom react element to render when the user is authenticated but does not belong to the required groups.

    returnUrl?: string

    The URL where the user will be redirected to after sign in.

    Settings

    On This Page

    Properties