Classification Template

API version 2024.0 A metadata template that holds the security classifications defined by an enterprise.

string

example: 58063d82-4128-7b43-bba9-92f706befcdfThe ID of the classification template.

type

string

example: metadata_templateThe value will always be metadata_template.Value is always metadata_template

copyInstanceOnItemCopy

boolean

example: trueDetermines if classifications are copied along when the file or folder is copied.

displayName

string

example: ClassificationThe name of this template as shown in web and mobile interfaces.Value is always Classification

fields

object[]

A list of fields for this classification template. This includes only one field, the Box__Security__Classification__Key, which defines the different classifications available in this enterprise.

Show child attributes

string

example: 822227e0-47a5-921b-88a8-494760b2e6d2The unique ID of the field.

type

string

example: enumThe array item type.Value is always enum

displayName

string

example: ClassificationThe value will always be Classification.Value is always Classification

hidden

boolean

example: falseClassifications are always visible to web and mobile users.

key

string

example: Box__Security__Classification__KeyDefines classifications available in the enterprise.Value is always Box__Security__Classification__Key

options

object[]

A list of classifications available in this enterprise.

Show child attributes

string

example: 46aea176-3483-4431-856c-6b5b13d1cc50The unique ID of this classification.

key

string

example: SensitiveThe display name and key for this classification.

staticConfig

object

Additional information about the classification.

Show child attributes

classification

object

Additional information about the classification.This is not an exclusive list of properties, and more object fields might be returned. These fields are used for internal Box Shield and Box Governance purposes and no additional value must be derived from these fields.

hidden

boolean

example: falseDetermines if the template is always available in web and mobile interfaces.

scope

string

example: enterprise_123456The scope of the classification template. This is in the format enterprise_{id} where the id is the enterprise ID.

templateKey

string

example: securityClassification-6VMVochwUWoThe value will always be securityClassification-6VMVochwUWo.Value is always securityClassification-6VMVochwUWo

{
  "id": "58063d82-4128-7b43-bba9-92f706befcdf",
  "type": "metadata_template",
  "copyInstanceOnItemCopy": true,
  "displayName": "Classification",
  "fields": [
    {
      "displayName": "Classification",
      "hidden": false,
      "id": "822227e0-47a5-921b-88a8-494760b2e6d2",
      "key": "Box__Security__Classification__Key",
      "options": [
        {
          "id": "46aea176-3483-4431-856c-6b5b13d1cc50",
          "key": "Sensitive",
          "staticConfig": {
            "classification": {
              "classificationDefinition": "Sensitive information",
              "colorID": 4
            }
          }
        }
      ],
      "type": "enum"
    }
  ],
  "hidden": false,
  "scope": "enterprise_123456",
  "templateKey": "securityClassification-6VMVochwUWo"
}