JFrog · Schema

Policy

ArtifactoryCI/CDContainer RegistryDevOpsMLOpsPackage ManagementSecuritySoftware Supply Chain

Properties

Name Type Description
name string
description string
type string
rules array
View JSON Schema on GitHub

JSON Schema

jfrog-policy-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Policy",
  "title": "Policy",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "enum": [
        "security",
        "license",
        "operational_risk"
      ]
    },
    "rules": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "priority": {
            "type": "integer"
          },
          "criteria": {
            "type": "object",
            "properties": {
              "min_severity": {
                "type": "string",
                "enum": [
                  "Low",
                  "Medium",
                  "High",
                  "Critical"
                ]
              },
              "cvss_range": {
                "type": "object",
                "properties": {
                  "from": {
                    "type": "number"
                  },
                  "to": {
                    "type": "number"
                  }
                }
              },
              "allow_unknown": {
                "type": "boolean"
              },
              "banned_licenses": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "allowed_licenses": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          },
          "actions": {
            "type": "object",
            "properties": {
              "webhooks": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "mails": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "block_download": {
                "type": "object",
                "properties": {
                  "unscanned": {
                    "type": "boolean"
                  },
                  "active": {
                    "type": "boolean"
                  }
                }
              },
              "block_release_bundle_distribution": {
                "type": "boolean"
              },
              "fail_build": {
                "type": "boolean"
              },
              "notify_deployer": {
                "type": "boolean"
              },
              "notify_watch_recipients": {
                "type": "boolean"
              },
              "create_ticket_enabled": {
                "type": "boolean"
              }
            }
          }
        }
      }
    }
  },
  "required": [
    "name",
    "type",
    "rules"
  ]
}