How to configure Account Lockout Policy
The Account Lockout Policy allows you to define the maximum number of failed attempts a user can complete before blocking the access, for a predefined period. During this period, the user can’t attempt to log in again, preventing unauthorized access.
This guide walks you through configuring the Account Lockout Policy.
Go to Account Lockout Policy referenceConfiguring an account lockout policy
- Run the following
GET
request in your terminal to obtain the current status of the Account Lockout Policy in your account.- By default, it’s inactive.
- You’ll receive a response similar to this:
- Run the following
PUT
request in your terminal to update the status of the Account Lockout Policy in your account.
Where:
Key | Type | Description |
---|---|---|
active | Boolean | Defines the status of the policy. Accepted values: true and false . Default value: false |
max_attempts | Integer | Defines the maximum number of failed attempts before lockout. Default value: 3 |
blocking_period | Integer | Defines the time a user account remains locked after reaching the maximum number of failed login attempts. During this period, the user can’t attempt to log in again, preventing unauthorized access. Default value: 1440 , equivalent to 24 hours in minutes |
- You’ll receive a response similar to this:
Done. Account Lockout Policy is now active in your account. Now, users will be blocked if exceeding the maximum allowed number of failed login attempt, for the defined period.