Classification Template

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ClassificationTemplate",
  "title": "Classification Template",
  "type": "object",
  "x-box-resource-id": "classification_template",
  "x-box-tag": "classifications",
  "description": "A metadata template that holds the security classifications\ndefined by an enterprise.",
  "required": [
    "id",
    "type",
    "scope",
    "displayName",
    "fields",
    "templateKey"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "58063d82-4128-7b43-bba9-92f706befcdf",
      "description": "The ID of the classification template."
    },
    "type": {
      "type": "string",
      "description": "`metadata_template`",
      "example": "metadata_template",
      "enum": [
        "metadata_template"
      ],
      "nullable": false
    },
    "scope": {
      "type": "string",
      "description": "The scope of the classification template. This is in the format\n`enterprise_{id}` where the `id` is the enterprise ID.",
      "example": "enterprise_123456"
    },
    "templateKey": {
      "type": "string",
      "example": "securityClassification-6VMVochwUWo",
      "description": "`securityClassification-6VMVochwUWo`",
      "enum": [
        "securityClassification-6VMVochwUWo"
      ]
    },
    "displayName": {
      "type": "string",
      "example": "Classification",
      "description": "The name of this template as shown in web and mobile interfaces.",
      "enum": [
        "Classification"
      ]
    },
    "hidden": {
      "type": "boolean",
      "example": false,
      "description": "Determines if the\ntemplate is always available in web and mobile interfaces."
    },
    "copyInstanceOnItemCopy": {
      "type": "boolean",
      "example": true,
      "description": "Determines if \nclassifications are\ncopied along when the file or folder is\ncopied."
    },
    "fields": {
      "type": "array",
      "maxItems": 1,
      "minItems": 1,
      "description": "A list of fields for this classification template. This includes\nonly one field, the `Box__Security__Classification__Key`, which defines\nthe different classifications available in this enterprise.",
      "items": {
        "type": "object",
        "required": [
          "id",
          "type",
          "key",
          "displayName",
          "options"
        ],
        "description": "The metadata template field that represents the available\nclassifications.",
        "properties": {
          "id": {
            "type": "string",
            "example": "822227e0-47a5-921b-88a8-494760b2e6d2",
            "description": "The unique ID of the field."
          },
          "type": {
            "type": "string",
            "example": "enum",
            "description": "The array item type.",
            "enum": [
              "enum"
            ]
          },
          "key": {
            "type": "string",
            "example": "Box__Security__Classification__Key",
            "description": "Defines classifications \navailable in the enterprise.",
            "enum": [
              "Box__Security__Classification__Key"
            ]
          },
          "displayName": {
            "type": "string",
            "example": "Classification",
            "description": "`Classification`",
            "enum": [
              "Classification"
            ]
          },
          "hidden": {
            "type": "boolean",
            "example": false,
            "description": "Classifications are always visible to web and mobile users."
          },
          "options": {
            "type": "array",
            "description": "A list of classifications available in this enterprise.",
            "minItems": 1,
            "items": {
              "required": [
                "key",
                "id"
              ],
              "type": "object",
              "description": "A single classification available in this enterprise.",
              "properties": {
                "id": {
                  "type": "string",
                  "example": "46aea176-3483-4431-856c-6b5b13d1cc50",
                  "description": "The unique ID of this classification."
                },
                "key": {
                  "type": "string",
                  "example": "Sensitive",
                  "description": "The display name and key for this classification."
                },
                "staticConfig": {
                  "type": "object",
                  "description": "Additional information about the classification.",
                  "properties": {
                    "classification": {
                      "type": "object",
                      "description": "Additional information about the classification.\n\nThis is not an exclusive list of properties, and\nmore object fields might be returned. These fields\nare used for internal Box Shield and Box Governance\npurposes and no additional value must be derived from\nthese fields.",
                      "properties": {
                        "classificationDefinition": {
                          "type": "string",
                          "example": "Sensitive information",
                          "description": "A longer description of the classification."
                        },
                        "colorID": {
                          "type": "integer",
                          "format": "int64",
                          "example": 4,
                          "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}