Box Developer Documentation
Log in

Join BoxWorks 2024 to discover what's possible with content and AI!

Register now!

Classification Template

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

string
58063d82-4128-7b43-bba9-92f706befcdf

The ID of the classification template.

string
metadata_template

metadata_template

Value is always metadata_template

boolean
true

Determines if classifications are copied along when the file or folder is copied.

string
Classification

The name of this template as shown in web and mobile interfaces.

Value is always Classification

object array

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.

string
822227e0-47a5-921b-88a8-494760b2e6d2

The unique ID of the field.

string
enum

The array item type.

Value is always enum

string
Classification

Classification

Value is always Classification

boolean
false

Classifications are always visible to web and mobile users.

string
Box__Security__Classification__Key

Defines classifications available in the enterprise.

Value is always Box__Security__Classification__Key

object array

A list of classifications available in this enterprise.

string
46aea176-3483-4431-856c-6b5b13d1cc50

The unique ID of this classification.

string
Sensitive

The display name and key for this classification.

object

Additional information about the 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.

boolean
false

Determines if the template is always available in web and mobile interfaces.

string
enterprise_123456

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

string
securityClassification-6VMVochwUWo

securityClassification-6VMVochwUWo

Value is always securityClassification-6VMVochwUWo

Response Example

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