Sign in

Type: MonoCloudOptionsBase

Core configuration options for the SDK.

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

Properties

PropertyTypeDescription
allowQueryParamOverrides?booleanAllows 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.
appUrlstringBase URL where the application is hosted. Used to construct redirect URLs and validate requests.
clientIdstringClient identifier of the application registered in MonoCloud.
clientSecret?stringOptional client secret used for confidential clients.
clockSkewnumberAllowed clock skew (in seconds) when validating token timestamps.
cookieSecretstringSecret used to encrypt and sign authentication cookies. This value should be long, random, and kept private.
debuggerstringIdentifier used for internal debugging/logging.
defaultAuthParamsAuthorizationParamsDefault authorization parameters included in authentication requests.
federatedSignOutbooleanWhen true, signing out also logs the user out of MonoCloud (Single Sign-Out).
fetchUserInfobooleanFetch user profile data from the UserInfo endpoint after authentication completes.
filteredIdTokenClaimsstring[]List of ID token claims that should be removed before storing data in the session.
idTokenSigningAlgSecurityAlgorithmsExpected signing algorithm for ID tokens.
jwksCacheDuration?numberDuration (in seconds) to cache the JWKS document.
metadataCacheDuration?numberDuration (in seconds) to cache OpenID discovery metadata.
onBackChannelLogout?OnBackChannelLogoutInvoked when a back-channel logout request is received.
onSessionCreating?OnSessionCreatingInvoked before a session is created or updated. Can be used to modify session data or attach custom fields.
onSetApplicationState?OnSetApplicationStateInvoked before authentication begins to attach custom application state.
postLogoutRedirectUri?stringURL to redirect users to after logout completes.
refetchUserInfobooleanRefetch user profile data whenever the application's UserInfo endpoint is invoked.
resources?Indicator[]Optional resource indicators available when requesting tokens via getTokens().
responseTimeoutnumberMaximum time (in milliseconds) to wait for responses from the MonoCloud authorization server.
routesMonoCloudRoutesRoute paths used by MonoCloud authentication handlers.
sessionMonoCloudSessionOptionsBaseSession configuration.
stateMonoCloudStateOptionsAuthentication state configuration.
strictProfileSync?booleanDetermines how user profile is updated when the session is updated. When enabled, the session user profile is fully replaced with a newly constructed profile derived from the latest ID token and, if applicable, the UserInfo response.
tenantDomainstringMonoCloud tenant domain (for example, https://your-tenant.us.monocloud.com).
useParbooleanEnables Pushed Authorization Requests (PAR). When enabled, authorization parameters are sent securely via the PAR endpoint instead of the browser.
userAgentstringCustom User-Agent value sent with requests to MonoCloud.
© 2024 MonoCloud. All rights reserved.