---
title: "Create lockout policy"
method: POST
path: "/resources/configurations/v1/lockout-policy"
tags: ["Lockout policy"]
---

# Create lockout policy

`POST /resources/configurations/v1/lockout-policy`

## Request

- Base URL: `http://localhost:8181`
- URL: `http://localhost:8181/resources/configurations/v1/lockout-policy`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/docs/resources/configurations/v1/lockout-policy/post.ts> (a function with typed inputs; its response is checked against the schema)

This route creates a lockout policy for all tenants. To create a lockout policy for a specific tenant, send the tenant’s ID in the **`frontegg-tenant-id`** header. To enable the Lockout Policy, make sure to set the enabled variable to true and the maximum attempts to a number of your preference.

## Headers

- `frontegg-tenant-id` string

## Request body

- LockoutPolicyRequest
  - `enabled` boolean, required: Determine whether the Lockout Policy is enabled
  - `maxAttempts` number, required: The number of the maximum login attempts user can do

## Response `201`

- LockoutPolicyResponse
  - `id` string, required
  - `enabled` boolean, required
  - `maxAttempts` number, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

## Other responses

- `409`: Lockout Policy already exists

---

[API](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp.md) - [All operations](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/llms.txt) - [OpenAPI document](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/revisions/c496ae9e1c3e?raw)