password.generate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/programmes-net/json-schema/programmes-net-password-generate-schema.json",
  "title": "password.generate",
  "description": "Generate a cryptographically random password.",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/programmes-net-openapi.json#/components/schemas/password.generate",
  "type": "object",
  "properties": {
    "operation": {
      "const": "generate"
    },
    "input": {
      "type": "string",
      "description": "Unused (pass an empty string).",
      "maxLength": 32768
    },
    "options": {
      "type": "object",
      "properties": {
        "length": {
          "type": "integer",
          "description": "Password length.",
          "minimum": 1,
          "maximum": 1024,
          "default": 16
        },
        "uppercase": {
          "type": "boolean",
          "description": "Include A-Z.",
          "default": true
        },
        "lowercase": {
          "type": "boolean",
          "description": "Include a-z.",
          "default": true
        },
        "numbers": {
          "type": "boolean",
          "description": "Include 0-9.",
          "default": true
        },
        "symbols": {
          "type": "boolean",
          "description": "Include symbols.",
          "default": true
        },
        "excludeSimilar": {
          "type": "boolean",
          "description": "Exclude similar characters (il1Lo0O).",
          "default": false
        },
        "excludeAmbiguous": {
          "type": "boolean",
          "description": "Exclude ambiguous symbols ({}[]()/\\'\"`~,;:.<>).",
          "default": false
        },
        "customSymbols": {
          "type": "string",
          "description": "Symbols to use instead of the default set.",
          "maxLength": 100
        }
      }
    }
  },
  "required": [
    "operation"
  ]
}