Update classification

curl --request PUT \
  --url 'https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
[
  {
    "op": "editEnumOption",
    "fieldKey": "Box__Security__Classification__Key",
    "enumOptionKey": "Sensitive",
    "data": {
      "key": "Very Sensitive",
      "staticConfig": {
        "classification": {
          "classificationDefinition": "Sensitive information that must not be shared.",
          "colorID": 4
        }
      }
    }
  }
]
'

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

PUT

metadata_templates

enterprise

securityClassification-6VMVochwUWo

schema#update

Update classification

curl --request PUT \
  --url 'https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
[
  {
    "op": "editEnumOption",
    "fieldKey": "Box__Security__Classification__Key",
    "enumOptionKey": "Sensitive",
    "data": {
      "key": "Very Sensitive",
      "staticConfig": {
        "classification": {
          "classificationDefinition": "Sensitive information that must not be shared.",
          "colorID": 4
        }
      }
    }
  }
]
'

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

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json-patch+json

enum<string>

required

The type of change to perform on the classification object.

Available options:

editEnumOption

Example:

"editEnumOption"

fieldKey

enum<string>

required

Defines classifications available in the enterprise.

Available options:

Box__Security__Classification__Key

Example:

"Box__Security__Classification__Key"

enumOptionKey

string

required

The original label of the classification to change.

Example:

"Sensitive"

data

object

required

The details of the updated classification.

Show child attributes

data.key

string

required

A new label for the classification, as it will be shown in the web and mobile interfaces.

Example:

"Very Sensitive"

data.staticConfig

object

A static configuration for the classification.

Show child attributes

data.staticConfig.classification

object

Additional details for the classification.

Show child attributes

data.staticConfig.classification.classificationDefinition

string

A longer description of the classification.

Example:

"Sensitive information that must not be shared."

data.staticConfig.classification.colorID

integer<int64>

An internal Box identifier used to assign a color to a classification label.

Mapping between a colorID and a color may change without notice. Currently, the color mappings are as follows.

0: Yellow.
1: Orange.
2: Watermelon red.
3: Purple rain.
4: Light blue.
5: Dark blue.
6: Light green.
7: Gray.

Example:

4

Response

Returns the updated securityClassification metadata template, which contains a Box__Security__Classification__Key field that lists all the classifications available to this enterprise.

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

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

Show child attributes

fields.id

string

required

The unique ID of the field.

Example:

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

fields.type

enum<string>

required

The array item type.

Available options:

enum

Example:

"enum"

fields.key

enum<string>

required

Defines classifications available in the enterprise.

Available options:

Box__Security__Classification__Key

Example:

"Box__Security__Classification__Key"

fields.displayName

enum<string>

required

The value will always be Classification.

Available options:

Classification

Example:

"Classification"

fields.options

object[]

required

A list of classifications available in this enterprise.

Minimum array length: 1

Show child attributes

fields.options.id

string

required

The unique ID of this classification.

Example:

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

fields.options.key

string

required

The display name and key for this classification.

Example:

"Sensitive"

fields.options.staticConfig

object

Additional information about the classification.

Show child attributes

fields.options.staticConfig.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.

Show child attributes

fields.options.staticConfig.classification.classificationDefinition

string

A longer description of the classification.

Example:

"Sensitive information"

fields.options.staticConfig.classification.colorID

integer<int64>

An internal Box identifier used to assign a color to a classification label.

Mapping between a colorID and a color may change without notice. Currently, the color mappings are as follows.

0: Yellow.
1: Orange.
2: Watermelon red.
3: Purple rain.
4: Light blue.
5: Dark blue.
6: Light green.
7: Gray.

Example:

4

fields.hidden

boolean

Classifications are always visible to web and mobile users.

Example:

false

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

List all classifications

Add classification to file

⌘I