MonoCloud Authentication SDK
    Preparing search index...

    Interface MonoCloudOptionsBase

    Options for configuration MonoCloud Authentication.

    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

    Determines whether authorization parameters should be dynamically extracted from query.

    When set to true, parameters such as scope, resource, prompt etc from the query parameters will be merged into the authentication request.

    // The SDK will automatically use prompt='login' and the login_hint.
    https://example.com/api/auth/signin?prompt=login&login_hint=user@example.com

    false
    appUrl: string

    The URL of the application.

    clientId: string

    The client ID of the authenticating application.

    clientSecret?: string

    Optional: The client secret of the authenticating application.

    clockSkew: number

    The maximum allowed clock skew (in seconds) for token validation.

    60 (seconds)
    cookieSecret: string

    A secret key that will be used for encrypting cookies.

    debugger: string

    The name of the debugger instance.

    defaultAuthParams: AuthorizationParams

    Default authorization parameters to include in authentication requests.

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

    Determines whether the user will be logged out of the authentication service.

    true
    filteredIdTokenClaims: string[]

    Array of strings representing the filtered ID token claims.

    idTokenSigningAlg: SecurityAlgorithms

    The signing algorithm that is expected to be used for signing ID tokens.

    'RS256'
    jwksCacheDuration?: number

    Jwks Cache Duration

    Time in seconds to cache the JWKS document after it is fetched

    60 (seconds)
    metadataCacheDuration?: number

    Metadata Cache Duration

    Time in seconds to cache the metadata document after it is fetched.

    60 (seconds)
    onBackChannelLogout?: OnBackChannelLogout

    Optional: A callback function invoked when a back-channel logout event is received.

    onSessionCreating?: OnSessionCreating

    Optional: A callback function invoked before creating or updating the user session.

    onSetApplicationState?: OnSetApplicationState

    Optional: A callback function invoked when an authentication state is being set (before sign-in).

    postLogoutRedirectUri?: string

    Optional: The URI to redirect to after the user logs out.

    refetchUserInfo: boolean

    Determines whether to refetch the user information from the authentication service on each request to the application's userinfo endpoint.

    false
    resources?: Indicator[]

    Optional: Additional resources that can be requested in getTokens().

    responseTimeout: number

    The timeout (in milliseconds) for receiving responses from the authentication service.

    10000 (10 seconds)
    routes: MonoCloudRoutes

    Configuration options for the route handler URLs.

    session: MonoCloudSessionOptionsBase

    Configuration options for the user session.

    state: MonoCloudStateOptions

    Configuration options for state management during authentication.

    tenantDomain: string

    MonoCloud tenant domain.

    usePar: boolean

    Determines whether to use PAR (Pushed Authorization Requests) for authorization requests.

    false
    userAgent: string

    The name of the user agent.

    userInfo: boolean

    Determines whether to fetch the user information from the 'userinfo' endpoint during authentication.

    true

    Settings

    Member Visibility

    On This Page

    Properties