ZITADEL Docs
APIsCore ResourcesV2Settings

GetLockoutSettings

Get Lockout Settings

Get the lockout settings for the requested context. This can be the instance or an organization. In case of an organization, the returned settings will fall back to the instance settings if not explicitly set on the organization.

Lockout settings define how many failed attempts are allowed before a user is locked out.

Required permissions:

  • policy.read
GET
/v2/settings/lockout

Query Parameters

ctx.orgId?string
ctx.instance?boolean

Response Body

application/json

application/json

curl -X GET "https://loading/v2/settings/lockout"
{
  "details": {
    "sequence": 0,
    "changeDate": "1s",
    "resourceOwner": "string",
    "creationDate": "1s"
  },
  "settings": {
    "maxPasswordAttempts": 0,
    "resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED",
    "maxOtpAttempts": 0
  }
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?