Skip to main content
GET
/
files
/
{file_id}
/
metadata
/
enterprise
/
securityClassification-6VMVochwUWo
cURL
curl -i -X GET "https://api.box.com/2.0/files/12345/metadata/enterprise/securityClassification-6VMVochwUWo" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "Box__Security__Classification__Key": "Sensitive",
  "$parent": "folder_59449484661,",
  "$template": "securityClassification-6VMVochwUWo",
  "$scope": "enterprise_27335",
  "$version": 1,
  "$type": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
  "$typeVersion": 5,
  "$canEdit": 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.

Path Parameters

​
file_id
string
required

The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Response

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

An instance of the classification metadata template, containing the classification applied to the file or folder.

To get more details about the classification applied to an item, request the classification metadata template.

​
Box__Security__Classification__Key
string

The name of the classification applied to the item.

Example:

"Sensitive"

​
$parent
string

The identifier of the item that this metadata instance has been attached to. This combines the type and the id of the parent in the form {type}_{id}.

Example:

"folder_59449484661,"

​
$template
enum<string>

The value will always be securityClassification-6VMVochwUWo.

Available options:
securityClassification-6VMVochwUWo
Example:

"securityClassification-6VMVochwUWo"

​
$scope
string

The scope of the enterprise that this classification has been applied for.

This will be in the format enterprise_{enterprise_id}.

Example:

"enterprise_27335"

​
$version
integer

The version of the metadata instance. This version starts at 0 and increases every time a classification is updated.

Example:

1

​
$type
string

The unique ID of this classification instance. This will be include the name of the classification template and a unique ID.

Example:

"securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8"

​
$typeVersion
number

The version of the metadata template. This version starts at 0 and increases every time the template is updated. This is mostly for internal use.

Example:

5

​
$canEdit
boolean

Whether an end user can change the classification.

Example:

true