Type Alias: AuthGateConfig

AuthGateConfig = BasePluginConfig & SerializableAuthGateConfig & object

Options for the authGate plugin.

Type Declaration

authorizeIdentity?

optional authorizeIdentity?: AuthorizeIdentity

sendCode?

optional sendCode?: (email, code, opts) => Promise<void>

Parameters

email

string

code

string

opts

SendCodeOptions

Returns

Promise<void>

AuthGateConfig fields

Serializable authentication gate configuration.

• storage (optional): Authentication storage mode.
• sqlitePath (optional): Optional local SQLite database path.
• allow (optional): Email allow-list patterns.
• subject (optional): Verification email subject.
• brandName (optional): Verification email brand name.
• message (optional): Verification email message.
• sessionTtlSeconds (optional): Session lifetime in seconds.
• codeTtlSeconds (optional): One-time-code lifetime in seconds.
• maxAttempts (optional): Maximum verification attempts per code.
• sessionCutoff (optional): Session invalidation cutoff.
• logoutRedirectPath (optional): Same-origin path returned after logout.
• publicDomain (optional): Primary public tunnel domain.
• publicDomains (optional): Additional public tunnel domains.
• forwardHeaders (optional): Additional forwarded request header patterns.
• gatePaths (optional): Additional path prefixes requiring authentication.
• insecure (optional): Run without an authentication gate.