Skip to content

config properties rate_limiter

GitHub Action edited this page Oct 15, 2024 · 4 revisions

Version

v1.1.0

rate_limiter Type

object (rate_limiter)

rate_limiter Properties

Property Type Required Nullable Defined by
enabled boolean Optional cannot be null Config
store string Optional cannot be null Config
redis_config object Optional cannot be null Config
passcode_limits object Optional cannot be null Config
password_limits object Optional cannot be null Config
token_limits object Optional cannot be null Config

enabled

enabled controls whether rate limiting is enabled or disabled.

enabled

  • is optional

  • cannot be null

enabled Type

boolean

enabled Default Value

The default value is:

true

store

store sets the store for the rate limiter. When you have multiple instances of Hanko running, it is recommended to use the redis store because otherwise your instances each have their own states.

store

  • is optional

  • cannot be null

store Type

string

store Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"in_memory"
"redis"

store Default Value

The default value is:

"in_memory"

redis_config

redis_config configures connection to a redis instance. Required if store is set to redis

redis_config

  • is optional

  • cannot be null

redis_config Type

object (Details)

passcode_limits

passcode_limits controls rate limits for passcode operations.

passcode_limits

  • is optional

  • cannot be null

passcode_limits Type

object (Details)

password_limits

password_limits controls rate limits for password login operations.

password_limits

  • is optional

  • cannot be null

password_limits Type

object (Details)

token_limits

token_limits controls rate limits for token exchange operations.

token_limits

  • is optional

  • cannot be null

token_limits Type

object (Details)

Clone this wiki locally