Box · Schema
Folder Lock
Folder locks define access restrictions placed by folder owners to prevent specific folders from being moved or deleted.
Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
Properties
| Name | Type | Description |
|---|---|---|
| folder | object | |
| id | string | The unique identifier for this folder lock. |
| type | string | The object type, always `folder_lock`. |
| created_by | object | |
| created_at | string | When the folder lock object was created. |
| locked_operations | object | The operations that have been locked. Currently the `move` and `delete` operations cannot be locked separately, and both need to be set to `true`. |
| lock_type | string | The lock type, always `freeze`. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/FolderLock",
"title": "Folder Lock",
"type": "object",
"x-box-resource-id": "folder_lock",
"x-box-tag": "folder_locks",
"description": "Folder locks define access restrictions placed by folder owners\nto prevent specific folders from being moved or deleted.",
"properties": {
"folder": {
"allOf": [
{
"$ref": "#/components/schemas/Folder--Mini"
},
{
"description": "The folder that the lock applies to."
}
]
},
"id": {
"type": "string",
"description": "The unique identifier for this folder lock.",
"example": "12345678"
},
"type": {
"type": "string",
"description": "The object type, always `folder_lock`.",
"example": "folder_lock"
},
"created_by": {
"allOf": [
{
"$ref": "#/components/schemas/User--Base"
},
{
"description": "The user or group that created the lock."
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2020-09-14T23:12:53Z",
"description": "When the folder lock object was created."
},
"locked_operations": {
"type": "object",
"description": "The operations that have been locked. Currently the `move`\nand `delete` operations cannot be locked separately, and both need to be\nset to `true`.\n",
"required": [
"move",
"delete"
],
"properties": {
"move": {
"type": "boolean",
"description": "Whether moving the folder is restricted.",
"nullable": false,
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether deleting the folder is restricted.",
"nullable": false,
"example": true
}
}
},
"lock_type": {
"type": "string",
"description": "The lock type, always `freeze`.",
"example": "freeze"
}
}
}