Skip to content
dbx tools

Variable: AuthGateConfigSchema

const AuthGateConfigSchema: ZodObject<{ allow: ZodOptional<ZodUnion<readonly [ZodString, ZodArray<ZodString>]>>; brandName: ZodOptional<ZodString>; codeTtlSeconds: ZodOptional<ZodCoercedNumber<number>>; forwardHeaders: ZodOptional<ZodUnion<readonly [ZodString, ZodArray<ZodString>]>>; gatePaths: ZodOptional<ZodUnion<readonly [ZodString, ZodArray<ZodString>]>>; insecure: ZodOptional<ZodBoolean>; logoutRedirectPath: ZodOptional<ZodString>; maxAttempts: ZodOptional<ZodCoercedNumber<number>>; message: ZodOptional<ZodString>; publicDomain: ZodOptional<ZodString>; publicDomains: ZodOptional<ZodUnion<readonly [ZodString, ZodArray<ZodString>]>>; sessionCutoff: ZodOptional<ZodUnion<readonly [ZodString, ZodNumber, ZodDate]>>; sessionTtlSeconds: ZodOptional<ZodCoercedNumber<number>>; sqlitePath: ZodOptional<ZodString>; storage: ZodOptional<ZodEnum<{ auto: "auto"; lakebase: "lakebase"; sqlite: "sqlite"; }>>; subject: ZodOptional<ZodString>; }, $strict>

AuthGateConfig fields

Section titled “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.