PasswordRequirementModel

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/delinea/main/json-schema/delinea-password-requirement-model-schema.json",
  "title": "PasswordRequirementModel",
  "description": "Password Requirement Model",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/delinea-passwordrequirements-api-openapi.yml#/components/schemas/PasswordRequirementModel",
  "properties": {
    "allowedCharacterSet": {
      "$ref": "#/$defs/CharacterSetSummary"
    },
    "description": {
      "description": "Description",
      "type": "string"
    },
    "isDefault": {
      "description": "Is Default",
      "type": "boolean"
    },
    "maxPasswordLength": {
      "description": "Maximum Password Length",
      "type": "integer",
      "format": "int32"
    },
    "minPasswordLength": {
      "description": "Minimum Password Length",
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "description": "Name",
      "type": "string"
    },
    "passwordDictionaries": {
      "description": "Password Dictionaries",
      "items": {
        "$ref": "#/$defs/PasswordDictionarySummary"
      },
      "type": "array"
    },
    "passwordRequirementId": {
      "description": "Password Requirement Id",
      "type": "integer",
      "format": "int32"
    },
    "passwordRequirementRules": {
      "description": "Password Requirement Rules",
      "items": {
        "$ref": "#/$defs/PasswordRequirementRuleSummary"
      },
      "type": "array"
    },
    "preventDictionaryWords": {
      "description": "Prevent Dictionary Words",
      "type": "boolean"
    },
    "preventSequentialPattern": {
      "description": "Prevent Sequential Pattern",
      "type": "boolean"
    },
    "preventSpatialPattern": {
      "description": "Prevent Spacial Pattern",
      "type": "boolean"
    },
    "preventUsername": {
      "description": "Prevent Username",
      "type": "boolean"
    },
    "secretUsage": {
      "description": "A count of secrets using the requirement",
      "type": "integer",
      "format": "int32"
    },
    "typeUsage": {
      "description": "A list of secret templates using the password requirement",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object",
  "$defs": {
    "CharacterSetSummary": {
      "description": "Character Set that is used in password requirements",
      "properties": {
        "abbreviation": {
          "description": "Abbreviated view of the character set",
          "type": "string"
        },
        "active": {
          "description": "Is this character set active",
          "type": "boolean"
        },
        "characterSetId": {
          "description": "Sequence ID for character set",
          "type": "integer",
          "format": "int32"
        },
        "description": {
          "description": "Description",
          "type": "string"
        },
        "isStandard": {
          "description": "Is this a standard character set",
          "type": "boolean"
        },
        "name": {
          "description": "Name",
          "type": "string"
        },
        "value": {
          "description": "The actual characters in the character set",
          "type": "string"
        }
      },
      "type": "object"
    },
    "PasswordDictionarySummary": {
      "description": "Password Dictionary Summary",
      "properties": {
        "name": {
          "description": "Password Dictionary Name",
          "type": "string"
        },
        "passwordDictionaryId": {
          "description": "Password Dictionary Id",
          "type": "integer",
          "format": "int32"
        }
      },
      "type": "object"
    },
    "PasswordRequirementRuleSummary": {
      "description": "Password Requirement Rule Summary",
      "properties": {
        "characterSet": {
          "$ref": "#/$defs/CharacterSetSummary"
        },
        "minCharactersRequired": {
          "description": "Minimum Characters Required",
          "type": "integer",
          "format": "int32"
        },
        "passwordRequirementId": {
          "description": "Password Requirement Id",
          "type": "integer",
          "format": "int32"
        },
        "passwordRequirementRuleId": {
          "description": "Password Requirement Rule Id",
          "type": "integer",
          "format": "int32"
        },
        "passwordRequirementType": {
          "$ref": "#/$defs/PasswordRequirementType"
        }
      },
      "type": "object"
    },
    "PasswordRequirementType": {
      "description": "Password Requirement Type",
      "properties": {},
      "type": "string",
      "enum": [
        "MinimumOf",
        "StartsWith",
        "EndsWith",
        "MaxConsecutive",
        "Repeating",
        "RepeatingConsecutive"
      ]
    }
  }
}