Policy¶

{
  "$id": "https://open-metadata.org/schema/entity/policies/policy.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Policy",
  "description": "A Policy defines access control rules and governance policies for data assets.",
  "type": "object",
  "javaType": "org.openmetadata.schema.entity.policies.Policy",
  "javaInterfaces": [
    "org.openmetadata.schema.EntityInterface"
  ],
  "definitions": {
    "policyType": {
      "description": "Type of policy",
      "type": "string",
      "enum": [
        "AccessControl",
        "Lifecycle",
        "Masking",
        "Compliance",
        "Custom"
      ],
      "javaEnums": [
        {
          "name": "AccessControl"
        },
        {
          "name": "Lifecycle"
        },
        {
          "name": "Masking"
        },
        {
          "name": "Compliance"
        },
        {
          "name": "Custom"
        }
      ]
    },
    "effect": {
      "description": "Effect of the rule - Allow or Deny",
      "type": "string",
      "enum": [
        "allow",
        "deny"
      ]
    },
    "rule": {
      "type": "object",
      "description": "A rule within a policy",
      "properties": {
        "name": {
          "description": "Name of the rule",
          "type": "string"
        },
        "description": {
          "description": "Description of the rule",
          "type": "string"
        },
        "effect": {
          "$ref": "#/definitions/effect"
        },
        "operations": {
          "description": "Operations allowed or denied by this rule",
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "ViewBasic",
              "ViewAll",
              "ViewUsage",
              "ViewTests",
              "ViewQueries",
              "ViewDataProfile",
              "ViewSampleData",
              "EditAll",
              "EditDescription",
              "EditTags",
              "EditOwner",
              "EditTier",
              "EditCustomFields",
              "EditLineage",
              "EditReviewers",
              "Delete",
              "EditPolicy",
              "EditRole"
            ]
          }
        },
        "resources": {
          "description": "Resources to which this rule applies",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "condition": {
          "description": "Condition expression for the rule",
          "type": "string"
        }
      },
      "required": [
        "name",
        "effect",
        "operations"
      ],
      "additionalProperties": false
    }
  },
  "properties": {
    "id": {
      "description": "Unique identifier of the policy",
      "$ref": "../../type/basic.json#/definitions/uuid"
    },
    "name": {
      "description": "Name that identifies this policy",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "fullyQualifiedName": {
      "description": "Fully qualified name of the policy",
      "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
    },
    "displayName": {
      "description": "Display name for the policy",
      "type": "string"
    },
    "description": {
      "description": "Description of the policy",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "policyType": {
      "$ref": "#/definitions/policyType"
    },
    "policyUrl": {
      "description": "Link to the policy document",
      "$ref": "../../type/basic.json#/definitions/href"
    },
    "enabled": {
      "description": "Is the policy enabled",
      "type": "boolean",
      "default": true
    },
    "rules": {
      "description": "Set of rules that make up the policy",
      "type": "array",
      "items": {
        "$ref": "#/definitions/rule"
      }
    },
    "owner": {
      "description": "Owner of this policy",
      "$ref": "../../type/entityReference.json"
    },
    "location": {
      "description": "Reference to the location/team to which this policy belongs",
      "$ref": "../../type/entityReference.json"
    },
    "tags": {
      "description": "Tags for this policy",
      "type": "array",
      "items": {
        "$ref": "../../type/tagLabel.json"
      },
      "default": null
    },
    "version": {
      "description": "Metadata version of the entity",
      "$ref": "../../type/entityHistory.json#/definitions/entityVersion"
    },
    "updatedAt": {
      "description": "Last update time corresponding to the new version of the entity in Unix epoch time milliseconds",
      "$ref": "../../type/basic.json#/definitions/timestamp"
    },
    "updatedBy": {
      "description": "User who made the update",
      "type": "string"
    },
    "href": {
      "description": "Link to this policy resource",
      "$ref": "../../type/basic.json#/definitions/href"
    },
    "changeDescription": {
      "description": "Change that led to this version of the entity",
      "$ref": "../../type/entityHistory.json#/definitions/changeDescription"
    },
    "deleted": {
      "description": "When true indicates the entity has been soft deleted",
      "type": "boolean",
      "default": false
    },
    "domain": {
      "description": "Domain the policy belongs to",
      "$ref": "../../type/entityReference.json"
    }
  },
  "required": [
    "id",
    "name",
    "policyType"
  ],
  "additionalProperties": false
}

{
  "@context": {
    "@vocab": "https://open-metadata.org/schema/entity/policies/",
    "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
    "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
    "owl": "http://www.w3.org/2002/07/owl#",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcat": "http://www.w3.org/ns/dcat#",
    "dcterms": "http://purl.org/dc/terms/",
    "skos": "http://www.w3.org/2004/02/skos/core#",
    "prov": "http://www.w3.org/ns/prov#",
    "om": "https://open-metadata.org/schema/",

    "Policy": {
      "@id": "om:Policy",
      "@type": "@id"
    },
    "id": {
      "@id": "om:id",
      "@type": "xsd:string"
    },
    "name": {
      "@id": "om:name",
      "@type": "xsd:string"
    },
    "fullyQualifiedName": {
      "@id": "om:fullyQualifiedName",
      "@type": "xsd:string"
    },
    "displayName": {
      "@id": "om:displayName",
      "@type": "xsd:string"
    },
    "description": {
      "@id": "dcterms:description",
      "@type": "xsd:string"
    },
    "policyType": {
      "@id": "om:policyType",
      "@type": "@id"
    },
    "policyUrl": {
      "@id": "om:policyUrl",
      "@type": "xsd:anyURI"
    },
    "enabled": {
      "@id": "om:enabled",
      "@type": "xsd:boolean"
    },
    "rules": {
      "@id": "om:hasRule",
      "@type": "@id",
      "@container": "@set"
    },
    "owner": {
      "@id": "om:owner",
      "@type": "@id"
    },
    "tags": {
      "@id": "om:tags",
      "@type": "@id",
      "@container": "@set"
    },
    "domain": {
      "@id": "om:domain",
      "@type": "@id"
    },
    "appliesTo": {
      "@id": "om:appliesTo",
      "@type": "@id",
      "@container": "@set"
    },
    "affects": {
      "@id": "om:affects",
      "@type": "@id",
      "@container": "@set"
    },
    "triggersAlert": {
      "@id": "om:triggersAlert",
      "@type": "@id",
      "@container": "@set"
    },
    "version": {
      "@id": "om:version",
      "@type": "xsd:string"
    },
    "updatedAt": {
      "@id": "dcterms:modified",
      "@type": "xsd:dateTime"
    },
    "updatedBy": {
      "@id": "prov:wasAttributedTo",
      "@type": "xsd:string"
    },
    "href": {
      "@id": "om:href",
      "@type": "xsd:anyURI"
    }
  }
}