BaseIpFilterGroup

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/outsystems/main/json-schema/outsystems-base-ip-filter-group-schema.json",
  "title": "BaseIpFilterGroup",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/outsystems-ip-filters-api-openapi.yml#/components/schemas/BaseIpFilterGroup",
  "type": "object",
  "properties": {
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The name of the IP filter group."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "The description of the IP filter group."
    },
    "accessType": {
      "allOf": [
        {
          "$ref": "#/$defs/IpFilterGroupAccessType"
        }
      ],
      "description": "The default access type of the IP filter group, after all rules are applied."
    },
    "ipRules": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/IpFilterGroupRule"
      },
      "description": "The list of IP filter rules associated with this group."
    },
    "appKeys": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      },
      "description": "The list of all app keys that are explicitly assigned to this group."
    }
  },
  "additionalProperties": false,
  "$defs": {
    "IpFilterGroupAccessType": {
      "enum": [
        "DENYLIST",
        "ALLOWLIST"
      ],
      "type": "string"
    },
    "IpFilterGroupRule": {
      "type": "object",
      "properties": {
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the IP rule."
        },
        "ranges": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          },
          "description": "The list of the IP ranges (e.g: 0.0.0.0-0.0.0.3)."
        },
        "isActive": {
          "type": "boolean",
          "description": "Indicates if the IP rule is currently active."
        }
      },
      "additionalProperties": false
    }
  }
}