MfaPolicyRead

Fields

5 fields

lockout_duration_minutes · required

integer

lockout_enabled · required

boolean

lockout_threshold · required

integer

require_mfa · required

boolean

required_for_role

UserRole or null

Raw schema (JSON)

{
  "properties": {
    "lockout_duration_minutes": {
      "title": "Lockout Duration Minutes",
      "type": "integer"
    },
    "lockout_enabled": {
      "title": "Lockout Enabled",
      "type": "boolean"
    },
    "lockout_threshold": {
      "title": "Lockout Threshold",
      "type": "integer"
    },
    "require_mfa": {
      "title": "Require Mfa",
      "type": "boolean"
    },
    "required_for_role": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/UserRole"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "require_mfa",
    "lockout_enabled",
    "lockout_threshold",
    "lockout_duration_minutes"
  ],
  "title": "MfaPolicyRead",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

• GET /api/v1/settings/mfa-policy — Get Mfa Policy
• PUT /api/v1/settings/mfa-policy — Update Mfa Policy

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON