Skip to main content

foundation-auth.authconfig

Home > @genesislcap/foundation-auth > AuthConfig

AuthConfig interface

AuthConfig DI interface.

Signature:

export interface AuthConfig extends PartialFASTElementDefinition 

Extends: PartialFASTElementDefinition

Properties

Property

Modifiers

Type

Description

background

ComposableStyles | ComposableStyles[] | null

Background styles.

backgroundVideo

{ src: string; type: 'video/ogg' | 'video/mp4' | 'video/webm'; } | null

Background video.

feedbackDelay?

number

(Optional) Feedback delay.

fields

FieldConfigMap

Map of configuration for each of the primary form fields.

hostPath

string

The path of the micro frontend as defined in the parent / host route.

localizationResources?

I18nextConfig['resources']

(Optional) I18n resources.

logo

ComposableStyles | ComposableStyles[] | null

Logo styles.

logoAltText

string

Logo alt text.

omitRedirectUrls

string[]

Omit certain return URLs which the session service may have captured.

omitRoutes

Exclude<AuthRoutes, 'login' | 'not-found'>[]

Omit any of the internal routes except 'login' and 'not-found'.

postLoginRedirect

() => void

postLogoutRedirect

() => void

showEnvironmentIndicator?

boolean

(Optional) Show or hide the environment indicator.

sso

SSOConfig | null

SSO configuration.

templateOptions

TemplateOptions

Template options.

versionInformation?

string

(Optional) Display arbitrary version information.