AuthRateLimitsConfig - Modelence

API Reference / modelence / server / AuthRateLimitsConfig

AuthRateLimitsConfig = object

Defined in: packages/modelence/src/app/authConfig.ts:73 Per-action rate limit overrides for authentication endpoints. Each bucket accepts an array of rules that are merged into the built-in defaults by (type, window) tuple:

A rule whose (type, window) matches a default replaces that default’s limit.
A rule whose (type, window) does not match any default is added as an extra rule for the bucket.
Defaults whose (type, window) is not overridden are kept.

This means you can tighten a single window without accidentally dropping the other built-in protections for that bucket.

Examples

import { startApp } from 'modelence/server';
import { time } from 'modelence';

startApp({
  auth: {
    rateLimits: {
      signup: [
        { type: 'ip', window: time.minutes(15), limit: 5 },
      ],
    },
  },
});

startApp({
  auth: {
    rateLimits: {
      signup: [
        { type: 'ip', window: time.minutes(1), limit: 2 },
      ],
    },
  },
});

Properties

Property	Type	Description	Defined in
`magicLink?`	`AuthRateLimitOverride`[]	Rate limits for magic link requests.	packages/modelence/src/app/authConfig.ts:85
`oneTimeCode?`	`AuthRateLimitOverride`[]	Rate limits for one-time code sign-in attempts.	packages/modelence/src/app/authConfig.ts:87
`passwordReset?`	`AuthRateLimitOverride`[]	Rate limits for password reset requests.	packages/modelence/src/app/authConfig.ts:83
`signin?`	`AuthRateLimitOverride`[]	Per-IP limits for login attempts.	packages/modelence/src/app/authConfig.ts:79
`signup?`	`AuthRateLimitOverride`[]	Per-IP limits for the signup endpoint (successful signups only).	packages/modelence/src/app/authConfig.ts:75
`signupAttempt?`	`AuthRateLimitOverride`[]	Per-IP limits for signup attempts (checked before duplicate detection).	packages/modelence/src/app/authConfig.ts:77
`verification?`	`AuthRateLimitOverride`[]	Per-user limits for email verification requests.	packages/modelence/src/app/authConfig.ts:81

⌘I