MfaPolicyUpdate

Fields

6 fields

clear_required_for_role

boolean

lockout_duration_minutes

integer or null

lockout_enabled

boolean or null

lockout_threshold

integer or null

require_mfa

boolean or null

required_for_role

UserRole or null

Raw schema (JSON)

{
  "properties": {
    "clear_required_for_role": {
      "default": false,
      "title": "Clear Required For Role",
      "type": "boolean"
    },
    "lockout_duration_minutes": {
      "anyOf": [
        {
          "maximum": 1440,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Lockout Duration Minutes"
    },
    "lockout_enabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Lockout Enabled"
    },
    "lockout_threshold": {
      "anyOf": [
        {
          "maximum": 100,
          "minimum": 3,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Lockout Threshold"
    },
    "require_mfa": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Require Mfa"
    },
    "required_for_role": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/UserRole"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "title": "MfaPolicyUpdate",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

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

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON