MonoCloud Authentication SDK
    Preparing search index...

    Interface MonoCloudOptionsBase

    Core configuration options for the SDK.

    These options define how the SDK communicates with your MonoCloud tenant, manages sessions, and performs authentication flows.

    interface MonoCloudOptionsBase {
        allowQueryParamOverrides?: boolean;
        appUrl: string;
        clientId: string;
        clientSecret?: string;
        clockSkew: number;
        cookieSecret: string;
        debugger: string;
        defaultAuthParams: AuthorizationParams;
        federatedSignOut: boolean;
        filteredIdTokenClaims: string[];
        idTokenSigningAlg: SecurityAlgorithms;
        jwksCacheDuration?: number;
        metadataCacheDuration?: number;
        onBackChannelLogout?: OnBackChannelLogout;
        onSessionCreating?: OnSessionCreating;
        onSetApplicationState?: OnSetApplicationState;
        postLogoutRedirectUri?: string;
        refetchUserInfo: boolean;
        resources?: Indicator[];
        responseTimeout: number;
        routes: MonoCloudRoutes;
        session: MonoCloudSessionOptionsBase;
        state: MonoCloudStateOptions;
        tenantDomain: string;
        usePar: boolean;
        userAgent: string;
        userInfo: boolean;
    }
    Index

    Properties

    allowQueryParamOverrides? appUrl clientId clientSecret? clockSkew cookieSecret debugger defaultAuthParams federatedSignOut filteredIdTokenClaims idTokenSigningAlg jwksCacheDuration? metadataCacheDuration? onBackChannelLogout? onSessionCreating? onSetApplicationState? postLogoutRedirectUri? refetchUserInfo resources? responseTimeout routes session state tenantDomain usePar userAgent userInfo

    Properties

    allowQueryParamOverrides?: boolean

    Allows authorization parameters to be overridden using query parameters.

    When disabled, parameters such as scope, resource, prompt, and login_hint present in the request URL are ignored and cannot modify the authentication request.

    false
    appUrl: string

    Base URL where the application is hosted.

    Used to construct redirect URLs and validate requests.

    clientId: string

    Client identifier of the application registered in MonoCloud.

    clientSecret?: string

    Optional client secret used for confidential clients.

    clockSkew: number

    Allowed clock skew (in seconds) when validating token timestamps.

    60 (seconds)
    cookieSecret: string

    Secret used to encrypt and sign authentication cookies. This value should be long, random, and kept private.

    debugger: string

    Identifier used for internal debugging/logging.

    defaultAuthParams: AuthorizationParams

    Default authorization parameters included in authentication requests.

    {
       *   scope: 'openid email profile',
       *   response_type: 'code'
       * }
    federatedSignOut: boolean

    When true, signing out also logs the user out of MonoCloud (Single Sign-Out).

    true
    filteredIdTokenClaims: string[]

    List of ID token claims that should be removed before storing data in the session.

    idTokenSigningAlg: SecurityAlgorithms

    Expected signing algorithm for ID tokens.

    'RS256'
    jwksCacheDuration?: number

    Duration (in seconds) to cache the JWKS document.

    300
    metadataCacheDuration?: number

    Duration (in seconds) to cache OpenID discovery metadata.

    300
    onBackChannelLogout?: OnBackChannelLogout

    Invoked when a back-channel logout request is received.

    onSessionCreating?: OnSessionCreating

    Invoked before a session is created or updated. Can be used to modify session data or attach custom fields.

    onSetApplicationState?: OnSetApplicationState

    Invoked before authentication begins to attach custom application state.

    postLogoutRedirectUri?: string

    URL to redirect users to after logout completes.

    refetchUserInfo: boolean

    Refetch user profile data whenever the application's UserInfo endpoint is invoked.

    false
    resources?: Indicator[]

    Optional resource indicators available when requesting tokens via getTokens().

    responseTimeout: number

    Maximum time (in milliseconds) to wait for responses from the MonoCloud authorization server.

    10000 (10 seconds)
    routes: MonoCloudRoutes

    Route paths used by MonoCloud authentication handlers.

    session: MonoCloudSessionOptionsBase

    Session configuration.

    state: MonoCloudStateOptions

    Authentication state configuration.

    tenantDomain: string

    MonoCloud tenant domain (for example, https://your-tenant.us.monocloud.com).

    usePar: boolean

    Enables Pushed Authorization Requests (PAR).

    When enabled, authorization parameters are sent securely via the PAR endpoint instead of the browser.

    false
    userAgent: string

    Custom User-Agent value sent with requests to MonoCloud.

    userInfo: boolean

    Fetch user profile data from the UserInfo endpoint after authentication completes.

    true

    Settings

    On This Page

    Properties