Skip to main content

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

id
string
required

The ID of the classification template.

Example:

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

type
enum<string>
required

The value will always be metadata_template.

Available options:
metadata_template
Example:

"metadata_template"

scope
string
required

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

Example:

"enterprise_123456"

templateKey
enum<string>
required

The value will always be securityClassification-6VMVochwUWo.

Available options:
securityClassification-6VMVochwUWo
Example:

"securityClassification-6VMVochwUWo"

displayName
enum<string>
required

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

Available options:
Classification
Example:

"Classification"

fields
object[]
required

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.

Required array length: 1 element
hidden
boolean

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

Example:

false

copyInstanceOnItemCopy
boolean

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

Example:

true