Interface AuthModuleConfiguration

interface AuthModuleConfiguration {
    authenticationDomain?: string;
    passportDomain?: string;
    crossSdkBridgeEnabled?: boolean;
    popupOverlayOptions?: auth.PopupOverlayOptions;
    clientId: string;
    logoutRedirectUri?: string;
    logoutMode?: "redirect" | "silent";
    redirectUri: string;
    popupRedirectUri?: string;
    scope?: string;
    audience?: string;
}

Hierarchy (view full)

Properties

authenticationDomain? passportDomain? crossSdkBridgeEnabled? popupOverlayOptions? clientId logoutRedirectUri? logoutMode? redirectUri popupRedirectUri? scope? audience?

Properties

OptionalauthenticationDomain

authenticationDomain?: string

Authentication domain (e.g., 'https://auth.immutable.com')

OptionalpassportDomain

passportDomain?: string

Passport domain for confirmation screens (e.g., 'https://passport.immutable.com')

OptionalcrossSdkBridgeEnabled

crossSdkBridgeEnabled?: boolean

This flag indicates that Auth is being used in a cross-sdk bridge scenario and not directly on the web.

OptionalpopupOverlayOptions

popupOverlayOptions?: auth.PopupOverlayOptions

Options for customizing popup overlays

clientId

clientId: string

OptionallogoutRedirectUri

logoutRedirectUri?: string

OptionallogoutMode

logoutMode?: "redirect" | "silent"

redirectUri

redirectUri: string

OptionalpopupRedirectUri

popupRedirectUri?: string

Optionalscope

scope?: string

Optionalaudience

audience?: string

Settings

Member Visibility

On This Page

Properties