Interface: AuthGateApi
The handlers the gate middleware calls in-process (returned by AuthGatePlugin.exports).
Properties
Section titled “Properties”passkeysEnabled
Section titled “passkeysEnabled”
readonlypasskeysEnabled:boolean
Whether the runtime exposes passkey enrollment and authentication.
Methods
Section titled “Methods”close()
Section titled “close()”close():
Promise<void>
Close auth storage owned by this runtime.
Returns
Section titled “Returns”Promise<void>
handler()
Section titled “handler()”handler(
request):Promise<Response>
Better Auth and compatibility routes under /api/email/auth/*.
Parameters
Section titled “Parameters”request
Section titled “request”Request
Returns
Section titled “Returns”Promise<Response>
session()
Section titled “session()”session(
headers):Promise<string|undefined>
Resolve the authorized email for request headers, or undefined.
Parameters
Section titled “Parameters”headers
Section titled “headers”Headers
Returns
Section titled “Returns”Promise<string | undefined>
status()
Section titled “status()”status(
headers):Promise<{authenticated:boolean;email?:string;enabled:boolean;passkeysEnabled?:boolean; }>
The gate status payload.
Parameters
Section titled “Parameters”headers
Section titled “headers”Headers
Returns
Section titled “Returns”Promise<{ authenticated: boolean; email?: string; enabled: boolean; passkeysEnabled?: boolean; }>