Box

{
  "type": "object",
  "title": "Access token",
  "x-box-tag": "authorization",
  "properties": {
    "expires_in": {
      "type": "integer",
      "format": "int64",
      "example": 3600,
      "description": "The time in seconds by which this token will expire."
    },
    "token_type": {
      "enum": [
        "bearer"
      ],
      "type": "string",
      "example": "bearer",
      "description": "The type of access token returned."
    },
    "access_token": {
      "type": "string",
      "format": "token",
      "example": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ",
      "description": "The requested access token."
    },
    "refresh_token": {
      "type": "string",
      "format": "token",
      "example": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ",
      "description": "The refresh token for this access token, which can be used\nto request a new access token when the current one expires."
    },
    "restricted_to": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FileOrFolderScope"
      },
      "description": "The permissions that this access token permits,\nproviding a list of resources (files, folders, etc)\nand the scopes permitted for each of those resources."
    },
    "issued_token_type": {
      "enum": [
        "urn:ietf:params:oauth:token-type:access_token"
      ],
      "type": "string",
      "format": "urn",
      "example": "urn:ietf:params:oauth:token-type:access_token",
      "description": "The type of downscoped access token returned. This is only\nreturned if an access token has been downscoped."
    }
  },
  "description": "A token that can be used to make authenticated API calls.",
  "x-box-resource-id": "access_token"
}

{
  "type": "object",
  "title": "Classification",
  "x-box-tag": "classifications",
  "properties": {
    "$type": {
      "type": "string",
      "example": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
      "description": "The unique ID of this classification instance. This will be include\nthe name of the classification template and a unique ID."
    },
    "$scope": {
      "type": "string",
      "example": "enterprise_27335",
      "description": "The scope of the enterprise that this classification has been\napplied for.\n\nThis will be in the format `enterprise_{enterprise_id}`."
    },
    "$parent": {
      "type": "string",
      "example": "folder_59449484661,",
      "description": "The identifier of the item that this metadata instance\nhas been attached to. This combines the `type` and the `id`\nof the parent in the form `{type}_{id}`."
    },
    "$canEdit": {
      "type": "boolean",
      "example": true,
      "description": "Whether an end user can change the classification."
    },
    "$version": {
      "type": "integer",
      "example": 1,
      "description": "The version of the metadata instance. This version starts at 0 and\nincreases every time a classification is updated."
    },
    "$template": {
      "enum": [
        "securityClassification-6VMVochwUWo"
      ],
      "type": "string",
      "example": "securityClassification-6VMVochwUWo",
      "description": "`securityClassification-6VMVochwUWo`"
    },
    "$typeVersion": {
      "type": "number",
      "example": 5,
      "description": "The version of the metadata template. This version starts at 0 and\nincreases every time the template is updated. This is mostly for internal\nuse."
    },
    "Box__Security__Classification__Key": {
      "type": "string",
      "example": "Sensitive",
      "description": "The name of the classification applied to the item."
    }
  },
  "description": "An instance of the classification metadata template, containing\nthe classification applied to the file or folder.\n\nTo get more details about the classification applied to an item,\nrequest the classification metadata template.",
  "x-box-resource-id": "classification"
}

{
  "type": "object",
  "title": "Classification Template",
  "required": [
    "id",
    "type",
    "scope",
    "displayName",
    "fields",
    "templateKey"
  ],
  "x-box-tag": "classifications",
  "properties": {
    "id": {
      "type": "string",
      "example": "58063d82-4128-7b43-bba9-92f706befcdf",
      "description": "The ID of the classification template."
    },
    "type": {
      "enum": [
        "metadata_template"
      ],
      "type": "string",
      "example": "metadata_template",
      "nullable": false,
      "description": "`metadata_template`"
    },
    "scope": {
      "type": "string",
      "example": "enterprise_123456",
      "description": "The scope of the classification template. This is in the format\n`enterprise_{id}` where the `id` is the enterprise ID."
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "type",
          "key",
          "displayName",
          "options"
        ],
        "properties": {
          "id": {
            "type": "string",
            "example": "822227e0-47a5-921b-88a8-494760b2e6d2",
            "description": "The unique ID of the field."
          },
          "key": {
            "enum": [
              "Box__Security__Classification__Key"
            ],
            "type": "string",
            "example": "Box__Security__Classification__Key",
            "description": "Defines classifications \navailable in the enterprise."
          },
          "type": {
            "enum": [
              "enum"
            ],
            "type": "string",
            "example": "enum",
            "description": "The array item type."
          },
          "hidden": {
            "type": "boolean",
            "example": false,
            "description": "Classifications are always visible to web and mobile users."
          },
          "options": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "key",
                "id"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "example": "46aea176-3483-4431-856c-6b5b13d1cc50",
                  "description": "The unique ID of this classification."
                },
                "key": {
                  "type": "string",
                  "example": "Sensitive",
                  "description": "The display name and key for this classification."
                },
                "staticConfig": {
                  "type": "object",
                  "properties": {
                    "classification": {
                      "type": "object",
                      "properties": {
                        "colorID": {
                          "type": "integer",
                          "format": "int64",
                          "example": 4,
                          "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray"
                        },
                        "classificationDefinition": {
                          "type": "string",
                          "example": "Sensitive information",
                          "description": "A longer description of the classification."
                        }
                      },
                      "description": "Additional information about the classification.\n\nThis is not an exclusive list of properties, and\nmore object fields might be returned. These fields\nare used for internal Box Shield and Box Governance\npurposes and no additional value must be derived from\nthese fields."
                    }
                  },
                  "description": "Additional information about the classification."
                }
              },
              "description": "A single classification available in this enterprise."
            },
            "minItems": 1,
            "description": "A list of classifications available in this enterprise."
          },
          "displayName": {
            "enum": [
              "Classification"
            ],
            "type": "string",
            "example": "Classification",
            "description": "`Classification`"
          }
        },
        "description": "The metadata template field that represents the available\nclassifications."
      },
      "maxItems": 1,
      "minItems": 1,
      "description": "A list of fields for this classification template. This includes\nonly one field, the `Box__Security__Classification__Key`, which defines\nthe different classifications available in this enterprise."
    },
    "hidden": {
      "type": "boolean",
      "example": false,
      "description": "Determines if the\ntemplate is always available in web and mobile interfaces."
    },
    "displayName": {
      "enum": [
        "Classification"
      ],
      "type": "string",
      "example": "Classification",
      "description": "The name of this template as shown in web and mobile interfaces."
    },
    "templateKey": {
      "enum": [
        "securityClassification-6VMVochwUWo"
      ],
      "type": "string",
      "example": "securityClassification-6VMVochwUWo",
      "description": "`securityClassification-6VMVochwUWo`"
    },
    "copyInstanceOnItemCopy": {
      "type": "boolean",
      "example": true,
      "description": "Determines if \nclassifications are\ncopied along when the file or folder is\ncopied."
    }
  },
  "description": "A metadata template that holds the security classifications\ndefined by an enterprise.",
  "x-box-resource-id": "classification_template"
}

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "op",
      "fieldKey",
      "data"
    ],
    "properties": {
      "op": {
        "enum": [
          "addEnumOption"
        ],
        "type": "string",
        "example": "addEnumOption",
        "description": "The type of change to perform on the classification\nobject."
      },
      "data": {
        "type": "object",
        "required": [
          "key"
        ],
        "properties": {
          "key": {
            "type": "string",
            "example": "Sensitive",
            "description": "The label of the classification as shown in the web and\nmobile interfaces. This is the only field required to\nadd a classification."
          },
          "staticConfig": {
            "type": "object",
            "properties": {
              "classification": {
                "type": "object",
                "properties": {
                  "colorID": {
                    "type": "integer",
                    "format": "int64",
                    "example": 4,
                    "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray"
                  },
                  "classificationDefinition": {
                    "type": "string",
                    "example": "Sensitive information that must not be shared.",
                    "description": "A longer description of the classification."
                  }
                },
                "description": "Additional details for the classification."
              }
            },
            "description": "A static configuration for the classification."
          }
        },
        "description": "The details of the classification to add."
      },
      "fieldKey": {
        "enum": [
          "Box__Security__Classification__Key"
        ],
        "type": "string",
        "example": "Box__Security__Classification__Key",
        "description": "Defines classifications \navailable in the enterprise."
      }
    },
    "description": "A single classification to add to the enterprise."
  },
  "required": [
    "items"
  ],
  "description": "An array that contains one or more classifications to add to\nthe enterprise's list of classifications."
}

{
  "type": "object",
  "required": [
    "scope",
    "displayName",
    "fields",
    "templateKey"
  ],
  "properties": {
    "scope": {
      "enum": [
        "enterprise"
      ],
      "type": "string",
      "example": "enterprise",
      "description": "The scope in which to create the classifications. This should\nbe `enterprise` or `enterprise_{id}` where `id` is the unique\nID of the enterprise."
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "key",
          "displayName",
          "options"
        ],
        "properties": {
          "key": {
            "enum": [
              "Box__Security__Classification__Key"
            ],
            "type": "string",
            "example": "Box__Security__Classification__Key",
            "description": "Defines classifications \navailable in the enterprise."
          },
          "type": {
            "enum": [
              "enum"
            ],
            "type": "string",
            "example": "enum",
            "description": "The type of the field\nthat is always enum."
          },
          "hidden": {
            "type": "boolean",
            "example": false,
            "description": "Determines if the classification\ntemplate is\nhidden or available on\nweb and mobile\ndevices."
          },
          "options": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "key"
              ],
              "properties": {
                "key": {
                  "type": "string",
                  "example": "Sensitive",
                  "description": "The display name and key this classification. This\nwill be show in the Box UI."
                },
                "staticConfig": {
                  "type": "object",
                  "properties": {
                    "classification": {
                      "type": "object",
                      "properties": {
                        "colorID": {
                          "type": "integer",
                          "format": "int64",
                          "example": 4,
                          "description": "An identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may\nchange without notice. Currently, the color\nmappings are as follows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray"
                        },
                        "classificationDefinition": {
                          "type": "string",
                          "example": "Sensitive information",
                          "description": "A longer description of the classification."
                        }
                      },
                      "description": "Additional information about the classification."
                    }
                  },
                  "description": "Additional information about the classification."
                }
              },
              "description": "An individual classification."
            },
            "description": "The actual list of classifications that are present on\nthis template."
          },
          "displayName": {
            "enum": [
              "Classification"
            ],
            "type": "string",
            "example": "Classification",
            "description": "A display name for the classification."
          }
        },
        "description": "The `enum` field which holds all the valid classification\nvalues."
      },
      "description": "The classification template requires exactly\none field, which holds\nall the valid classification values."
    },
    "hidden": {
      "type": "boolean",
      "example": false,
      "description": "Determines if the classification template is\nhidden or available on web and mobile\ndevices."
    },
    "displayName": {
      "enum": [
        "Classification"
      ],
      "type": "string",
      "example": "Classification",
      "description": "The name of the\ntemplate as shown in web and mobile interfaces."
    },
    "templateKey": {
      "enum": [
        "securityClassification-6VMVochwUWo"
      ],
      "type": "string",
      "example": "securityClassification-6VMVochwUWo",
      "description": "Defines the list of metadata templates."
    },
    "copyInstanceOnItemCopy": {
      "type": "boolean",
      "example": false,
      "description": "Determines if classifications are\ncopied along when the file or folder is\ncopied."
    }
  }
}

{
  "type": "object",
  "properties": {
    "Box__Security__Classification__Key": {
      "type": "string",
      "example": "Sensitive",
      "description": "The name of the classification to apply to this file.\n\nTo list the available classifications in an enterprise,\nuse the classification API to retrieve the\n[classification template](e://get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema)\nwhich lists all available classification keys."
    }
  }
}

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "op",
      "path",
      "value"
    ],
    "properties": {
      "op": {
        "enum": [
          "replace"
        ],
        "type": "string",
        "example": "replace",
        "description": "`replace`"
      },
      "path": {
        "enum": [
          "/Box__Security__Classification__Key"
        ],
        "type": "string",
        "example": "/Box__Security__Classification__Key",
        "description": "Defines classifications \navailable in the enterprise."
      },
      "value": {
        "type": "string",
        "example": "Sensitive",
        "description": "The name of the classification to apply to this file.\n\nTo list the available classifications in an enterprise,\nuse the classification API to retrieve the\n[classification template](e://get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema)\nwhich lists all available classification keys."
      }
    },
    "description": "The operation to perform on the classification\nmetadata template instance. In this case, it use\nused to replace the value stored for the\n`Box__Security__Classification__Key` field with a new\nvalue."
  },
  "required": [
    "items"
  ],
  "description": "A list containing the one change to make, to\nupdate the classification label."
}

{
  "type": "object",
  "properties": {
    "Box__Security__Classification__Key": {
      "type": "string",
      "example": "Sensitive",
      "description": "The name of the classification to apply to this folder.\n\nTo list the available classifications in an enterprise,\nuse the classification API to retrieve the\n[classification template](e://get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema)\nwhich lists all available classification keys."
    }
  }
}

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "op",
      "path",
      "value"
    ],
    "properties": {
      "op": {
        "enum": [
          "replace"
        ],
        "type": "string",
        "example": "replace",
        "description": "`replace`"
      },
      "path": {
        "enum": [
          "/Box__Security__Classification__Key"
        ],
        "type": "string",
        "example": "/Box__Security__Classification__Key",
        "description": "Defines classifications \navailable in the enterprise."
      },
      "value": {
        "type": "string",
        "example": "Sensitive",
        "description": "The name of the classification to apply to this folder.\n\nTo list the available classifications in an enterprise,\nuse the classification API to retrieve the\n[classification template](e://get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema)\nwhich lists all available classification keys."
      }
    },
    "description": "The operation to perform on the classification\nmetadata template instance. In this case, it use\nused to replace the value stored for the\n`Box__Security__Classification__Key` field with a new\nvalue."
  },
  "required": [
    "items"
  ],
  "description": "A list containing the one change to make, to\nupdate the classification label."
}

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "op",
      "fieldKey",
      "enumOptionKey",
      "data"
    ],
    "properties": {
      "op": {
        "enum": [
          "editEnumOption"
        ],
        "type": "string",
        "example": "editEnumOption",
        "description": "The type of change to perform on the classification\nobject."
      },
      "data": {
        "type": "object",
        "required": [
          "key"
        ],
        "properties": {
          "key": {
            "type": "string",
            "example": "Very Sensitive",
            "description": "A new label for the classification, as it will be\nshown in the web and mobile interfaces."
          },
          "staticConfig": {
            "type": "object",
            "properties": {
              "classification": {
                "type": "object",
                "properties": {
                  "colorID": {
                    "type": "integer",
                    "format": "int64",
                    "example": 4,
                    "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray"
                  },
                  "classificationDefinition": {
                    "type": "string",
                    "example": "Sensitive information that must not be shared.",
                    "description": "A longer description of the classification."
                  }
                },
                "description": "Additional details for the classification."
              }
            },
            "description": "A static configuration for the classification."
          }
        },
        "description": "The details of the updated classification."
      },
      "fieldKey": {
        "enum": [
          "Box__Security__Classification__Key"
        ],
        "type": "string",
        "example": "Box__Security__Classification__Key",
        "description": "Defines classifications \navailable in the enterprise."
      },
      "enumOptionKey": {
        "type": "string",
        "example": "Sensitive",
        "description": "The original label of the classification to change."
      }
    },
    "description": "A single classification to update."
  },
  "required": [
    "items"
  ],
  "description": "An array that contains one or more classifications to update."
}

{
  "type": "object",
  "title": "Client error",
  "properties": {
    "code": {
      "enum": [
        "created",
        "accepted",
        "no_content",
        "redirect",
        "not_modified",
        "bad_request",
        "unauthorized",
        "forbidden",
        "not_found",
        "method_not_allowed",
        "conflict",
        "precondition_failed",
        "too_many_requests",
        "internal_server_error",
        "unavailable",
        "item_name_invalid",
        "insufficient_scope"
      ],
      "type": "string",
      "example": "item_name_invalid",
      "description": "A Box-specific error code"
    },
    "type": {
      "enum": [
        "error"
      ],
      "type": "string",
      "example": "error",
      "nullable": false,
      "description": "error"
    },
    "status": {
      "type": "integer",
      "format": "int32",
      "example": 400,
      "nullable": false,
      "description": "The HTTP status of the response."
    },
    "message": {
      "type": "string",
      "example": "Method Not Allowed",
      "nullable": false,
      "description": "A short message describing the error."
    },
    "help_url": {
      "type": "string",
      "example": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
      "nullable": false,
      "description": "A URL that links to more information about why this error occurred."
    },
    "request_id": {
      "type": "string",
      "example": "abcdef123456",
      "nullable": false,
      "description": "A unique identifier for this response, which can be used\nwhen contacting Box support."
    },
    "context_info": {
      "type": "object",
      "nullable": true,
      "properties": {
        "message": {
          "type": "string",
          "example": "Something went wrong.",
          "description": "More details on the error."
        }
      },
      "description": "A free-form object that contains additional context\nabout the error. The possible fields are defined on\na per-endpoint basis. `message` is only one example."
    }
  },
  "description": "A generic error",
  "x-box-resource-id": "client_error"
}

{
  "type": "object",
  "title": "Collaboration",
  "required": [
    "id",
    "type"
  ],
  "x-box-tag": "user_collaborations",
  "properties": {
    "id": {
      "type": "string",
      "example": "12345678",
      "description": "The unique identifier for this collaboration."
    },
    "item": {
      "allOf": [
        {
          "oneOf": [
            {
              "$ref": "#/components/schemas/File"
            },
            {
              "$ref": "#/components/schemas/Folder"
            },
            {
              "$ref": "#/components/schemas/WebLink"
            }
          ]
        },
        {
          "description": "The file or folder to which access is granted. The field is\n`null` when the collaboration `status` is `pending`."
        }
      ],
      "nullable": true
    },
    "role": {
      "enum": [
        "editor",
        "viewer",
        "previewer",
        "uploader",
        "previewer uploader",
        "viewer uploader",
        "co-owner",
        "owner"
      ],
      "type": "string",
      "example": "editor",
      "description": "The level of access granted."
    },
    "type": {
      "enum": [
        "collaboration"
      ],
      "type": "string",
      "example": "collaboration",
      "description": "`collaboration`"
    },
    "status": {
      "enum": [
        "accepted",
        "pending",
        "rejected"
      ],
      "type": "string",
      "example": "accepted",
      "description": "The status of the collaboration invitation. If the status\nis `pending`, `login` and `name` return an empty string."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-12T10:53:43-08:00",
      "description": "When the collaboration object was created."
    },
    "created_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Collaborations"
        },
        {
          "description": "The user who created the collaboration object."
        },
        {
          "example": [
            {
              "id": 33224412
            },
            {
              "type": "user"
            },
            {
              "login": "dylan@example.com"
            },
            {
              "name": "Dylan Smith"
            }
          ]
        }
      ]
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-26T10:53:43-08:00",
      "nullable": true,
      "description": "When the collaboration will expire, or `null` if no expiration\ndate is set."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-12T10:53:43-08:00",
      "description": "When the collaboration object was last modified."
    },
    "invite_email": {
      "type": "string",
      "example": "john@example.com",
      "nullable": true,
      "description": "The email address used to invite an unregistered collaborator, if\nthey are not a registered user."
    },
    "accessible_by": {
      "allOf": [
        {
          "oneOf": [
            {
              "$ref": "#/components/schemas/User--Collaborations"
            },
            {
              "$ref": "#/components/schemas/Group--Mini"
            }
          ]
        },
        {
          "description": "The user or group that is granted access."
        }
      ]
    },
    "is_access_only": {
      "type": "boolean",
      "example": true,
      "description": "If set to `true`, collaborators have access to\nshared items, but such items won't be visible in the\nAll Files list. Additionally, collaborators won't\nsee the the path to the root folder for the\nshared item."
    },
    "acknowledged_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-12T10:55:20-08:00",
      "description": "When the `status` of the collaboration object changed to\n`accepted` or `rejected`."
    },
    "acceptance_requirements_status": {
      "type": "object",
      "properties": {
        "strong_password_requirement": {
          "type": "object",
          "properties": {
            "user_has_strong_password": {
              "type": "boolean",
              "example": true,
              "nullable": true,
              "description": "Whether or not the user has a strong password set for their\naccount. The field is `null` when a strong password is not\nrequired."
            },
            "enterprise_has_strong_password_required_for_external_users": {
              "type": "boolean",
              "example": true,
              "description": "Whether or not the enterprise that owns the content requires\na strong password to collaborate on the content."
            }
          }
        },
        "terms_of_service_requirement": {
          "type": "object",
          "properties": {
            "is_accepted": {
              "type": "boolean",
              "example": true,
              "nullable": true,
              "description": "Whether or not the terms of service have been accepted.  The\nfield is `null` when there is no terms of service required."
            },
            "terms_of_service": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/TermsOfService--Base"
                },
                {
                  "description": "The terms of service that must be accepted before the\ncollaboration can be accepted. The field is `null` when\nthere is no terms of service required."
                }
              ]
            }
          }
        },
        "two_factor_authentication_requirement": {
          "type": "object",
          "properties": {
            "enterprise_has_two_factor_auth_enabled": {
              "type": "boolean",
              "example": true,
              "description": "Whether or not the enterprise that owns the content requires\ntwo-factor authentication to be enabled in order to\ncollaborate on the content."
            },
            "user_has_two_factor_authentication_enabled": {
              "type": "boolean",
              "example": true,
              "nullable": true,
              "description": "Whether or not the user has two-factor authentication\nenabled. The field is `null` when two-factor\nauthentication is not required."
            }
          }
        }
      }
    }
  },
  "description": "Collaborations define access permissions for users and groups to files and\nfolders, similar to access control lists. A collaboration object grants a\nuser or group access to a file or folder with permissions defined by a\nspecific role.",
  "x-box-resource-id": "collaboration"
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "next_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
          "nullable": true,
          "description": "The marker for the start of the next page of results."
        },
        "prev_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
          "nullable": true,
          "description": "The marker for the start of the previous page of results."
        }
      },
      "description": "The part of an API response that describes marker\nbased pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CollaborationAllowlistEntry"
          },
          "description": "A list of allowed collaboration domains"
        }
      }
    }
  ],
  "title": "Allowed collaboration domains",
  "x-box-tag": "collaboration_allowlist_entries",
  "description": "A list of allowed domains for collaboration.",
  "x-box-resource-id": "collaboration_allowlist_entries"
}

{
  "type": "object",
  "title": "Allowed collaboration domain",
  "x-box-tag": "collaboration_allowlist_entries",
  "properties": {
    "id": {
      "type": "string",
      "example": "11446498",
      "description": "The unique identifier for this entry"
    },
    "type": {
      "enum": [
        "collaboration_whitelist_entry"
      ],
      "type": "string",
      "example": "collaboration_whitelist_entry",
      "description": "`collaboration_whitelist_entry`"
    },
    "domain": {
      "type": "string",
      "example": "example.com",
      "description": "The whitelisted domain"
    },
    "direction": {
      "enum": [
        "inbound",
        "outbound",
        "both"
      ],
      "type": "string",
      "example": "both",
      "description": "The direction of the collaborations to allow."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-12T10:53:43-08:00",
      "description": "The time the entry was created at"
    },
    "enterprise": {
      "allOf": [
        {
          "type": "object",
          "title": "Enterprise",
          "properties": {
            "id": {
              "type": "string",
              "example": "11446498",
              "description": "The unique identifier for this enterprise."
            },
            "name": {
              "type": "string",
              "example": "Acme Inc.",
              "description": "The name of the enterprise"
            },
            "type": {
              "enum": [
                "enterprise"
              ],
              "type": "string",
              "example": "enterprise",
              "description": "`enterprise`"
            }
          },
          "description": "A representation of a Box enterprise"
        },
        {
          "description": "The enterprise this list is applied to"
        }
      ]
    }
  },
  "description": "An entry that describes an approved domain for which users can collaborate\nwith files and folders in your enterprise or vice versa.",
  "x-box-resource-id": "collaboration_allowlist_entry"
}

{
  "type": "object",
  "title": "Allowed collaboration domains user exemption",
  "x-box-tag": "collaboration_allowlist_exempt_targets",
  "properties": {
    "id": {
      "type": "string",
      "example": "11446498",
      "description": "The unique identifier for this exemption"
    },
    "type": {
      "enum": [
        "collaboration_whitelist_exempt_target"
      ],
      "type": "string",
      "example": "collaboration_whitelist_exempt_target",
      "description": "`collaboration_whitelist_exempt_target`"
    },
    "user": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Mini"
        },
        {
          "description": "The user that has been exempt"
        }
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-12T10:53:43-08:00",
      "description": "The time the entry was created"
    },
    "enterprise": {
      "allOf": [
        {
          "type": "object",
          "title": "Enterprise",
          "properties": {
            "id": {
              "type": "string",
              "example": "11446498",
              "description": "The unique identifier for this enterprise."
            },
            "name": {
              "type": "string",
              "example": "Acme Inc.",
              "description": "The name of the enterprise"
            },
            "type": {
              "enum": [
                "enterprise"
              ],
              "type": "string",
              "example": "enterprise",
              "description": "`enterprise`"
            }
          },
          "description": "A representation of a Box enterprise"
        },
        {
          "description": "The enterprise this entry belongs to"
        }
      ]
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-12T10:53:43-08:00",
      "description": "The time the entry was modified"
    }
  },
  "description": "The user that is exempt from any of the restrictions\nimposed by the list of allowed collaboration domains for this enterprise.",
  "x-box-resource-id": "collaboration_allowlist_exempt_target"
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "next_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
          "nullable": true,
          "description": "The marker for the start of the next page of results."
        },
        "prev_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
          "nullable": true,
          "description": "The marker for the start of the previous page of results."
        }
      },
      "description": "The part of an API response that describes marker\nbased pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CollaborationAllowlistExemptTarget"
          },
          "description": "A list of users exempt from any of the restrictions\nimposed by the list of allowed collaboration domains\nfor this enterprise."
        }
      }
    }
  ],
  "title": "Allowed collaboration domains user exemptions",
  "x-box-tag": "collaboration_allowlist_exempt_targets",
  "description": "A list of users exempt from any of the restrictions\nimposed by the list of allowed collaboration domains for this enterprise.",
  "x-box-resource-id": "collaboration_allowlist_exempt_targets"
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "order": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "by": {
                "type": "string",
                "example": "type",
                "description": "The field to order by"
              },
              "direction": {
                "enum": [
                  "ASC",
                  "DESC"
                ],
                "type": "string",
                "example": "ASC",
                "description": "The direction to order by, either ascending or descending"
              }
            },
            "description": "The order in which a pagination is ordered"
          },
          "description": "The order by which items are returned.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        },
        "offset": {
          "type": "integer",
          "format": "int64",
          "example": 2000,
          "description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        },
        "total_count": {
          "type": "integer",
          "format": "int64",
          "example": 5000,
          "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        }
      },
      "description": "The part of an API response that describes pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Collaboration"
          },
          "description": "A list of collaborations"
        }
      }
    }
  ],
  "title": "Collaborations",
  "x-box-tag": "user_collaborations",
  "description": "A list of collaborations",
  "x-box-resource-id": "collaborations"
}

{
  "type": "object",
  "required": [
    "role"
  ],
  "properties": {
    "role": {
      "enum": [
        "editor",
        "viewer",
        "previewer",
        "uploader",
        "previewer uploader",
        "viewer uploader",
        "co-owner",
        "owner"
      ],
      "type": "string",
      "example": "editor",
      "description": "The level of access granted."
    },
    "status": {
      "enum": [
        "pending",
        "accepted",
        "rejected"
      ],
      "type": "string",
      "example": "accepted",
      "description": "<!--alex ignore reject-->\nSet the status of a `pending` collaboration invitation,\neffectively accepting, or rejecting the invite."
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "example": "2019-08-29T23:59:00-07:00",
      "description": "Update the expiration date for the collaboration. At this date,\nthe collaboration will be automatically removed from the item.\n\nThis feature will only work if the **Automatically remove invited\ncollaborators: Allow folder owners to extend the expiry date**\nsetting has been enabled in the **Enterprise Settings**\nof the **Admin Console**. When the setting is not enabled,\ncollaborations can not have an expiry date and a value for this\nfield will be result in an error.\n\nAdditionally, a collaboration can only be given an\nexpiration if it was created after the **Automatically remove\ninvited collaborator** setting was enabled."
    },
    "can_view_path": {
      "type": "boolean",
      "example": true,
      "description": "Determines if the invited users can see the entire parent path to\nthe associated folder. The user will not gain privileges in any\nparent folder and therefore can not see content the user is not\ncollaborated on.\n\nBe aware that this meaningfully increases the time required to load the\ninvitee's **All Files** page. We recommend you limit the number of\ncollaborations with `can_view_path` enabled to 1,000 per user.\n\nOnly owner or co-owners can invite collaborators with a `can_view_path` of\n`true`.\n\n`can_view_path` can only be used for folder collaborations."
    }
  }
}

{
  "type": "object",
  "title": "Collaborator variable",
  "required": [
    "type",
    "variable_type",
    "variable_value"
  ],
  "properties": {
    "type": {
      "enum": [
        "variable"
      ],
      "type": "string",
      "example": "variable",
      "description": "Collaborator\nobject type.\n"
    },
    "variable_type": {
      "enum": [
        "user_list"
      ],
      "type": "string",
      "example": "user_list",
      "description": "Variable type \nfor the Collaborator\nobject.\n"
    },
    "variable_value": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "id": {
            "type": "string",
            "example": "636281",
            "description": "User's ID."
          },
          "type": {
            "enum": [
              "user"
            ],
            "type": "string",
            "example": "user",
            "description": "The object type."
          }
        },
        "description": "User variable used\nin workflow outcomes."
      },
      "description": "A list of user IDs."
    }
  },
  "description": "A collaborator\nobject. Allows to\nspecify a list of user\nID's that are affected\nby the workflow result."
}

{
  "type": "object",
  "title": "Collection",
  "x-box-tag": "collections",
  "properties": {
    "id": {
      "type": "string",
      "example": "11446498",
      "description": "The unique identifier for this collection."
    },
    "name": {
      "enum": [
        "Favorites"
      ],
      "type": "string",
      "example": "Favorites",
      "description": "The name of the collection."
    },
    "type": {
      "enum": [
        "collection"
      ],
      "type": "string",
      "example": "collection",
      "description": "`collection`"
    },
    "collection_type": {
      "enum": [
        "favorites"
      ],
      "type": "string",
      "example": "favorites",
      "description": "The type of the collection. This is used to\ndetermine the proper visual treatment for\ncollections."
    }
  },
  "description": "A collection of items, including files and folders.\n\nCurrently, the only collection available\nis the `favorites` collection.\n\nThe contents of a collection can be explored in a\nsimilar way to which the contents of a folder is\nexplored.",
  "x-box-resource-id": "collection"
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "order": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "by": {
                "type": "string",
                "example": "type",
                "description": "The field to order by"
              },
              "direction": {
                "enum": [
                  "ASC",
                  "DESC"
                ],
                "type": "string",
                "example": "ASC",
                "description": "The direction to order by, either ascending or descending"
              }
            },
            "description": "The order in which a pagination is ordered"
          },
          "description": "The order by which items are returned.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        },
        "offset": {
          "type": "integer",
          "format": "int64",
          "example": 2000,
          "description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        },
        "total_count": {
          "type": "integer",
          "format": "int64",
          "example": 5000,
          "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        }
      },
      "description": "The part of an API response that describes pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Collection"
          },
          "description": "A list of collections"
        }
      }
    }
  ],
  "title": "Collections",
  "x-box-tag": "collections",
  "description": "A list of collections",
  "x-box-resource-id": "collections"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Comment--Base"
    },
    {
      "properties": {
        "item": {
          "allOf": [
            {
              "type": "object",
              "title": "Reference",
              "properties": {
                "id": {
                  "type": "string",
                  "example": "11446498",
                  "description": "The unique identifier for this object"
                },
                "type": {
                  "type": "string",
                  "example": "file",
                  "description": "The type for this object"
                }
              },
              "description": "The bare basic reference for an object"
            },
            {
              "description": "The file this comment was placed on"
            }
          ]
        },
        "message": {
          "type": "string",
          "example": "@Aaron Levie these tigers are cool!",
          "description": "The text of the comment, as provided by the user"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "description": "The time this comment was created"
        },
        "created_by": {
          "allOf": [
            {
              "$ref": "#/components/schemas/User--Mini"
            },
            {
              "description": "A mini user object representing the author of the\ncomment"
            }
          ]
        },
        "modified_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "description": "The time this comment was last modified"
        },
        "is_reply_comment": {
          "type": "boolean",
          "example": true,
          "description": "Whether or not this comment is a reply to another\ncomment"
        }
      }
    }
  ],
  "title": "Comment",
  "description": "Standard representation of a comment.",
  "x-box-variant": "standard",
  "x-box-resource-id": "comment"
}

{
  "type": "object",
  "title": "Comment (Base)",
  "x-box-tag": "comments",
  "properties": {
    "id": {
      "type": "string",
      "example": "11446498",
      "description": "The unique identifier for this comment."
    },
    "type": {
      "enum": [
        "comment"
      ],
      "type": "string",
      "example": "comment",
      "description": "`comment`"
    }
  },
  "description": "Base representation of a comment.",
  "x-box-variant": "base",
  "x-box-variants": [
    "base",
    "standard",
    "full"
  ],
  "x-box-sanitized": true,
  "x-box-resource-id": "comment--base"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Comment"
    },
    {
      "properties": {
        "tagged_message": {
          "type": "string",
          "example": "@[1234567:Aaron Levie] these tigers are cool!",
          "description": "The string representing the comment text with\n@mentions included. @mention format is @[id:username]\nwhere `id` is user's Box ID and `username` is\ntheir display name."
        }
      }
    }
  ],
  "title": "Comment (Full)",
  "description": "Comments are messages created on files. Comments\ncan be made independently or created as responses to other\ncomments",
  "x-box-variant": "full",
  "x-box-resource-id": "comment--full"
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "order": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "by": {
                "type": "string",
                "example": "type",
                "description": "The field to order by"
              },
              "direction": {
                "enum": [
                  "ASC",
                  "DESC"
                ],
                "type": "string",
                "example": "ASC",
                "description": "The direction to order by, either ascending or descending"
              }
            },
            "description": "The order in which a pagination is ordered"
          },
          "description": "The order by which items are returned.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        },
        "offset": {
          "type": "integer",
          "format": "int64",
          "example": 2000,
          "description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        },
        "total_count": {
          "type": "integer",
          "format": "int64",
          "example": 5000,
          "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        }
      },
      "description": "The part of an API response that describes pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Comment--Full"
          },
          "description": "A list of comments"
        }
      }
    }
  ],
  "title": "Comments",
  "x-box-tag": "comments",
  "description": "A list of comments",
  "x-box-resource-id": "comments"
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "Review completed!",
      "description": "The text of the comment to update"
    }
  }
}

{
  "type": "object",
  "title": "Completion rule variable",
  "required": [
    "type",
    "variable_type",
    "variable_value"
  ],
  "properties": {
    "type": {
      "enum": [
        "variable"
      ],
      "type": "string",
      "example": "variable",
      "description": "Completion\nRule object type.\n"
    },
    "variable_type": {
      "enum": [
        "task_completion_rule"
      ],
      "type": "string",
      "example": "task_completion_rule",
      "description": "Variable type\nfor the Completion\nRule object.\n"
    },
    "variable_value": {
      "enum": [
        "all_assignees",
        "any_assignees"
      ],
      "type": "string",
      "example": "all_assignees",
      "description": "Variable\nvalues for a completion\nrule.\n"
    }
  },
  "description": "A completion\nrule object. Determines\nif an action should be completed\nby all or any assignees."
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/ClientError"
    },
    {
      "properties": {
        "context_info": {
          "type": "object",
          "properties": {
            "conflicts": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/FileConflict"
              },
              "description": "A list of the file conflicts that caused this error."
            }
          }
        }
      }
    }
  ],
  "title": "Conflict error",
  "x-box-tag": "uploads",
  "description": "The error that occurs when a file can not be created due\nto a conflict.",
  "x-box-resource-id": "conflict_error"
}

{
  "type": "object",
  "title": "Device pinner",
  "x-box-tag": "device_pinners",
  "properties": {
    "id": {
      "type": "string",
      "example": "11446498",
      "description": "The unique identifier for this device pin."
    },
    "type": {
      "enum": [
        "device_pinner"
      ],
      "type": "string",
      "example": "device_pinner",
      "description": "`device_pinner`"
    },
    "owned_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Mini"
        },
        {
          "description": "The user that the device pin belongs to"
        }
      ]
    },
    "product_name": {
      "type": "string",
      "example": "iPad",
      "description": "The type of device being pinned"
    }
  },
  "description": "Device pins allow enterprises to control what devices can\nuse native Box applications.",
  "x-box-resource-id": "device_pinner"
}

{
  "type": "object",
  "title": "Device pinners",
  "x-box-tag": "device_pinners",
  "properties": {
    "limit": {
      "type": "integer",
      "format": "int64",
      "default": 100,
      "example": 200,
      "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed."
    },
    "order": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "by": {
            "enum": [
              "id"
            ],
            "type": "string",
            "example": "id",
            "description": "The field that is ordered by"
          },
          "direction": {
            "enum": [
              "asc",
              "desc"
            ],
            "type": "string",
            "example": "asc",
            "description": "The direction to order by, either ascending or descending"
          }
        },
        "description": "The order in which a pagination is ordered"
      },
      "description": "The order by which items are returned."
    },
    "entries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DevicePinner"
      },
      "description": "A list of device pins"
    },
    "next_marker": {
      "type": "integer",
      "format": "int64",
      "example": 3000,
      "description": "The marker for the start of the next page of results."
    }
  },
  "description": "A list of device pins",
  "x-box-resource-id": "device_pinners"
}

{
  "type": "object",
  "required": [
    "domain",
    "direction"
  ],
  "properties": {
    "domain": {
      "type": "string",
      "example": "example.com",
      "description": "The domain to add to the list of allowed domains."
    },
    "direction": {
      "enum": [
        "inbound",
        "outbound",
        "both"
      ],
      "type": "string",
      "example": "inbound",
      "description": "The direction in which to allow collaborations."
    }
  }
}

{
  "type": "object",
  "required": [
    "user"
  ],
  "properties": {
    "user": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "23522323",
          "description": "The ID of the user to exempt."
        }
      },
      "description": "The user to exempt."
    }
  }
}

{
  "type": "string",
  "format": "binary",
  "description": "The binary content of the file"
}

{
  "type": "object",
  "title": "Email alias",
  "x-box-tag": "email_aliases",
  "properties": {
    "id": {
      "type": "string",
      "example": "11446498",
      "description": "The unique identifier for this object"
    },
    "type": {
      "enum": [
        "email_alias"
      ],
      "type": "string",
      "example": "email_alias",
      "description": "`email_alias`"
    },
    "email": {
      "type": "string",
      "example": "alias@example.com",
      "description": "The email address"
    },
    "is_confirmed": {
      "type": "boolean",
      "example": true,
      "description": "Whether the email address has been confirmed"
    }
  },
  "description": "An email alias for a user.",
  "x-box-resource-id": "email_alias"
}

{
  "type": "object",
  "title": "Email aliases",
  "x-box-tag": "email_aliases",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EmailAlias"
      },
      "description": "A list of email aliases"
    },
    "total_count": {
      "type": "integer",
      "format": "int64",
      "example": 5000,
      "description": "The number of email aliases."
    }
  },
  "description": "A list of email aliases",
  "x-box-resource-id": "email_aliases"
}

{
  "type": "object",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "example": "alias@example.com",
      "description": "The email address to add to the account as an alias.\n\nNote: The domain of the email alias needs to be registered\n to your enterprise.\nSee the [domain verification guide](https://support.box.com/hc/en-us/articles/4408619650579-Domain-Verification) for steps to add a new domain."
    }
  }
}

{
  "type": "object",
  "title": "Enterprise (Base)",
  "properties": {
    "id": {
      "type": "string",
      "example": "1910967",
      "description": "The unique identifier for this enterprise"
    },
    "type": {
      "enum": [
        "enterprise"
      ],
      "type": "string",
      "example": "enterprise",
      "nullable": false,
      "description": "`enterprise`"
    }
  },
  "description": "A mini representation of a enterprise, used when\nnested within another resource.",
  "x-box-variant": "base",
  "x-box-variants": [
    "base",
    "mini",
    "standard",
    "full"
  ],
  "x-box-resource-id": "enterprise--base"
}

{
  "type": "object",
  "title": "Event",
  "x-box-tag": "events",
  "properties": {
    "type": {
      "type": "string",
      "example": "event",
      "description": "`event`"
    },
    "source": {
      "allOf": [
        {
          "oneOf": [
            {
              "$ref": "#/components/schemas/User"
            },
            {
              "$ref": "#/components/schemas/EventSource"
            },
            {
              "$ref": "#/components/schemas/File"
            },
            {
              "$ref": "#/components/schemas/Folder"
            },
            {
              "$ref": "#/components/schemas/GenericSource"
            }
          ]
        },
        {
          "description": "The resource that triggered this event. For more information,\ncheck out the guide on event triggers."
        }
      ]
    },
    "event_id": {
      "type": "string",
      "example": "f82c3ba03e41f7e8a7608363cc6c0390183c3f83",
      "description": "The ID of the event object. You can use this to detect duplicate events"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2022-12-12T10:53:43-08:00",
      "description": "When the event object was created"
    },
    "created_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Mini"
        },
        {
          "description": "The user that performed the action represented by the event.\nSome events may be performed by users not logged into Box.\nIn that case, not all attributes of the object are populated and the\nevent is attributed to a unknown user (`user_id = 2`)"
        }
      ]
    },
    "event_type": {
      "allOf": [
        {
          "enum": [
            "ACCESS_GRANTED",
            "ACCESS_REVOKED",
            "ADD_DEVICE_ASSOCIATION",
            "ADD_LOGIN_ACTIVITY_DEVICE",
            "ADMIN_LOGIN",
            "APPLICATION_CREATED",
            "APPLICATION_PUBLIC_KEY_ADDED",
            "APPLICATION_PUBLIC_KEY_DELETED",
            "CHANGE_ADMIN_ROLE",
            "CHANGE_FOLDER_PERMISSION",
            "COLLABORATION_ACCEPT",
            "COLLABORATION_EXPIRATION",
            "COLLABORATION_INVITE",
            "COLLABORATION_REMOVE",
            "COLLABORATION_ROLE_CHANGE",
            "COLLAB_ADD_COLLABORATOR",
            "COLLAB_INVITE_COLLABORATOR",
            "COLLAB_REMOVE_COLLABORATOR",
            "COLLAB_ROLE_CHANGE",
            "COMMENT_CREATE",
            "COMMENT_DELETE",
            "CONTENT_ACCESS",
            "CONTENT_WORKFLOW_ABNORMAL_DOWNLOAD_ACTIVITY",
            "CONTENT_WORKFLOW_AUTOMATION_ADD",
            "CONTENT_WORKFLOW_AUTOMATION_DELETE",
            "CONTENT_WORKFLOW_POLICY_ADD",
            "CONTENT_WORKFLOW_SHARING_POLICY_VIOLATION",
            "CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION",
            "COPY",
            "DATA_RETENTION_CREATE_RETENTION",
            "DATA_RETENTION_REMOVE_RETENTION",
            "DELETE",
            "DELETE_USER",
            "DEVICE_TRUST_CHECK_FAILED",
            "DOWNLOAD",
            "EDIT",
            "EDIT_USER",
            "EMAIL_ALIAS_CONFIRM",
            "EMAIL_ALIAS_REMOVE",
            "ENABLE_TWO_FACTOR_AUTH",
            "ENTERPRISE_APP_AUTHORIZATION_UPDATE",
            "FAILED_LOGIN",
            "FILE_MARKED_MALICIOUS",
            "FILE_WATERMARKED_DOWNLOAD",
            "GROUP_ADD_ITEM",
            "GROUP_ADD_USER",
            "GROUP_CREATION",
            "GROUP_DELETION",
            "GROUP_EDITED",
            "GROUP_REMOVE_ITEM",
            "GROUP_REMOVE_USER",
            "ITEM_COPY",
            "ITEM_CREATE",
            "ITEM_DOWNLOAD",
            "ITEM_MAKE_CURRENT_VERSION",
            "ITEM_MODIFY",
            "ITEM_MOVE",
            "ITEM_OPEN",
            "ITEM_PREVIEW",
            "ITEM_RENAME",
            "ITEM_SHARED",
            "ITEM_SHARED_CREATE",
            "ITEM_SHARED_UNSHARE",
            "ITEM_SHARED_UPDATE",
            "ITEM_SYNC",
            "ITEM_TRASH",
            "ITEM_UNDELETE_VIA_TRASH",
            "ITEM_UNSYNC",
            "ITEM_UPLOAD",
            "LEGAL_HOLD_ASSIGNMENT_CREATE",
            "LEGAL_HOLD_ASSIGNMENT_DELETE",
            "LEGAL_HOLD_POLICY_CREATE",
            "LEGAL_HOLD_POLICY_DELETE",
            "LEGAL_HOLD_POLICY_UPDATE",
            "LOCK",
            "LOCK_CREATE",
            "LOCK_DESTROY",
            "LOGIN",
            "MASTER_INVITE_ACCEPT",
            "MASTER_INVITE_REJECT",
            "METADATA_INSTANCE_CREATE",
            "METADATA_INSTANCE_DELETE",
            "METADATA_INSTANCE_UPDATE",
            "METADATA_TEMPLATE_CREATE",
            "METADATA_TEMPLATE_DELETE",
            "METADATA_TEMPLATE_UPDATE",
            "MOVE",
            "NEW_USER",
            "PREVIEW",
            "REMOVE_DEVICE_ASSOCIATION",
            "REMOVE_LOGIN_ACTIVITY_DEVICE",
            "RENAME",
            "RETENTION_POLICY_ASSIGNMENT_ADD",
            "SHARE",
            "SHARE_EXPIRATION",
            "SHIELD_ALERT",
            "SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED",
            "SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED_MISSING_JUSTIFICATION",
            "SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED",
            "SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED_MISSING_JUSTIFICATION",
            "SHIELD_JUSTIFICATION_APPROVAL",
            "SHIELD_SHARED_LINK_ACCESS_BLOCKED",
            "SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_CREATE",
            "SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_UPDATE",
            "SIGN_DOCUMENT_ASSIGNED",
            "SIGN_DOCUMENT_CANCELLED",
            "SIGN_DOCUMENT_COMPLETED",
            "SIGN_DOCUMENT_CONVERTED",
            "SIGN_DOCUMENT_CREATED",
            "SIGN_DOCUMENT_DECLINED",
            "SIGN_DOCUMENT_EXPIRED",
            "SIGN_DOCUMENT_SIGNED",
            "SIGN_DOCUMENT_VIEWED_BY_SIGNED",
            "SIGNER_DOWNLOADED",
            "SIGNER_FORWARDED",
            "STORAGE_EXPIRATION",
            "TAG_ITEM_CREATE",
            "TASK_ASSIGNMENT_CREATE",
            "TASK_ASSIGNMENT_DELETE",
            "TASK_ASSIGNMENT_UPDATE",
            "TASK_CREATE",
            "TASK_UPDATE",
            "TERMS_OF_SERVICE_ACCEPT",
            "TERMS_OF_SERVICE_REJECT",
            "UNDELETE",
            "UNLOCK",
            "UNSHARE",
            "UPDATE_COLLABORATION_EXPIRATION",
            "UPDATE_SHARE_EXPIRATION",
            "UPLOAD",
            "USER_AUTHENTICATE_OAUTH2_ACCESS_TOKEN_CREATE",
            "WATERMARK_LABEL_CREATE",
            "WATERMARK_LABEL_DELETE"
          ],
          "type": "string",
          "title": "Event Type",
          "example": "FILE_MARKED_MALICIOUS",
          "description": "An event type that can trigger an event"
        },
        {
          "description": "The event type that triggered this event"
        }
      ]
    },
    "session_id": {
      "type": "string",
      "example": "70090280850c8d2a1933c1",
      "description": "The session of the user that performed the action. Not all events will\npopulate this attribute."
    },
    "recorded_at": {
      "type": "string",
      "format": "date-time",
      "example": "2022-12-12T10:54:43-08:00",
      "description": "When the event object was recorded in database"
    },
    "additional_details": {
      "type": "object",
      "example": {
        "key": "value"
      },
      "description": "This object provides additional information about the event if available.\n\nThis can include how a user performed an event as well as additional\ninformation to correlate an event to external KeySafe logs. Not all events\nhave an `additional_details` object.  This object is only available in the\nEnterprise Events."
    }
  },
  "description": "The description of an event that happened within Box",
  "x-box-resource-id": "event"
}

{
  "type": "object",
  "title": "Event source",
  "required": [
    "item_type",
    "item_id",
    "item_name"
  ],
  "properties": {
    "parent": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Folder--Mini"
        },
        {
          "description": "The optional folder that this folder is located within.\n\nThis value may be `null` for some folders such as the\nroot folder or the trash folder."
        }
      ],
      "nullable": true
    },
    "item_id": {
      "type": "string",
      "example": "560284318361",
      "nullable": false,
      "description": "The unique identifier that represents the\nitem.\n"
    },
    "owned_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Mini"
        },
        {
          "description": "The user who owns this item."
        },
        {
          "nullable": false
        }
      ]
    },
    "item_name": {
      "type": "string",
      "example": "report.pdf",
      "nullable": false,
      "description": "The name of the item.\n"
    },
    "item_type": {
      "enum": [
        "file",
        "folder"
      ],
      "type": "string",
      "example": "file",
      "nullable": false,
      "description": "The type of the item that the event\nrepresents. Can be `file` or `folder`.\n"
    },
    "classification": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "example": "Top Secret",
          "description": "The classification's name"
        }
      },
      "description": "The object containing classification information for the item that\ntriggered the event. This field will not appear if the item does not\nhave a classification set."
    }
  },
  "description": "The source file or folder that triggered an event in\nthe event stream.",
  "x-box-resource-id": "event_source"
}

{
  "type": "object",
  "title": "Events",
  "x-box-tag": "events",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Event"
      },
      "description": "A list of events"
    },
    "chunk_size": {
      "type": "integer",
      "format": "int64",
      "example": 2,
      "description": "The number of events returned in this response."
    },
    "next_stream_position": {
      "type": "string",
      "example": "1152922976252290886",
      "description": "The stream position of the start of the next page (chunk)\nof events."
    }
  },
  "description": "A list of event objects",
  "x-box-resource-id": "events"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/File--Mini"
    },
    {
      "properties": {
        "size": {
          "type": "integer",
          "example": 629644,
          "nullable": false,
          "description": "The file size in bytes. Be careful parsing this integer as it can\nget very large and cause an integer overflow."
        },
        "parent": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Folder--Mini"
            },
            {
              "description": "The folder that this file is located within."
            }
          ],
          "nullable": true
        },
        "owned_by": {
          "allOf": [
            {
              "$ref": "#/components/schemas/User--Mini"
            },
            {
              "description": "The user who owns this file"
            },
            {
              "nullable": false
            }
          ]
        },
        "purged_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": true,
          "description": "The time at which this file is expected to be purged\nfrom the trash."
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": false,
          "description": "The date and time when the file was created on Box."
        },
        "created_by": {
          "allOf": [
            {
              "$ref": "#/components/schemas/User--Mini"
            },
            {
              "description": "The user who created this file"
            }
          ]
        },
        "trashed_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": true,
          "description": "The time at which this file was put in the trash."
        },
        "description": {
          "type": "string",
          "example": "Contract for Q1 renewal",
          "nullable": false,
          "maxLength": 256,
          "description": "The optional description of this file"
        },
        "item_status": {
          "enum": [
            "active",
            "trashed",
            "deleted"
          ],
          "type": "string",
          "example": "active",
          "nullable": false,
          "description": "Defines if this item has been deleted or not.\n\n* `active` when the item has is not in the trash\n* `trashed` when the item has been moved to the trash but not deleted\n* `deleted` when the item has been permanently deleted."
        },
        "modified_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": false,
          "description": "The date and time when the file was last updated on Box."
        },
        "modified_by": {
          "allOf": [
            {
              "$ref": "#/components/schemas/User--Mini"
            },
            {
              "description": "The user who last modified this file"
            },
            {
              "nullable": false
            }
          ]
        },
        "shared_link": {
          "allOf": [
            {
              "type": "object",
              "title": "Shared link",
              "required": [
                "url",
                "accessed",
                "effective_access",
                "effective_permission",
                "is_password_enabled",
                "download_count",
                "preview_count"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "format": "url",
                  "example": "https://www.box.com/s/vspke7y05sb214wjokpk",
                  "nullable": false,
                  "description": "The URL that can be used to access the item on Box.\n\nThis URL will display the item in Box's preview UI where the file\ncan be downloaded if allowed.\n\nThis URL will continue to work even when a custom `vanity_url`\nhas been set for this shared link."
                },
                "access": {
                  "enum": [
                    "open",
                    "company",
                    "collaborators"
                  ],
                  "type": "string",
                  "example": "open",
                  "nullable": false,
                  "description": "The access level for this shared link.\n\n* `open` - provides access to this item to anyone with this link\n* `company` - only provides access to this item to people the same company\n* `collaborators` - only provides access to this item to people who are\n   collaborators on this item\n\nIf this field is omitted when creating the shared link, the access level\nwill be set to the default access level specified by the enterprise admin."
                },
                "vanity_url": {
                  "type": "string",
                  "format": "url",
                  "example": "https://acme.app.box.com/v/my_url/",
                  "nullable": true,
                  "description": "The \"Custom URL\" that can also be used to preview the item on Box.  Custom\nURLs can only be created or modified in the Box Web application."
                },
                "permissions": {
                  "type": "object",
                  "required": [
                    "can_download",
                    "can_preview",
                    "can_edit"
                  ],
                  "properties": {
                    "can_edit": {
                      "type": "boolean",
                      "example": false,
                      "nullable": false,
                      "description": "Defines if the shared link allows for the item to be edited.\n\nThis value can only be `true` if `can_download` is also `true` and if\nthe item has a type of `file`."
                    },
                    "can_preview": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Defines if the shared link allows for the item to be previewed.\n\nThis value is always `true`. For shared links on folders this also\napplies to any items in the folder."
                    },
                    "can_download": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Defines if the shared link allows for the item to be downloaded. For\nshared links on folders, this also applies to any items in the folder.\n\nThis value can be set to `true` when the effective access level is\nset to `open` or `company`, not `collaborators`."
                    }
                  },
                  "description": "Defines if this link allows a user to preview, edit, and download an item.\nThese permissions refer to the shared link only and\ndo not supersede permissions applied to the item itself."
                },
                "unshared_at": {
                  "type": "string",
                  "format": "date-time",
                  "example": "2018-04-13T13:53:23-07:00",
                  "nullable": true,
                  "description": "The date and time when this link will be unshared. This field can only be\nset by users with paid accounts."
                },
                "vanity_name": {
                  "type": "string",
                  "example": "my_url",
                  "nullable": true,
                  "description": "The custom name of a shared link, as used in the `vanity_url` field."
                },
                "download_url": {
                  "type": "string",
                  "format": "url",
                  "example": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
                  "nullable": true,
                  "description": "A URL that can be used to download the file. This URL can be used in\na browser to download the file. This URL includes the file\nextension so that the file will be saved with the right file type.\n\nThis property will be `null` for folders.",
                  "x-box-premium-feature": true
                },
                "preview_count": {
                  "type": "integer",
                  "example": 3,
                  "nullable": false,
                  "description": "The number of times this item has been previewed."
                },
                "download_count": {
                  "type": "integer",
                  "example": 3,
                  "nullable": false,
                  "description": "The number of times this item has been downloaded."
                },
                "effective_access": {
                  "enum": [
                    "open",
                    "company",
                    "collaborators"
                  ],
                  "type": "string",
                  "example": "company",
                  "nullable": false,
                  "description": "The effective access level for the shared link. This can be a more\nrestrictive access level than the value in the `access` field when the\nenterprise settings restrict the allowed access levels."
                },
                "is_password_enabled": {
                  "type": "boolean",
                  "example": true,
                  "nullable": false,
                  "description": "Defines if the shared link requires a password to access the item."
                },
                "effective_permission": {
                  "enum": [
                    "can_edit",
                    "can_download",
                    "can_preview",
                    "no_access"
                  ],
                  "type": "string",
                  "example": "can_download",
                  "nullable": false,
                  "description": "The effective permissions for this shared link.\nThese result in the more restrictive combination of\nthe share link permissions and the item permissions set\nby the administrator, the owner, and any ancestor item\nsuch as a folder."
                }
              },
              "description": "Shared links provide direct, read-only access to files or folder on Box.\n\nShared links with open access level allow anyone with the URL\nto access the item, while shared links with company or collaborators access\nlevels can only be accessed by appropriately authenticated Box users."
            },
            {
              "description": "The shared link for this file. This will be\n`null` if no shared link has been created for this\nfile."
            },
            {
              "nullable": true
            }
          ]
        },
        "path_collection": {
          "allOf": [
            {
              "type": "object",
              "title": "Path collection",
              "required": [
                "total_count",
                "entries"
              ],
              "properties": {
                "entries": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Folder--Mini"
                  },
                  "nullable": false,
                  "description": "The parent folders for this item"
                },
                "total_count": {
                  "type": "integer",
                  "format": "int64",
                  "example": 1,
                  "nullable": false,
                  "description": "The number of folders in this list."
                }
              },
              "description": "A list of parent folders for an item."
            },
            {
              "description": "The tree of folders that this file is contained in,\nstarting at the root."
            },
            {
              "nullable": false
            }
          ]
        },
        "content_created_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": true,
          "description": "The date and time at which this file was originally\ncreated, which might be before it was uploaded to Box."
        },
        "content_modified_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": true,
          "description": "The date and time at which this file was last updated,\nwhich might be before it was uploaded to Box."
        }
      }
    }
  ],
  "title": "File",
  "description": "A standard representation of a file, as returned from any\nfile API endpoints by default",
  "x-box-variant": "standard",
  "x-box-resource-id": "file"
}

{
  "type": "object",
  "title": "File (Base)",
  "nullable": true,
  "required": [
    "id",
    "type"
  ],
  "x-box-tag": "files",
  "properties": {
    "id": {
      "type": "string",
      "example": "12345",
      "nullable": false,
      "description": "The unique identifier that represent a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."
    },
    "etag": {
      "type": "string",
      "example": "1",
      "nullable": true,
      "description": "The HTTP `etag` of this file. This can be used within some API\nendpoints in the `If-Match` and `If-None-Match` headers to only\nperform changes on the file if (no) changes have happened."
    },
    "type": {
      "enum": [
        "file"
      ],
      "type": "string",
      "example": "file",
      "nullable": false,
      "description": "`file`"
    }
  },
  "description": "The bare basic representation of a file, the minimal\namount of fields returned when using the `fields` query\nparameter.",
  "x-box-variant": "base",
  "x-box-variants": [
    "base",
    "mini",
    "standard",
    "full"
  ],
  "x-box-sanitized": true,
  "x-box-resource-id": "file--base"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/File"
    },
    {
      "properties": {
        "lock": {
          "allOf": [
            {
              "type": "object",
              "title": "Lock",
              "properties": {
                "id": {
                  "type": "string",
                  "example": "11446498",
                  "description": "The unique identifier for this lock"
                },
                "type": {
                  "enum": [
                    "lock"
                  ],
                  "type": "string",
                  "example": "lock",
                  "description": "`lock`"
                },
                "app_type": {
                  "enum": [
                    "gsuite",
                    "office_wopi",
                    "office_wopiplus",
                    "other"
                  ],
                  "type": "string",
                  "example": "office_wopiplus",
                  "nullable": true,
                  "description": "If the lock is managed by an application rather than a user, this\nfield identifies the type of the application that holds the lock.\nThis is an open enum and may be extended with additional values in\nthe future."
                },
                "created_at": {
                  "type": "string",
                  "format": "date-time",
                  "example": "2012-12-12T10:53:43-08:00",
                  "description": "The time this lock was created at."
                },
                "created_by": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/User--Mini"
                    },
                    {
                      "description": "The user who created the lock."
                    }
                  ]
                },
                "expired_at": {
                  "type": "string",
                  "format": "date-time",
                  "example": "2012-12-12T10:53:43-08:00",
                  "description": "The time this lock is to expire at, which might be in the past."
                },
                "is_download_prevented": {
                  "type": "boolean",
                  "example": true,
                  "description": "Whether or not the file can be downloaded while locked."
                }
              },
              "description": "The lock held on a file. A lock prevents a file from being moved,\nrenamed, or otherwise changed by anyone else than the user who created the\nlock."
            },
            {
              "description": "The lock held on this file. If there is no lock, this can either\nbe `null` or have a timestamp in the past."
            }
          ],
          "nullable": true
        },
        "tags": {
          "allOf": [
            {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": [
                "approved"
              ],
              "maxItems": 100,
              "minItems": 1,
              "description": "The tags for this item. These tags are shown in\nthe Box web app and mobile apps next to an item.\n\nTo add or remove a tag, retrieve the item's current tags,\nmodify them, and then update this field.\n\nThere is a limit of 100 tags per item, and 10,000\nunique tags per enterprise."
            },
            {
              "nullable": false
            }
          ]
        },
        "metadata": {
          "allOf": [
            {
              "type": "object",
              "title": "Item metadata instances",
              "example": {
                "enterprise_27335": {
                  "marketingCollateral": {
                    "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
                    "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
                    "$scope": "enterprise_27335",
                    "$parent": "folder_59449484661",
                    "$canEdit": true,
                    "$version": 1,
                    "$template": "marketingCollateral",
                    "$typeVersion": 2
                  }
                }
              },
              "description": "A list of metadata instances, nested within key-value pairs of their `scope`\nand `templateKey`.\n\nTo access the metadata for a file or folder, first use the\nmetadata endpoints to determine the metadata templates available to your\nenterprise.\n\nThen use the `GET /files/:id` or `GET /folder/:id`\nendpoint with the `fields` query parameter to get\nthe metadata by ID.\n\nTo request a metadata instance for a particular `scope` and `templateKey`\nuse the following format for the `fields` parameter:\n`metadata.<scope>.<templateKey>`\n\nFor example, `?fields=metadata.enterprise_27335.marketingCollateral`.",
              "additionalProperties": {
                "type": "object",
                "example": {
                  "marketingCollateral": {
                    "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
                    "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
                    "$scope": "enterprise_27335",
                    "$parent": "folder_59449484661",
                    "$canEdit": true,
                    "$version": 1,
                    "$template": "marketingCollateral",
                    "$typeVersion": 2
                  }
                },
                "description": "A list of metadata instances, nested within key-value pairs of their `scope`\nand `templateKey`.",
                "additionalProperties": {
                  "$ref": "#/components/schemas/Metadata--Base"
                }
              }
            },
            {
              "description": "An object containing the metadata instances that have been\nattached to this file.\n\nEach metadata instance is uniquely identified by its `scope` and\n`templateKey`. There can only be one instance of any metadata\ntemplate attached to each file. Each metadata instance is nested\nwithin an object with the `templateKey` as the key, which again\nitself is nested in an object with the `scope` as the key."
            }
          ]
        },
        "extension": {
          "type": "string",
          "example": "pdf",
          "description": "Indicates the (optional) file extension for this file. By default,\nthis is set to an empty string."
        },
        "expires_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": true,
          "description": "When the file will automatically be deleted"
        },
        "is_package": {
          "type": "boolean",
          "example": true,
          "description": "Indicates if the file is a package. Packages are commonly used\nby Mac Applications and can include iWork files."
        },
        "permissions": {
          "allOf": [
            {
              "type": "object",
              "allOf": [
                {
                  "type": "object",
                  "required": [
                    "can_delete",
                    "can_download",
                    "can_invite_collaborator",
                    "can_rename",
                    "can_set_share_access",
                    "can_share"
                  ],
                  "properties": {
                    "can_share": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the user can create a shared link for this item."
                    },
                    "can_delete": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the current user can delete this item."
                    },
                    "can_rename": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the user can rename this item."
                    },
                    "can_download": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the current user can download this item."
                    },
                    "can_set_share_access": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the user can change the access level of an\nexisting shared link on this item."
                    },
                    "can_invite_collaborator": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the current user can invite new\nusers to collaborate on this item, and if the user can\nupdate the role of a user already collaborated on this\nitem."
                    }
                  },
                  "description": "The permissions that the authenticated user has for an item."
                },
                {
                  "properties": {
                    "can_upload": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the user can upload a new version of this file."
                    },
                    "can_comment": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the user can place comments on this file."
                    },
                    "can_preview": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the user can preview this file."
                    },
                    "can_annotate": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the user can place annotations on this file."
                    },
                    "can_view_annotations_all": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the user view all annotations placed on this file"
                    },
                    "can_view_annotations_self": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the user view annotations placed by themselves\non this file"
                    }
                  }
                }
              ],
              "required": [
                "can_annotate",
                "can_comment",
                "can_preview",
                "can_upload",
                "can_view_annotations_all",
                "can_view_annotations_self"
              ],
              "description": "The permissions that the authenticated user has for a file."
            },
            {
              "description": "Describes the permissions that the current user has\nfor this file."
            },
            {
              "nullable": false
            }
          ]
        },
        "comment_count": {
          "type": "integer",
          "example": 10,
          "description": "The number of comments on this file"
        },
        "classification": {
          "allOf": [
            {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "example": "Top Secret",
                  "description": "The name of the classification"
                },
                "color": {
                  "type": "string",
                  "example": "#FF0000",
                  "description": "The color that is used to display the\nclassification label in a user-interface. Colors are defined by the admin\nor co-admin who created the classification in the Box web app."
                },
                "definition": {
                  "type": "string",
                  "example": "Content that should not be shared outside the company.",
                  "description": "An explanation of the meaning of this classification."
                }
              },
              "description": "The classification applied to an item"
            },
            {
              "description": "Details about the classification applied to this file."
            },
            {
              "nullable": true
            }
          ]
        },
        "disposition_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": true,
          "description": "The retention expiration timestamp for the given file"
        },
        "version_number": {
          "type": "string",
          "example": "1",
          "description": "The version number of this file"
        },
        "watermark_info": {
          "allOf": [
            {
              "type": "object",
              "properties": {
                "is_watermarked": {
                  "type": "boolean",
                  "example": true,
                  "nullable": false,
                  "description": "Specifies if this item has a watermark applied."
                }
              },
              "description": "Details about the watermark applied to this item"
            },
            {
              "description": "Details about the watermark applied to this file"
            }
          ]
        },
        "representations": {
          "allOf": [
            {
              "type": "object",
              "title": "Representations",
              "properties": {
                "entries": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "info": {
                        "type": "object",
                        "properties": {
                          "url": {
                            "type": "string",
                            "example": "https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048",
                            "description": "The API URL that can be used to get more info on this file\nrepresentation. Make sure to make an authenticated API call\nto this endpoint."
                          }
                        },
                        "description": "An object containing the URL that can be used to fetch more info\non this representation."
                      },
                      "status": {
                        "type": "object",
                        "properties": {
                          "state": {
                            "enum": [
                              "success",
                              "viewable",
                              "pending",
                              "none"
                            ],
                            "type": "string",
                            "example": "success",
                            "description": "The status of the representation.\n\n* `success` defines the representation as ready to be viewed.\n* `viewable` defines a video to be ready for viewing.\n* `pending` defines the representation as to be generated. Retry\n  this endpoint to re-check the status.\n* `none` defines that the representation will be created when\n  requested. Request the URL defined in the `info` object to\n  trigger this generation."
                          }
                        },
                        "description": "An object containing the status of this representation."
                      },
                      "content": {
                        "type": "object",
                        "properties": {
                          "url_template": {
                            "type": "string",
                            "example": "https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567",
                            "description": "The download URL that can be used to fetch the representation.\nMake sure to make an authenticated API call to this endpoint.\n\nThis URL is a template and will require the `{+asset_path}` to\nbe replaced by a path. In general, for unpaged representations\nit can be replaced by an empty string.\n\nFor paged representations, replace the `{+asset_path}` with the\npage to request plus the extension for the file, for example\n`1.pdf`.\n\nWhen requesting the download URL the following additional\nquery params can be passed along.\n\n* `set_content_disposition_type` - Sets the\n`Content-Disposition` header in the API response with the\nspecified disposition type of either `inline` or `attachment`.\nIf not supplied, the `Content-Disposition` header is not\nincluded in the response.\n\n* `set_content_disposition_filename` - Allows the application to\n  define the representation's file name used in the\n  `Content-Disposition` header.  If not defined, the filename\n  is derived from the source file name in Box combined with the\n  extension of the representation."
                          }
                        },
                        "description": "An object containing the URL that can be used to actually fetch\nthe representation."
                      },
                      "properties": {
                        "type": "object",
                        "properties": {
                          "paged": {
                            "type": "boolean",
                            "example": true,
                            "description": "Indicates if the representation is build up out of multiple\npages."
                          },
                          "thumb": {
                            "type": "boolean",
                            "example": true,
                            "description": "Indicates if the representation can be used as a thumbnail of\nthe file."
                          },
                          "dimensions": {
                            "type": "string",
                            "format": "<width>x<height>",
                            "example": "2048x2048",
                            "description": "The width by height size of this representation in pixels."
                          }
                        },
                        "description": "An object containing the size and type of this presentation."
                      },
                      "representation": {
                        "type": "string",
                        "example": "png",
                        "description": "Indicates the file type of the returned representation."
                      }
                    },
                    "description": "A file representation"
                  },
                  "description": "A list of files"
                }
              },
              "description": "A list of file representations"
            },
            {
              "description": "A list of representations for a file that can be used to\ndisplay a placeholder of the file in your application. By default\nthis returns all representations and we recommend using the\n`x-rep-hints` header to further customize the desired\nrepresentations."
            }
          ]
        },
        "has_collaborations": {
          "type": "boolean",
          "example": true,
          "nullable": false,
          "description": "Specifies if this file has any other collaborators."
        },
        "expiring_embed_link": {
          "allOf": [
            {
              "type": "object",
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "expires_in": {
                      "type": "integer",
                      "format": "int64",
                      "example": 3600,
                      "description": "The time in seconds by which this token will expire."
                    },
                    "token_type": {
                      "enum": [
                        "bearer"
                      ],
                      "type": "string",
                      "example": "bearer",
                      "description": "The type of access token returned."
                    },
                    "access_token": {
                      "type": "string",
                      "format": "token",
                      "example": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ",
                      "description": "The requested access token."
                    },
                    "restricted_to": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/FileOrFolderScope"
                      },
                      "description": "The permissions that this access token permits,\nproviding a list of resources (files, folders, etc)\nand the scopes permitted for each of those resources."
                    }
                  },
                  "description": "The basics of an access token"
                },
                {
                  "properties": {
                    "url": {
                      "type": "string",
                      "format": "url",
                      "example": "https://cloud.app.box.com/preview/expiring_embed/...",
                      "description": "The actual expiring embed URL for this file, constructed\nfrom the file ID and access tokens specified in this object."
                    }
                  }
                }
              ],
              "title": "Expiring embed link",
              "description": "An expiring Box Embed Link."
            },
            {
              "description": "Requesting this field creates an expiring Box Embed URL for an\nembedded preview session in an `iframe`.\n\nThis URL will expire after 60 seconds and the session will\nexpire after 60 minutes.\n\nNot all file types are supported for these embed URLs. Box Embed\nis not optimized for mobile browsers and should not be used in web\nexperiences designed for mobile devices. Many UI elements, like\nthe **download** and **print** options might not show in mobile\nbrowsers."
            }
          ]
        },
        "is_externally_owned": {
          "type": "boolean",
          "example": true,
          "nullable": false,
          "description": "Specifies if this file is owned by a user outside of the\nauthenticated enterprise."
        },
        "allowed_invitee_roles": {
          "type": "array",
          "items": {
            "enum": [
              "editor",
              "viewer",
              "previewer",
              "uploader",
              "previewer uploader",
              "viewer uploader",
              "co-owner"
            ],
            "type": "string"
          },
          "example": [
            "editor"
          ],
          "nullable": false,
          "description": "A list of the types of roles that user can be invited at\nwhen sharing this file."
        },
        "uploader_display_name": {
          "allOf": [
            {
              "type": "string",
              "title": "Uploader display name",
              "example": "Ellis Wiggins",
              "nullable": false,
              "description": "The display name of the user that uploaded the file. In most cases this is the\nname of the user logged in at the time of the upload.\n\nIf the file was uploaded using a File Request form that requires the user to\nprovide an email address, this field is populated with that email address. If\nan email address was not required in the File Request form, this field is set\nto return a value of `File Request`.\n\nIn all other anonymous cases where no email was provided this field\nwill default to a value of `Someone`."
            }
          ]
        },
        "is_accessible_via_shared_link": {
          "enum": [
            true,
            false
          ],
          "type": "boolean",
          "example": true,
          "description": "Specifies if the file can be accessed\nvia the direct shared link or a shared link\nto a parent folder."
        },
        "shared_link_permission_options": {
          "type": "array",
          "items": {
            "enum": [
              "can_preview",
              "can_download",
              "can_edit"
            ],
            "type": "string"
          },
          "example": [
            "can_preview"
          ],
          "nullable": true,
          "description": "A list of the types of roles that user can be invited at\nwhen sharing this file."
        }
      }
    }
  ],
  "title": "File (Full)",
  "description": "A full representation of a file, as can be returned from any\nfile API endpoints by default",
  "x-box-variant": "full",
  "x-box-resource-id": "file--full"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/File--Base"
    },
    {
      "properties": {
        "name": {
          "type": "string",
          "example": "Contract.pdf",
          "description": "The name of the file"
        },
        "sha1": {
          "type": "string",
          "format": "digest",
          "example": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
          "nullable": false,
          "description": "The SHA1 hash of the file. This can be used to compare the contents\nof a file on Box with a local file."
        },
        "sequence_id": {
          "allOf": [
            {
              "type": "string",
              "example": "3",
              "nullable": true,
              "description": "A numeric identifier that represents the most recent user event\nthat has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint\nto filter out user events that would have occurred before this\nidentifier was read.\n\nAn example would be where a Box Drive-like application\nwould fetch an item via the API, and then listen to incoming\nuser events for changes to the item. The application would\nignore any user events where the `sequence_id` in the event\nis smaller than or equal to the `sequence_id` in the originally\nfetched resource."
            },
            {
              "nullable": false
            }
          ]
        },
        "file_version": {
          "allOf": [
            {
              "$ref": "#/components/schemas/FileVersion--Mini"
            },
            {
              "description": "The information about the current version of the file."
            }
          ]
        }
      }
    }
  ],
  "title": "File (Mini)",
  "nullable": true,
  "description": "A mini representation of a file, used when\nnested under another resource.",
  "x-box-variant": "mini",
  "x-box-resource-id": "file--mini"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/File--Mini"
    },
    {
      "properties": {
        "sha1": {
          "type": "string",
          "example": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
          "description": "The SHA1 hash of the file."
        },
        "file_version": {
          "$ref": "#/components/schemas/FileVersion--Mini"
        }
      }
    }
  ],
  "title": "File (Conflict)",
  "x-box-tag": null,
  "description": "A representation of a file that is used to show",
  "x-box-sanitized": true,
  "x-box-resource-id": "file_conflict"
}

{
  "type": "object",
  "title": "File or folder scope",
  "properties": {
    "scope": {
      "enum": [
        "annotation_edit",
        "annotation_view_all",
        "annotation_view_self",
        "base_explorer",
        "base_picker",
        "base_preview",
        "base_upload",
        "item_delete",
        "item_download",
        "item_preview",
        "item_rename",
        "item_share"
      ],
      "type": "string",
      "example": "item_download",
      "description": "The scopes for the resource access"
    },
    "object": {
      "allOf": [
        {
          "oneOf": [
            {
              "$ref": "#/components/schemas/Folder--Mini"
            },
            {
              "$ref": "#/components/schemas/File--Mini"
            }
          ]
        },
        {
          "description": "The file or folder resource"
        }
      ]
    }
  },
  "description": "A relation between a resource (file or folder) and the scopes for which the resource can be accessed"
}

{
  "type": "object",
  "title": "File Request",
  "required": [
    "id",
    "type",
    "folder",
    "created_at",
    "updated_at"
  ],
  "x-box-tag": "file_requests",
  "properties": {
    "id": {
      "type": "string",
      "example": "42037322",
      "readOnly": true,
      "description": "The unique identifier for this file request."
    },
    "url": {
      "type": "string",
      "example": "/f/19e57f40ace247278a8e3d336678c64a",
      "readOnly": true,
      "description": "The generated URL for this file request. This URL can be shared\nwith users to let them upload files to the associated folder."
    },
    "etag": {
      "type": "string",
      "example": "1",
      "nullable": true,
      "description": "The HTTP `etag` of this file. This can be used in combination with\nthe `If-Match` header when updating a file request. By providing that\nheader, a change will only be performed on the  file request if the `etag`\non the file request still matches the `etag` provided in the `If-Match`\nheader."
    },
    "type": {
      "enum": [
        "file_request"
      ],
      "type": "string",
      "example": "file_request",
      "readOnly": true,
      "description": "`file_request`"
    },
    "title": {
      "type": "string",
      "example": "Please upload documents",
      "description": "The title of file request. This is shown\nin the Box UI to users uploading files.\n\nThis defaults to title of the file request that was\ncopied to create this file request."
    },
    "folder": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Folder--Mini"
        },
        {
          "description": "The folder that this file request is associated with.\n\nFiles submitted through the file request form will be\nuploaded to this folder."
        }
      ],
      "nullable": false
    },
    "status": {
      "enum": [
        "active",
        "inactive"
      ],
      "type": "string",
      "example": "active",
      "description": "The status of the file request. This defaults\nto `active`.\n\nWhen the status is set to `inactive`, the file request\nwill no longer accept new submissions, and any visitor\nto the file request URL will receive a `HTTP 404` status\ncode.\n\nThis defaults to status of file request that was\ncopied to create this file request."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2020-09-28T10:53:43-08:00",
      "nullable": false,
      "description": "The date and time when the file request was created."
    },
    "created_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Mini"
        },
        {
          "description": "The user who created this file request."
        }
      ]
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "example": "2020-09-28T10:53:43-08:00",
      "description": "The date after which a file request will no longer accept new\nsubmissions.\n\nAfter this date, the `status` will automatically be set to\n`inactive`."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2020-09-28T10:53:43-08:00",
      "nullable": false,
      "description": "The date and time when the file request was last updated."
    },
    "updated_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Mini"
        },
        {
          "description": "The user who last modified this file request."
        },
        {
          "nullable": false
        }
      ]
    },
    "description": {
      "type": "string",
      "example": "Following documents are requested for your process",
      "nullable": true,
      "description": "The optional description of this file request. This is\nshown in the Box UI to users uploading files.\n\nThis defaults to description of the file request that was\ncopied to create this file request."
    },
    "is_email_required": {
      "type": "boolean",
      "example": true,
      "description": "Whether a file request submitter is required to provide\ntheir email address.\n\nWhen this setting is set to true, the Box UI will show\nan email field on the file request form.\n\nThis defaults to setting of file request that was\ncopied to create this file request."
    },
    "is_description_required": {
      "type": "boolean",
      "example": true,
      "description": "Whether a file request submitter is required to provide\na description of the files they are submitting.\n\nWhen this setting is set to true, the Box UI will show\na description field on the file request form.\n\nThis defaults to setting of file request that was\ncopied to create this file request."
    }
  },
  "description": "A standard representation of a file request, as returned\nfrom any file request API endpoints by default.",
  "x-box-resource-id": "file_request"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/FileRequestUpdateRequest"
    },
    {
      "properties": {
        "folder": {
          "type": "object",
          "required": [
            "id"
          ],
          "properties": {
            "id": {
              "type": "string",
              "example": "42037322",
              "description": "The ID of the folder to associate the new\nfile request to."
            },
            "type": {
              "enum": [
                "folder"
              ],
              "type": "string",
              "example": "folder",
              "description": "`folder`"
            }
          },
          "description": "The folder to associate the new file request to."
        }
      }
    }
  ],
  "title": "File Request (Copy)",
  "required": [
    "folder"
  ],
  "description": "The request body to copy a file request."
}

{
  "type": "object",
  "title": "File Request (Update)",
  "properties": {
    "title": {
      "type": "string",
      "example": "Please upload required documents",
      "description": "An optional new title for the file request. This can be\nused to change the title of the file request.\n\nThis will default to the value on the existing file request."
    },
    "status": {
      "enum": [
        "active",
        "inactive"
      ],
      "type": "string",
      "example": "active",
      "description": "An optional new status of the file request.\n\nWhen the status is set to `inactive`, the file request\nwill no longer accept new submissions, and any visitor\nto the file request URL will receive a `HTTP 404` status\ncode.\n\nThis will default to the value on the existing file request."
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "example": "2020-09-28T10:53:43-08:00",
      "description": "The date after which a file request will no longer accept new\nsubmissions.\n\nAfter this date, the `status` will automatically be set to\n`inactive`.\n\nThis will default to the value on the existing file request."
    },
    "description": {
      "type": "string",
      "example": "Please upload required documents",
      "description": "An optional new description for the file request. This can be\nused to change the description of the file request.\n\nThis will default to the value on the existing file request."
    },
    "is_email_required": {
      "type": "boolean",
      "example": true,
      "description": "Whether a file request submitter is required to provide\ntheir email address.\n\nWhen this setting is set to true, the Box UI will show\nan email field on the file request form.\n\nThis will default to the value on the existing file request."
    },
    "is_description_required": {
      "type": "boolean",
      "example": true,
      "description": "Whether a file request submitter is required to provide\na description of the files they are submitting.\n\nWhen this setting is set to true, the Box UI will show\na description field on the file request form.\n\nThis will default to the value on the existing file request."
    }
  },
  "description": "The request body to update a file request."
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/FileVersion--Mini"
    },
    {
      "properties": {
        "name": {
          "type": "string",
          "example": "tigers.jpeg",
          "description": "The name of the file version"
        },
        "size": {
          "type": "integer",
          "format": "int64",
          "example": 629644,
          "description": "Size of the file version in bytes"
        },
        "purged_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": true,
          "description": "When the file version object will be permanently deleted."
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "description": "When the file version object was created"
        },
        "trashed_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": true,
          "description": "When the file version object was trashed."
        },
        "trashed_by": {
          "allOf": [
            {
              "$ref": "#/components/schemas/User--Mini"
            },
            {
              "description": "The user who trashed the file version"
            }
          ]
        },
        "modified_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "description": "When the file version object was last updated"
        },
        "modified_by": {
          "allOf": [
            {
              "$ref": "#/components/schemas/User--Mini"
            },
            {
              "description": "The user who last updated the file version"
            }
          ]
        },
        "restored_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": true,
          "description": "When the file version was restored from the trash."
        },
        "restored_by": {
          "allOf": [
            {
              "$ref": "#/components/schemas/User--Mini"
            },
            {
              "description": "The user who restored the file version from the trash."
            }
          ]
        },
        "uploader_display_name": {
          "allOf": [
            {
              "type": "string",
              "title": "Uploader display name",
              "example": "Ellis Wiggins",
              "nullable": false,
              "description": "The display name of the user that uploaded the file. In most cases this is the\nname of the user logged in at the time of the upload.\n\nIf the file was uploaded using a File Request form that requires the user to\nprovide an email address, this field is populated with that email address. If\nan email address was not required in the File Request form, this field is set\nto return a value of `File Request`.\n\nIn all other anonymous cases where no email was provided this field\nwill default to a value of `Someone`."
            }
          ]
        }
      }
    }
  ],
  "title": "File version",
  "description": "A standard representation of a file version",
  "x-box-variant": "standard",
  "x-box-resource-id": "file_version"
}

{
  "type": "object",
  "title": "File version (Base)",
  "required": [
    "id",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "12345",
      "nullable": false,
      "description": "The unique identifier that represent a file version."
    },
    "type": {
      "enum": [
        "file_version"
      ],
      "type": "string",
      "example": "file_version",
      "nullable": false,
      "description": "`file_version`"
    }
  },
  "description": "The bare basic representation of a file version, the minimal\namount of fields returned when using the `fields` query\nparameter.",
  "x-box-variant": "base",
  "x-box-variants": [
    "base",
    "mini",
    "standard",
    "full"
  ],
  "x-box-sanitized": true,
  "x-box-resource-id": "file_version--base"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/FileVersion"
    },
    {
      "properties": {
        "version_number": {
          "type": "string",
          "example": "1",
          "description": "The version number of this file version"
        }
      }
    }
  ],
  "title": "File version (Full)",
  "description": "A full representation of a file version, as can be returned from any\nfile version API endpoints by default",
  "x-box-variant": "full",
  "x-box-resource-id": "file_version--full"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/FileVersion--Base"
    },
    {
      "properties": {
        "sha1": {
          "type": "string",
          "example": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
          "description": "The SHA1 hash of this version of the file."
        }
      }
    }
  ],
  "title": "File version (Mini)",
  "description": "A mini representation of a file version, used when\nnested within another resource.",
  "x-box-variant": "mini",
  "x-box-resource-id": "file_version--mini"
}

{
  "type": "object",
  "title": "File version legal hold",
  "x-box-tag": "file_version_legal_holds",
  "properties": {
    "id": {
      "type": "string",
      "example": "11446498",
      "description": "The unique identifier for this file version legal hold"
    },
    "file": {
      "allOf": [
        {
          "$ref": "#/components/schemas/File--Mini"
        },
        {
          "description": "The file for the file version held.\nNote that there is no guarantee that the current\nversion of this file is held."
        }
      ]
    },
    "type": {
      "enum": [
        "file_version_legal_hold"
      ],
      "type": "string",
      "example": "file_version_legal_hold",
      "description": "`file_version_legal_hold`"
    },
    "deleted_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-12T10:53:43-08:00",
      "description": "Time that this File-Version-Legal-Hold was\ndeleted."
    },
    "file_version": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FileVersion--Mini"
        },
        {
          "description": "The file version that is held"
        }
      ]
    },
    "legal_hold_policy_assignments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LegalHoldPolicyAssignment"
      },
      "description": "List of assignments contributing to this Hold."
    }
  },
  "description": "File-Version-Legal-Hold is an entity representing all\nholds on a File Version.",
  "x-box-resource-id": "file_version_legal_hold"
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "next_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
          "nullable": true,
          "description": "The marker for the start of the next page of results."
        },
        "prev_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
          "nullable": true,
          "description": "The marker for the start of the previous page of results."
        }
      },
      "description": "The part of an API response that describes marker\nbased pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/FileVersionLegalHold"
          },
          "description": "A list of file version legal holds"
        }
      }
    }
  ],
  "title": "File version legal holds",
  "x-box-tag": "file_version_legal_holds",
  "description": "A list of file version legal holds.",
  "x-box-resource-id": "file_version_legal_holds"
}

{
  "type": "object",
  "title": "File version retention",
  "x-box-tag": "file_version_retentions",
  "properties": {
    "id": {
      "type": "string",
      "example": "11446498",
      "description": "The unique identifier for this file version retention."
    },
    "file": {
      "allOf": [
        {
          "$ref": "#/components/schemas/File--Mini"
        },
        {
          "description": "The file this file version retention was applied to"
        }
      ]
    },
    "type": {
      "enum": [
        "file_version_retention"
      ],
      "type": "string",
      "example": "file_version_retention",
      "description": "`file_version_retention`"
    },
    "applied_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-12T10:53:43-08:00",
      "description": "When this file version retention object was\ncreated"
    },
    "file_version": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FileVersion--Mini"
        },
        {
          "description": "The file version this file version retention was\napplied to"
        }
      ]
    },
    "disposition_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-12T10:53:43-08:00",
      "description": "When the retention expires on this file\nversion retention"
    },
    "winning_retention_policy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RetentionPolicy--Mini"
        },
        {
          "description": "The winning retention policy applied to this file\nversion retention. A file version can have multiple\nretention policies applied."
        }
      ]
    }
  },
  "description": "A retention policy blocks permanent deletion of content\nfor a specified amount of time. Admins can apply policies to\nspecified folders, or an entire enterprise. A file version retention\nis a  record for a retained file version. To use this feature,\nyou must  have the manage retention policies scope enabled for your\nAPI key via  your application management console. For more information\nabout retention policies, please visit our help documentation",
  "x-box-resource-id": "file_version_retention"
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "next_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
          "nullable": true,
          "description": "The marker for the start of the next page of results."
        },
        "prev_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
          "nullable": true,
          "description": "The marker for the start of the previous page of results."
        }
      },
      "description": "The part of an API response that describes marker\nbased pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/FileVersionRetention"
          },
          "description": "A list of file version retentions"
        }
      }
    }
  ],
  "title": "File version retentions",
  "x-box-tag": "file_version_retentions",
  "description": "A list of file version retentions.",
  "x-box-resource-id": "file_version_retentions"
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "order": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "by": {
                "type": "string",
                "example": "type",
                "description": "The field to order by"
              },
              "direction": {
                "enum": [
                  "ASC",
                  "DESC"
                ],
                "type": "string",
                "example": "ASC",
                "description": "The direction to order by, either ascending or descending"
              }
            },
            "description": "The order in which a pagination is ordered"
          },
          "description": "The order by which items are returned.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        },
        "offset": {
          "type": "integer",
          "format": "int64",
          "example": 2000,
          "description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        },
        "total_count": {
          "type": "integer",
          "format": "int64",
          "example": 5000,
          "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        }
      },
      "description": "The part of an API response that describes pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/FileVersion--Full"
          },
          "description": "A list of file versions"
        }
      }
    }
  ],
  "title": "File versions",
  "x-box-tag": "file_versions",
  "description": "A list of file versions",
  "x-box-resource-id": "file_versions"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "11446498",
      "description": "The file version ID"
    },
    "type": {
      "enum": [
        "file_version"
      ],
      "type": "string",
      "example": "file_version",
      "description": "The type to promote"
    }
  },
  "description": "The file version to promote"
}

{
  "type": "object",
  "properties": {
    "trashed_at": {
      "type": "string",
      "example": "null",
      "description": "Set this to `null` to clear\nthe date and restore the file."
    }
  },
  "description": "The file version to be\nrestored"
}

{
  "type": "object",
  "title": "Files",
  "x-box-tag": "files",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/File--Full"
      },
      "description": "A list of files"
    },
    "total_count": {
      "type": "integer",
      "format": "int64",
      "example": 1,
      "description": "The number of files."
    }
  },
  "description": "A list of files",
  "x-box-resource-id": "files"
}

{
  "type": "object",
  "nullable": false,
  "required": [
    "parent"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "FileCopy.txt",
      "maxLength": 255,
      "description": "An optional new name for the copied file.\n\nThere are some restrictions to the file name. Names containing\nnon-printable ASCII characters, forward and backward slashes\n(`/`, `\\`), and protected names like `.` and `..` are\nautomatically sanitized by removing the non-allowed\ncharacters."
    },
    "parent": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "0",
          "description": "The ID of folder to copy the file to."
        }
      },
      "description": "The destination folder to copy the file to."
    },
    "version": {
      "type": "string",
      "example": "0",
      "description": "An optional ID of the specific file version to copy."
    }
  }
}

{
  "type": "string",
  "format": "binary",
  "description": "The thumbnail"
}

{
  "type": "string",
  "format": "binary",
  "description": "The thumbnail"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "File.mp4",
      "description": "The name for the file"
    },
    "size": {
      "type": "integer",
      "format": "int32",
      "example": 1024,
      "description": "The size of the file in bytes"
    },
    "parent": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "example": "123",
              "description": "The ID of parent item"
            }
          },
          "description": "The parent for this item"
        },
        {
          "description": "The parent folder to upload the file to"
        }
      ]
    }
  }
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "next_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
          "nullable": true,
          "description": "The marker for the start of the next page of results."
        },
        "prev_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
          "nullable": true,
          "description": "The marker for the start of the previous page of results."
        }
      },
      "description": "The part of an API response that describes marker\nbased pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/File--Mini"
          },
          "description": "A list of files"
        }
      }
    }
  ],
  "title": "Files under retention",
  "x-box-tag": "retention_policy_assignments",
  "description": "A list of files under retention.",
  "x-box-resource-id": "files_under_retention"
}

{
  "type": "object",
  "properties": {
    "lock": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "access": {
          "enum": [
            "lock"
          ],
          "type": "string",
          "example": "lock",
          "description": "The type of this object."
        },
        "expires_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "description": "Defines the time at which the lock expires."
        },
        "is_download_prevented": {
          "type": "boolean",
          "example": true,
          "description": "Defines if the file can be downloaded while it is locked."
        }
      },
      "description": "Defines a lock on an item. This prevents the item from being\nmoved, renamed, or otherwise changed by anyone other than the user\nwho created the lock.\n\nSet this to `null` to remove the lock."
    },
    "name": {
      "type": "string",
      "example": "NewFile.txt",
      "description": "An optional different name for the file. This can be used to\nrename the file."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "approved"
      ],
      "maxItems": 100,
      "minItems": 1,
      "description": "The tags for this item. These tags are shown in\nthe Box web app and mobile apps next to an item.\n\nTo add or remove a tag, retrieve the item's current tags,\nmodify them, and then update this field.\n\nThere is a limit of 100 tags per item, and 10,000\nunique tags per enterprise."
    },
    "parent": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "example": "123",
              "description": "The ID of parent item"
            }
          },
          "description": "The parent for this item"
        },
        {
          "description": "An optional new parent folder for the file. This can be used\nto move the file to a new folder."
        }
      ]
    },
    "collections": {
      "type": "array",
      "items": {
        "type": "object",
        "title": "Reference",
        "properties": {
          "id": {
            "type": "string",
            "example": "11446498",
            "description": "The unique identifier for this object"
          },
          "type": {
            "type": "string",
            "example": "file",
            "description": "The type for this object"
          }
        },
        "description": "The bare basic reference for an object"
      },
      "description": "An array of collections to make this file\na member of. Currently\nwe only support the `favorites` collection.\n\nTo get the ID for a collection, use the\n[List all collections][1] endpoint.\n\nPassing an empty array `[]` or `null` will remove\nthe file from all collections.\n\n[1]: e://get-collections"
    },
    "description": {
      "type": "string",
      "example": "The latest reports. Automatically updated",
      "maxLength": 256,
      "description": "The description for a file. This can be seen in the right-hand sidebar panel\nwhen viewing a file in the Box web app. Additionally, this index is used in\nthe search index of the file, allowing users to find the file by the content\nin the description."
    },
    "permissions": {
      "type": "object",
      "properties": {
        "can_download": {
          "enum": [
            "open",
            "company"
          ],
          "type": "string",
          "example": "open",
          "description": "Defines who is allowed to download this file. The possible\nvalues are either `open` for everyone or `company` for\nthe other members of the user's enterprise.\n\nThis setting overrides the download permissions that are\nnormally part of the `role` of a collaboration. When set to\n`company`, this essentially removes the download option for\nexternal users with `viewer` or `editor` a roles."
        }
      },
      "description": "Defines who can download a file."
    },
    "shared_link": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "access": {
              "enum": [
                "open",
                "company",
                "collaborators"
              ],
              "type": "string",
              "example": "open",
              "description": "The level of access for the shared link. This can be\nrestricted to anyone with the link (`open`), only people\nwithin the company (`company`) and only those who\nhave been invited to the folder (`collaborators`).\n\nIf not set, this field defaults to the access level specified\nby the enterprise admin. To create a shared link with this\ndefault setting pass the `shared_link` object with\nno `access` field, for example `{ \"shared_link\": {} }`.\n\nThe `company` access level is only available to paid\naccounts."
            },
            "password": {
              "type": "string",
              "example": "do-n8t-use-this-Password",
              "description": "The password required to access the shared link. Set the\npassword to `null` to remove it.\nPasswords must now be at least eight characters\nlong and include a number, upper case letter, or\na non-numeric or non-alphabetic character.\nA password can only be set when `access` is set to `open`."
            },
            "permissions": {
              "type": "object",
              "properties": {
                "can_download": {
                  "type": "boolean",
                  "example": true,
                  "description": "If the shared link allows for downloading of files.\nThis can only be set when `access` is set to\n`open` or `company`."
                }
              }
            },
            "unshared_at": {
              "type": "string",
              "format": "date-time",
              "example": "2012-12-12T10:53:43-08:00",
              "description": "The timestamp at which this shared link will\nexpire. This field can only be set by\nusers with paid accounts."
            },
            "vanity_name": {
              "type": "string",
              "example": "my-shared-link",
              "description": "Defines a custom vanity name to use in the shared link URL,\nfor example `https://app.box.com/v/my-shared-link`.\n\nCustom URLs should not be used when sharing sensitive content\nas vanity URLs are a lot easier to guess than regular shared links."
            }
          },
          "description": "Defines a shared link for an item. Set this to `null` to remove\nthe shared link."
        },
        {
          "description": "Defines a shared link for a file. Set this to `null` to remove\nthe shared link."
        }
      ]
    },
    "disposition_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-12T10:53:43-08:00",
      "description": "The retention expiration timestamp for the given file. This\ndate cannot be shortened once set on a file."
    }
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Folder--Mini"
    },
    {
      "properties": {
        "size": {
          "type": "integer",
          "format": "int64",
          "example": 629644,
          "nullable": false,
          "description": "The folder size in bytes.\n\nBe careful parsing this integer as its\nvalue can get very large."
        },
        "parent": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Folder--Mini"
            },
            {
              "description": "The optional folder that this folder is located within.\n\nThis value may be `null` for some folders such as the\nroot folder or the trash folder."
            }
          ],
          "nullable": true
        },
        "owned_by": {
          "allOf": [
            {
              "$ref": "#/components/schemas/User--Mini"
            },
            {
              "description": "The user who owns this folder."
            },
            {
              "nullable": false
            }
          ]
        },
        "purged_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": true,
          "description": "The time at which this folder is expected to be purged\nfrom the trash."
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": true,
          "description": "The date and time when the folder was created. This value may\nbe `null` for some folders such as the root folder or the trash\nfolder."
        },
        "created_by": {
          "allOf": [
            {
              "$ref": "#/components/schemas/User--Mini"
            },
            {
              "description": "The user who created this folder"
            },
            {
              "nullable": false
            }
          ]
        },
        "trashed_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": true,
          "description": "The time at which this folder was put in the trash."
        },
        "description": {
          "allOf": [
            {
              "type": "string",
              "example": "Legal contracts for the new ACME deal",
              "nullable": false,
              "maxLength": 256,
              "description": "The optional description of this folder"
            },
            {
              "nullable": false
            }
          ]
        },
        "item_status": {
          "enum": [
            "active",
            "trashed",
            "deleted"
          ],
          "type": "string",
          "example": "active",
          "nullable": false,
          "description": "Defines if this item has been deleted or not.\n\n* `active` when the item has is not in the trash\n* `trashed` when the item has been moved to the trash but not deleted\n* `deleted` when the item has been permanently deleted."
        },
        "modified_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": true,
          "description": "The date and time when the folder was last updated. This value may\nbe `null` for some folders such as the root folder or the trash\nfolder."
        },
        "modified_by": {
          "allOf": [
            {
              "$ref": "#/components/schemas/User--Mini"
            },
            {
              "description": "The user who last modified this folder."
            },
            {
              "nullable": false
            }
          ]
        },
        "shared_link": {
          "allOf": [
            {
              "type": "object",
              "title": "Shared link",
              "required": [
                "url",
                "accessed",
                "effective_access",
                "effective_permission",
                "is_password_enabled",
                "download_count",
                "preview_count"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "format": "url",
                  "example": "https://www.box.com/s/vspke7y05sb214wjokpk",
                  "nullable": false,
                  "description": "The URL that can be used to access the item on Box.\n\nThis URL will display the item in Box's preview UI where the file\ncan be downloaded if allowed.\n\nThis URL will continue to work even when a custom `vanity_url`\nhas been set for this shared link."
                },
                "access": {
                  "enum": [
                    "open",
                    "company",
                    "collaborators"
                  ],
                  "type": "string",
                  "example": "open",
                  "nullable": false,
                  "description": "The access level for this shared link.\n\n* `open` - provides access to this item to anyone with this link\n* `company` - only provides access to this item to people the same company\n* `collaborators` - only provides access to this item to people who are\n   collaborators on this item\n\nIf this field is omitted when creating the shared link, the access level\nwill be set to the default access level specified by the enterprise admin."
                },
                "vanity_url": {
                  "type": "string",
                  "format": "url",
                  "example": "https://acme.app.box.com/v/my_url/",
                  "nullable": true,
                  "description": "The \"Custom URL\" that can also be used to preview the item on Box.  Custom\nURLs can only be created or modified in the Box Web application."
                },
                "permissions": {
                  "type": "object",
                  "required": [
                    "can_download",
                    "can_preview",
                    "can_edit"
                  ],
                  "properties": {
                    "can_edit": {
                      "type": "boolean",
                      "example": false,
                      "nullable": false,
                      "description": "Defines if the shared link allows for the item to be edited.\n\nThis value can only be `true` if `can_download` is also `true` and if\nthe item has a type of `file`."
                    },
                    "can_preview": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Defines if the shared link allows for the item to be previewed.\n\nThis value is always `true`. For shared links on folders this also\napplies to any items in the folder."
                    },
                    "can_download": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Defines if the shared link allows for the item to be downloaded. For\nshared links on folders, this also applies to any items in the folder.\n\nThis value can be set to `true` when the effective access level is\nset to `open` or `company`, not `collaborators`."
                    }
                  },
                  "description": "Defines if this link allows a user to preview, edit, and download an item.\nThese permissions refer to the shared link only and\ndo not supersede permissions applied to the item itself."
                },
                "unshared_at": {
                  "type": "string",
                  "format": "date-time",
                  "example": "2018-04-13T13:53:23-07:00",
                  "nullable": true,
                  "description": "The date and time when this link will be unshared. This field can only be\nset by users with paid accounts."
                },
                "vanity_name": {
                  "type": "string",
                  "example": "my_url",
                  "nullable": true,
                  "description": "The custom name of a shared link, as used in the `vanity_url` field."
                },
                "download_url": {
                  "type": "string",
                  "format": "url",
                  "example": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
                  "nullable": true,
                  "description": "A URL that can be used to download the file. This URL can be used in\na browser to download the file. This URL includes the file\nextension so that the file will be saved with the right file type.\n\nThis property will be `null` for folders.",
                  "x-box-premium-feature": true
                },
                "preview_count": {
                  "type": "integer",
                  "example": 3,
                  "nullable": false,
                  "description": "The number of times this item has been previewed."
                },
                "download_count": {
                  "type": "integer",
                  "example": 3,
                  "nullable": false,
                  "description": "The number of times this item has been downloaded."
                },
                "effective_access": {
                  "enum": [
                    "open",
                    "company",
                    "collaborators"
                  ],
                  "type": "string",
                  "example": "company",
                  "nullable": false,
                  "description": "The effective access level for the shared link. This can be a more\nrestrictive access level than the value in the `access` field when the\nenterprise settings restrict the allowed access levels."
                },
                "is_password_enabled": {
                  "type": "boolean",
                  "example": true,
                  "nullable": false,
                  "description": "Defines if the shared link requires a password to access the item."
                },
                "effective_permission": {
                  "enum": [
                    "can_edit",
                    "can_download",
                    "can_preview",
                    "no_access"
                  ],
                  "type": "string",
                  "example": "can_download",
                  "nullable": false,
                  "description": "The effective permissions for this shared link.\nThese result in the more restrictive combination of\nthe share link permissions and the item permissions set\nby the administrator, the owner, and any ancestor item\nsuch as a folder."
                }
              },
              "description": "Shared links provide direct, read-only access to files or folder on Box.\n\nShared links with open access level allow anyone with the URL\nto access the item, while shared links with company or collaborators access\nlevels can only be accessed by appropriately authenticated Box users."
            },
            {
              "description": "The shared link for this folder. This will be\n`null` if no shared link has been created for this\nfolder."
            }
          ],
          "nullable": true
        },
        "item_collection": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Items"
            },
            {
              "description": "A page of the items that are in the folder.\n\nThis field can only be requested when querying a folder's\ninformation, not when querying a folder's items."
            },
            {
              "nullable": false
            }
          ]
        },
        "path_collection": {
          "allOf": [
            {
              "type": "object",
              "title": "Path collection",
              "required": [
                "total_count",
                "entries"
              ],
              "properties": {
                "entries": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Folder--Mini"
                  },
                  "nullable": false,
                  "description": "The parent folders for this item"
                },
                "total_count": {
                  "type": "integer",
                  "format": "int64",
                  "example": 1,
                  "nullable": false,
                  "description": "The number of folders in this list."
                }
              },
              "description": "A list of parent folders for an item."
            },
            {
              "description": "The tree of folders that this folder is contained in,\nstarting at the root."
            },
            {
              "nullable": false
            }
          ]
        },
        "content_created_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": true,
          "description": "The date and time at which this folder was originally\ncreated."
        },
        "content_modified_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": true,
          "description": "The date and time at which this folder was last updated."
        },
        "folder_upload_email": {
          "type": "object",
          "nullable": true,
          "properties": {
            "email": {
              "type": "string",
              "format": "email",
              "example": "upload.Contracts.asd7asd@u.box.com",
              "nullable": false,
              "description": "The optional upload email address for this folder."
            },
            "access": {
              "enum": [
                "open",
                "collaborators"
              ],
              "type": "string",
              "example": "open",
              "nullable": false,
              "description": "When this parameter has been set, users can email files\nto the email address that has been automatically\ncreated for this folder.\n\nTo create an email address, set this property either when\ncreating or updating the folder.\n\nWhen set to `collaborators`, only emails from registered email\naddresses for collaborators will be accepted. This includes\nany email aliases a user might have registered.\n\nWhen set to `open` it will accept emails from any email\naddress."
            }
          }
        }
      }
    }
  ],
  "title": "Folder",
  "description": "A standard representation of a folder, as returned from any\nfolder API endpoints by default",
  "x-box-variant": "standard",
  "x-box-resource-id": "folder"
}

{
  "type": "object",
  "title": "Folder (Base)",
  "required": [
    "id",
    "type"
  ],
  "x-box-tag": "folders",
  "properties": {
    "id": {
      "type": "string",
      "example": "12345",
      "nullable": false,
      "description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting a folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folders/123`\nthe `folder_id` is `123`."
    },
    "etag": {
      "type": "string",
      "example": "1",
      "nullable": true,
      "description": "The HTTP `etag` of this folder. This can be used within some API\nendpoints in the `If-Match` and `If-None-Match` headers to only\nperform changes on the folder if (no) changes have happened."
    },
    "type": {
      "enum": [
        "folder"
      ],
      "type": "string",
      "example": "folder",
      "nullable": false,
      "description": "`folder`"
    }
  },
  "description": "The bare basic representation of a folder, the minimal\namount of fields returned when using the `fields` query\nparameter.",
  "x-box-variant": "base",
  "x-box-variants": [
    "base",
    "mini",
    "standard",
    "full"
  ],
  "x-box-sanitized": true,
  "x-box-resource-id": "folder--base"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Folder"
    },
    {
      "properties": {
        "tags": {
          "allOf": [
            {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": [
                "approved"
              ],
              "maxItems": 100,
              "minItems": 1,
              "description": "The tags for this item. These tags are shown in\nthe Box web app and mobile apps next to an item.\n\nTo add or remove a tag, retrieve the item's current tags,\nmodify them, and then update this field.\n\nThere is a limit of 100 tags per item, and 10,000\nunique tags per enterprise."
            },
            {
              "nullable": false
            }
          ]
        },
        "metadata": {
          "allOf": [
            {
              "type": "object",
              "title": "Item metadata instances",
              "example": {
                "enterprise_27335": {
                  "marketingCollateral": {
                    "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
                    "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
                    "$scope": "enterprise_27335",
                    "$parent": "folder_59449484661",
                    "$canEdit": true,
                    "$version": 1,
                    "$template": "marketingCollateral",
                    "$typeVersion": 2
                  }
                }
              },
              "description": "A list of metadata instances, nested within key-value pairs of their `scope`\nand `templateKey`.\n\nTo access the metadata for a file or folder, first use the\nmetadata endpoints to determine the metadata templates available to your\nenterprise.\n\nThen use the `GET /files/:id` or `GET /folder/:id`\nendpoint with the `fields` query parameter to get\nthe metadata by ID.\n\nTo request a metadata instance for a particular `scope` and `templateKey`\nuse the following format for the `fields` parameter:\n`metadata.<scope>.<templateKey>`\n\nFor example, `?fields=metadata.enterprise_27335.marketingCollateral`.",
              "additionalProperties": {
                "type": "object",
                "example": {
                  "marketingCollateral": {
                    "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
                    "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
                    "$scope": "enterprise_27335",
                    "$parent": "folder_59449484661",
                    "$canEdit": true,
                    "$version": 1,
                    "$template": "marketingCollateral",
                    "$typeVersion": 2
                  }
                },
                "description": "A list of metadata instances, nested within key-value pairs of their `scope`\nand `templateKey`.",
                "additionalProperties": {
                  "$ref": "#/components/schemas/Metadata--Base"
                }
              }
            },
            {
              "description": "An object containing the metadata instances that have been\nattached to this folder.\n\nEach metadata instance is uniquely identified by its `scope` and\n`templateKey`. There can only be one instance of any metadata\ntemplate attached to each folder. Each metadata instance is nested\nwithin an object with the `templateKey` as the key, which again\nitself is nested in an object with the `scope` as the key."
            }
          ]
        },
        "sync_state": {
          "allOf": [
            {
              "enum": [
                "synced",
                "not_synced",
                "partially_synced"
              ],
              "type": "string",
              "example": "synced",
              "nullable": false,
              "description": "Specifies whether a folder should be synced to a\nuser's device or not. This is used by Box Sync\n(discontinued) and is not used by Box Drive."
            }
          ]
        },
        "permissions": {
          "allOf": [
            {
              "type": "object",
              "allOf": [
                {
                  "type": "object",
                  "required": [
                    "can_delete",
                    "can_download",
                    "can_invite_collaborator",
                    "can_rename",
                    "can_set_share_access",
                    "can_share"
                  ],
                  "properties": {
                    "can_share": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the user can create a shared link for this item."
                    },
                    "can_delete": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the current user can delete this item."
                    },
                    "can_rename": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the user can rename this item."
                    },
                    "can_download": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the current user can download this item."
                    },
                    "can_set_share_access": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the user can change the access level of an\nexisting shared link on this item."
                    },
                    "can_invite_collaborator": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the current user can invite new\nusers to collaborate on this item, and if the user can\nupdate the role of a user already collaborated on this\nitem."
                    }
                  },
                  "description": "The permissions that the authenticated user has for an item."
                },
                {
                  "properties": {
                    "can_upload": {
                      "type": "boolean",
                      "example": true,
                      "nullable": false,
                      "description": "Specifies if the user can upload into this folder."
                    }
                  }
                }
              ],
              "required": [
                "can_upload"
              ],
              "description": "The permissions that the authenticated user has for a folder."
            },
            {
              "description": "Describes the permissions that the current user has\nfor this folder"
            },
            {
              "nullable": false
            }
          ]
        },
        "classification": {
          "allOf": [
            {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "example": "Top Secret",
                  "description": "The name of the classification"
                },
                "color": {
                  "type": "string",
                  "example": "#FF0000",
                  "description": "The color that is used to display the\nclassification label in a user-interface. Colors are defined by the admin\nor co-admin who created the classification in the Box web app."
                },
                "definition": {
                  "type": "string",
                  "example": "Content that should not be shared outside the company.",
                  "description": "An explanation of the meaning of this classification."
                }
              },
              "description": "The classification applied to an item"
            },
            {
              "description": "Details about the classification applied to this folder."
            },
            {
              "nullable": true
            }
          ]
        },
        "watermark_info": {
          "allOf": [
            {
              "type": "object",
              "properties": {
                "is_watermarked": {
                  "type": "boolean",
                  "example": true,
                  "nullable": false,
                  "description": "Specifies if this item has a watermark applied."
                }
              },
              "description": "Details about the watermark applied to this item"
            },
            {
              "description": "Details about the watermark applied to this folder"
            },
            {
              "nullable": false
            }
          ]
        },
        "has_collaborations": {
          "type": "boolean",
          "example": true,
          "nullable": false,
          "description": "Specifies if this folder has any other collaborators."
        },
        "is_externally_owned": {
          "type": "boolean",
          "example": true,
          "nullable": false,
          "description": "Specifies if this folder is owned by a user outside of the\nauthenticated enterprise."
        },
        "allowed_invitee_roles": {
          "type": "array",
          "items": {
            "enum": [
              "editor",
              "viewer",
              "previewer",
              "uploader",
              "previewer uploader",
              "viewer uploader",
              "co-owner"
            ],
            "type": "string"
          },
          "example": [
            "editor"
          ],
          "nullable": false,
          "description": "A list of the types of roles that user can be invited at\nwhen sharing this folder."
        },
        "can_non_owners_invite": {
          "allOf": [
            {
              "type": "boolean",
              "example": true,
              "description": "Specifies if users who are not the owner\nof the folder can invite new collaborators to the folder."
            },
            {
              "nullable": false
            }
          ]
        },
        "is_accessible_via_shared_link": {
          "enum": [
            true,
            false
          ],
          "type": "boolean",
          "example": true,
          "description": "Specifies if the folder can be accessed\nwith the direct shared link or a shared link\nto a parent folder."
        },
        "allowed_shared_link_access_levels": {
          "type": "array",
          "items": {
            "enum": [
              "open",
              "company",
              "collaborators"
            ],
            "type": "string"
          },
          "example": [
            "open"
          ],
          "nullable": false,
          "description": "A list of access levels that are available\nfor this folder.\n\nFor some folders, like the root folder, this will always\nbe an empty list as sharing is not allowed at that level."
        },
        "can_non_owners_view_collaborators": {
          "type": "boolean",
          "example": true,
          "description": "Specifies if collaborators who are not owners\nof this folder are restricted from viewing other\ncollaborations on this folder.\n\nIt also restricts non-owners from inviting new\ncollaborators."
        },
        "is_collaboration_restricted_to_enterprise": {
          "allOf": [
            {
              "type": "boolean",
              "example": true,
              "description": "Specifies if new invites to this folder are restricted to users\nwithin the enterprise. This does not affect existing\ncollaborations."
            },
            {
              "nullable": false
            }
          ]
        }
      }
    }
  ],
  "title": "Folder (Full)",
  "description": "A full representation of a folder, as can be returned from any\nfolder API endpoints by default",
  "x-box-variant": "full",
  "x-box-resource-id": "folder--full"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Folder--Base"
    },
    {
      "properties": {
        "name": {
          "type": "string",
          "example": "Contracts",
          "nullable": false,
          "description": "The name of the folder."
        },
        "sequence_id": {
          "allOf": [
            {
              "type": "string",
              "example": "3",
              "nullable": true,
              "description": "A numeric identifier that represents the most recent user event\nthat has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint\nto filter out user events that would have occurred before this\nidentifier was read.\n\nAn example would be where a Box Drive-like application\nwould fetch an item via the API, and then listen to incoming\nuser events for changes to the item. The application would\nignore any user events where the `sequence_id` in the event\nis smaller than or equal to the `sequence_id` in the originally\nfetched resource."
            },
            {
              "nullable": false
            }
          ]
        }
      }
    }
  ],
  "title": "Folder (Mini)",
  "description": "A mini representation of a file version, used when\nnested under another resource.",
  "x-box-variant": "mini",
  "x-box-resource-id": "folder--mini"
}

{
  "type": "object",
  "title": "Folder Lock",
  "x-box-tag": "folder_locks",
  "properties": {
    "id": {
      "type": "string",
      "example": "12345678",
      "description": "The unique identifier for this folder lock."
    },
    "type": {
      "type": "string",
      "example": "folder_lock",
      "description": "The object type, always `folder_lock`."
    },
    "folder": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Folder--Mini"
        },
        {
          "description": "The folder that the lock applies to."
        }
      ]
    },
    "lock_type": {
      "type": "string",
      "example": "freeze",
      "description": "The lock type, always `freeze`."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2020-09-14T23:12:53Z",
      "description": "When the folder lock object was created."
    },
    "created_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Base"
        },
        {
          "description": "The user or group that created the lock."
        }
      ]
    },
    "locked_operations": {
      "type": "object",
      "required": [
        "move",
        "delete"
      ],
      "properties": {
        "move": {
          "type": "boolean",
          "example": true,
          "nullable": false,
          "description": "Whether moving the folder is restricted."
        },
        "delete": {
          "type": "boolean",
          "example": true,
          "nullable": false,
          "description": "Whether deleting the folder is restricted."
        }
      },
      "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"
    }
  },
  "description": "Folder locks define access restrictions placed by folder owners\nto prevent specific folders from being moved or deleted.",
  "x-box-resource-id": "folder_lock"
}

{
  "type": "object",
  "title": "Folder Locks",
  "x-box-tag": "folder_locks",
  "properties": {
    "limit": {
      "type": "string",
      "example": "1000",
      "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
    },
    "entries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FolderLock"
      },
      "description": "A list of folder locks"
    },
    "next_marker": {
      "type": "string",
      "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
      "nullable": true,
      "description": "The marker for the start of the next page of results."
    }
  },
  "description": "A list of folder locks",
  "x-box-resource-id": "folder_locks"
}

{
  "type": "object",
  "required": [
    "folder"
  ],
  "properties": {
    "folder": {
      "type": "object",
      "required": [
        "type",
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "1234567890",
          "description": "The ID of the folder."
        },
        "type": {
          "type": "string",
          "example": "folder",
          "description": "The content type the lock is being applied to. Only `folder`\nis supported."
        }
      },
      "description": "The folder to apply the lock to."
    },
    "locked_operations": {
      "type": "object",
      "required": [
        "move",
        "delete"
      ],
      "properties": {
        "move": {
          "type": "boolean",
          "example": true,
          "description": "Whether moving the folder should be locked."
        },
        "delete": {
          "type": "boolean",
          "example": true,
          "description": "Whether deleting the folder should be locked."
        }
      },
      "description": "The operations to lock for the folder. If `locked_operations` is\nincluded in the request, both `move` and `delete` must also be\nincluded and both set to `true`."
    }
  }
}

{
  "type": "object",
  "nullable": false,
  "required": [
    "parent"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "New Folder",
      "maxLength": 255,
      "minLength": 1,
      "description": "An optional new name for the copied folder.\n\nThere are some restrictions to the file name. Names containing\nnon-printable ASCII characters, forward and backward slashes\n(`/`, `\\`), as well as names with trailing spaces are\nprohibited.\n\nAdditionally, the names `.` and `..` are\nnot allowed either."
    },
    "parent": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "0",
          "description": "The ID of parent folder"
        }
      },
      "description": "The destination folder to copy the folder to."
    }
  }
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "New Folder",
      "description": "The optional new name for this folder."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "approved"
      ],
      "maxItems": 100,
      "minItems": 1,
      "description": "The tags for this item. These tags are shown in\nthe Box web app and mobile apps next to an item.\n\nTo add or remove a tag, retrieve the item's current tags,\nmodify them, and then update this field.\n\nThere is a limit of 100 tags per item, and 10,000\nunique tags per enterprise."
    },
    "parent": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "0",
          "description": "The ID of the new parent folder"
        }
      },
      "description": "The parent folder for this folder. Use this to move\nthe folder or to restore it out of the trash."
    },
    "sync_state": {
      "enum": [
        "synced",
        "not_synced",
        "partially_synced"
      ],
      "type": "string",
      "example": "synced",
      "nullable": false,
      "description": "Specifies whether a folder should be synced to a\nuser's device or not. This is used by Box Sync\n(discontinued) and is not used by Box Drive."
    },
    "collections": {
      "type": "array",
      "items": {
        "type": "object",
        "title": "Reference",
        "properties": {
          "id": {
            "type": "string",
            "example": "11446498",
            "description": "The unique identifier for this object"
          },
          "type": {
            "type": "string",
            "example": "file",
            "description": "The type for this object"
          }
        },
        "description": "The bare basic reference for an object"
      },
      "description": "An array of collections to make this folder\na member of. Currently\nwe only support the `favorites` collection.\n\nTo get the ID for a collection, use the\n[List all collections][1] endpoint.\n\nPassing an empty array `[]` or `null` will remove\nthe folder from all collections.\n\n[1]: e://get-collections"
    },
    "description": {
      "type": "string",
      "example": "Legal contracts for the new ACME deal",
      "nullable": false,
      "maxLength": 256,
      "description": "The optional description of this folder"
    },
    "shared_link": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "access": {
              "enum": [
                "open",
                "company",
                "collaborators"
              ],
              "type": "string",
              "example": "open",
              "description": "The level of access for the shared link. This can be\nrestricted to anyone with the link (`open`), only people\nwithin the company (`company`) and only those who\nhave been invited to the folder (`collaborators`).\n\nIf not set, this field defaults to the access level specified\nby the enterprise admin. To create a shared link with this\ndefault setting pass the `shared_link` object with\nno `access` field, for example `{ \"shared_link\": {} }`.\n\nThe `company` access level is only available to paid\naccounts."
            },
            "password": {
              "type": "string",
              "example": "do-n8t-use-this-Password",
              "description": "The password required to access the shared link. Set the\npassword to `null` to remove it.\nPasswords must now be at least eight characters\nlong and include a number, upper case letter, or\na non-numeric or non-alphabetic character.\nA password can only be set when `access` is set to `open`."
            },
            "permissions": {
              "type": "object",
              "properties": {
                "can_download": {
                  "type": "boolean",
                  "example": true,
                  "description": "If the shared link allows for downloading of files.\nThis can only be set when `access` is set to\n`open` or `company`."
                }
              }
            },
            "unshared_at": {
              "type": "string",
              "format": "date-time",
              "example": "2012-12-12T10:53:43-08:00",
              "description": "The timestamp at which this shared link will\nexpire. This field can only be set by\nusers with paid accounts."
            },
            "vanity_name": {
              "type": "string",
              "example": "my-shared-link",
              "description": "Defines a custom vanity name to use in the shared link URL,\nfor example `https://app.box.com/v/my-shared-link`.\n\nCustom URLs should not be used when sharing sensitive content\nas vanity URLs are a lot easier to guess than regular shared links."
            }
          },
          "description": "Defines a shared link for an item. Set this to `null` to remove\nthe shared link."
        },
        {
          "description": "Enables the creation of a shared link for a folder."
        }
      ]
    },
    "folder_upload_email": {
      "allOf": [
        {
          "type": "object",
          "title": "Folder upload email",
          "properties": {
            "access": {
              "enum": [
                "open",
                "collaborators"
              ],
              "type": "string",
              "example": "open",
              "nullable": false,
              "description": "When this parameter has been set, users can email files\nto the email address that has been automatically\ncreated for this folder.\n\nTo create an email address, set this property either when\ncreating or updating the folder.\n\nWhen set to `collaborators`, only emails from registered email\naddresses for collaborators will be accepted. This includes\nany email aliases a user might have registered.\n\nWhen set to `open` it will accept emails from any email\naddress."
            }
          },
          "description": "The Write Folder Upload Email object"
        },
        {
          "description": "Setting this object enables the upload email address.\n\nThis email address can be used by users to directly\nupload files directly to the folder via email.\n\nSetting the value to `null` will disable the email address."
        }
      ]
    },
    "can_non_owners_invite": {
      "type": "boolean",
      "example": true,
      "description": "Specifies if users who are not the owner\nof the folder can invite new collaborators to the folder."
    },
    "can_non_owners_view_collaborators": {
      "type": "boolean",
      "example": true,
      "description": "Restricts collaborators who are not the owner of\nthis folder from viewing other collaborations on\nthis folder.\n\nIt also restricts non-owners from inviting new\ncollaborators.\n\nWhen setting this field to `false`, it is required\nto also set `can_non_owners_invite_collaborators` to\n`false` if it has not already been set."
    },
    "is_collaboration_restricted_to_enterprise": {
      "type": "boolean",
      "example": true,
      "description": "Specifies if new invites to this folder are restricted to users\nwithin the enterprise. This does not affect existing\ncollaborations."
    }
  }
}

{
  "type": "object",
  "title": "Generic source",
  "description": "A generic event source type.",
  "x-box-resource-id": "generic_source",
  "additionalProperties": {
    "allOf": [
      {},
      {
        "description": "A definition of a generic\nevent source object. The set of\nparameters depends on the\nobject type. For example, a Box Shield\nevent source would have the following\nset of parameters:\n```yaml\n{\n\"barrier_id\": 123456,\n\"barrier_status\": \"ENABLED\",\n\"barrier_segments\": [\n  {\n      \"name\": \"8\",\n      \"member_count\": 1\n    },\n  {\n      \"name\": \"9\",\n      \"member_count\": 1\n           }\n       ]\n}   \n```\n"
      }
    ]
  }
}

{
  "type": "string",
  "format": "html"
}

{
  "type": "string",
  "format": "html"
}

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/SearchResults"
    },
    {
      "$ref": "#/components/schemas/SearchResultsWithSharedLinks"
    }
  ]
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Group--Mini"
    },
    {
      "properties": {
        "created_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "description": "When the group object was created"
        },
        "modified_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "description": "When the group object was last modified"
        }
      }
    }
  ],
  "title": "Group",
  "description": "A standard representation of a group, as returned from any\ngroup API endpoints by default",
  "x-box-variant": "standard",
  "x-box-resource-id": "group"
}

{
  "type": "object",
  "title": "Group (Base)",
  "required": [
    "id",
    "type"
  ],
  "x-box-tag": "groups",
  "properties": {
    "id": {
      "type": "string",
      "example": "11446498",
      "description": "The unique identifier for this object"
    },
    "type": {
      "enum": [
        "group"
      ],
      "type": "string",
      "example": "group",
      "description": "`group`"
    }
  },
  "description": "A base representation of a group.",
  "x-box-variant": "base",
  "x-box-variants": [
    "base",
    "mini",
    "standard",
    "full"
  ],
  "x-box-sanitized": true,
  "x-box-resource-id": "group--base"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Group"
    },
    {
      "properties": {
        "provenance": {
          "type": "string",
          "example": "Active Directory",
          "maxLength": 255,
          "description": "Keeps track of which external source this group is\ncoming from (e.g. \"Active Directory\", \"Google Groups\",\n\"Facebook Groups\").  Setting this will\nalso prevent Box users from editing the group name\nand its members directly via the Box web application.\nThis is desirable for one-way syncing of groups."
        },
        "description": {
          "type": "string",
          "example": "Support Group - as imported from Active Directory",
          "maxLength": 255,
          "description": "Human readable description of the group."
        },
        "permissions": {
          "allOf": [
            {
              "type": "object",
              "properties": {
                "can_invite_as_collaborator": {
                  "type": "boolean",
                  "example": true,
                  "description": "Specifies if the user can invite the group to collaborate on any items."
                }
              },
              "description": "The permissions that the authenticated user has for a group."
            },
            {
              "description": "Describes the permissions that the current user has\nfor this group."
            }
          ]
        },
        "invitability_level": {
          "enum": [
            "admins_only",
            "admins_and_members",
            "all_managed_users"
          ],
          "type": "string",
          "example": "admins_only",
          "description": "Specifies who can invite the group to collaborate\non items.\n\nWhen set to `admins_only` the enterprise admin, co-admins,\nand the group's admin can invite the group.\n\nWhen set to `admins_and_members` all the admins listed\nabove and group members can invite the group.\n\nWhen set to `all_managed_users` all managed users in the\nenterprise can invite the group."
        },
        "external_sync_identifier": {
          "type": "string",
          "example": "AD:123456",
          "description": "An arbitrary identifier that can be used by\nexternal group sync tools to link this Box Group to\nan external group. Example values of this field\ncould be an Active Directory Object ID or a Google\nGroup ID.  We recommend you use of this field in\norder to avoid issues when group names are updated in\neither Box or external systems."
        },
        "member_viewability_level": {
          "enum": [
            "admins_only",
            "admins_and_members",
            "all_managed_users"
          ],
          "type": "string",
          "example": "admins_only",
          "description": "Specifies who can view the members of the group\n(Get Memberships for Group).\n\n* `admins_only` - the enterprise admin, co-admins, group's\n  group admin\n* `admins_and_members` - all admins and group members\n* `all_managed_users` - all managed users in the\n  enterprise"
        }
      }
    }
  ],
  "title": "Group (Full)",
  "description": "Groups contain a set of users, and can be used in place of\nusers in some operations, such as collaborations.",
  "x-box-variant": "full",
  "x-box-resource-id": "group--full"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Group--Base"
    },
    {
      "properties": {
        "name": {
          "type": "string",
          "example": "Support",
          "description": "The name of the group"
        },
        "group_type": {
          "enum": [
            "managed_group",
            "all_users_group"
          ],
          "type": "string",
          "example": "managed_group",
          "description": "The type of the group."
        }
      }
    }
  ],
  "title": "Group (Mini)",
  "description": "Mini representation of a group, including id and name of\ngroup.",
  "x-box-variant": "mini",
  "x-box-resource-id": "group--mini"
}

{
  "type": "object",
  "title": "Group membership",
  "x-box-tag": "memberships",
  "properties": {
    "id": {
      "type": "string",
      "example": "11446498",
      "description": "The unique identifier for this group membership"
    },
    "role": {
      "enum": [
        "member",
        "admin"
      ],
      "type": "string",
      "example": "member",
      "description": "The role of the user in the group."
    },
    "type": {
      "enum": [
        "group_membership"
      ],
      "type": "string",
      "example": "group_membership",
      "description": "`group_membership`"
    },
    "user": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Mini"
        },
        {
          "description": "The user that the membership applies to"
        }
      ]
    },
    "group": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Group--Mini"
        },
        {
          "description": "The group that the membership applies to"
        }
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-12T10:53:43-08:00",
      "description": "The time this membership was created."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-12T10:53:43-08:00",
      "description": "The time this membership was last modified."
    }
  },
  "description": "Membership is used to signify that a user is part of a\ngroup.",
  "x-box-resource-id": "group_membership"
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "order": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "by": {
                "type": "string",
                "example": "type",
                "description": "The field to order by"
              },
              "direction": {
                "enum": [
                  "ASC",
                  "DESC"
                ],
                "type": "string",
                "example": "ASC",
                "description": "The direction to order by, either ascending or descending"
              }
            },
            "description": "The order in which a pagination is ordered"
          },
          "description": "The order by which items are returned.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        },
        "offset": {
          "type": "integer",
          "format": "int64",
          "example": 2000,
          "description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        },
        "total_count": {
          "type": "integer",
          "format": "int64",
          "example": 5000,
          "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        }
      },
      "description": "The part of an API response that describes pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/GroupMembership"
          },
          "description": "A list of group memberships"
        }
      }
    }
  ],
  "title": "Group memberships",
  "x-box-tag": "memberships",
  "description": "A list of group memberships.",
  "x-box-resource-id": "group_memberships"
}

{
  "type": "object",
  "required": [
    "user",
    "group"
  ],
  "properties": {
    "role": {
      "enum": [
        "member",
        "admin"
      ],
      "type": "string",
      "example": "member",
      "description": "The role of the user in the group."
    },
    "user": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "1434325",
          "description": "The ID of the user to add to the group"
        }
      },
      "description": "The user to add to the group."
    },
    "group": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "4545523",
          "description": "The ID of the group to add the user to"
        }
      },
      "description": "The group to add the user to."
    },
    "configurable_permissions": {
      "type": "object",
      "example": {
        "can_run_reports": true
      },
      "description": "Custom configuration for the permissions an admin\nif a group will receive. This option has no effect\non members with a role of `member`.\n\nSetting these permissions overwrites the default\naccess levels of an admin.\n\nSpecifying a value of \"null\" for this object will disable\nall configurable permissions. Specifying permissions will set\nthem accordingly, omitted permissions will be enabled by default.",
      "additionalProperties": {
        "type": "boolean",
        "example": true,
        "description": "A key value pair of custom permissions.",
        "x-box-example-key": "can_run_reports"
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "role": {
      "enum": [
        "member",
        "admin"
      ],
      "type": "string",
      "example": "member",
      "description": "The role of the user in the group."
    },
    "configurable_permissions": {
      "type": "object",
      "example": {
        "can_run_reports": true
      },
      "description": "Custom configuration for the permissions an admin\nif a group will receive. This option has no effect\non members with a role of `member`.\n\nSetting these permissions overwrites the default\naccess levels of an admin.\n\nSpecifying a value of \"null\" for this object will disable\nall configurable permissions. Specifying permissions will set\nthem accordingly, omitted permissions will be enabled by default.",
      "additionalProperties": {
        "type": "boolean",
        "example": true,
        "description": "A key value pair of custom permissions.",
        "x-box-example-key": "can_run_reports"
      }
    }
  }
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "order": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "by": {
                "type": "string",
                "example": "type",
                "description": "The field to order by"
              },
              "direction": {
                "enum": [
                  "ASC",
                  "DESC"
                ],
                "type": "string",
                "example": "ASC",
                "description": "The direction to order by, either ascending or descending"
              }
            },
            "description": "The order in which a pagination is ordered"
          },
          "description": "The order by which items are returned.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        },
        "offset": {
          "type": "integer",
          "format": "int64",
          "example": 2000,
          "description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        },
        "total_count": {
          "type": "integer",
          "format": "int64",
          "example": 5000,
          "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        }
      },
      "description": "The part of an API response that describes pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Group--Full"
          },
          "description": "A list of groups"
        }
      }
    }
  ],
  "title": "Groups",
  "x-box-tag": "groups",
  "description": "A list of groups.",
  "x-box-resource-id": "groups"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "Customer Support",
      "description": "The name of the new group to be created. Must be unique within the\nenterprise."
    },
    "provenance": {
      "type": "string",
      "example": "Active Directory",
      "maxLength": 255,
      "description": "Keeps track of which external source this group is\ncoming, for example `Active Directory`, or `Okta`.\n\nSetting this will also prevent Box admins from editing\nthe group name and its members directly via the Box\nweb application.\n\nThis is desirable for one-way syncing of groups."
    },
    "description": {
      "type": "string",
      "example": "\"Customer Support Group - as imported from Active Directory\"",
      "maxLength": 255,
      "description": "A human readable description of the group."
    },
    "invitability_level": {
      "enum": [
        "admins_only",
        "admins_and_members",
        "all_managed_users"
      ],
      "type": "string",
      "example": "admins_only",
      "description": "Specifies who can invite the group to collaborate\non folders.\n\nWhen set to `admins_only` the enterprise admin, co-admins,\nand the group's admin can invite the group.\n\nWhen set to `admins_and_members` all the admins listed\nabove and group members can invite the group.\n\nWhen set to `all_managed_users` all managed users in the\nenterprise can invite the group."
    },
    "external_sync_identifier": {
      "type": "string",
      "example": "AD:123456",
      "description": "An arbitrary identifier that can be used by\nexternal group sync tools to link this Box Group to\nan external group.\n\nExample values of this field\ncould be an **Active Directory Object ID** or a **Google\nGroup ID**.\n\nWe recommend you use of this field in\norder to avoid issues when group names are updated in\neither Box or external systems."
    },
    "member_viewability_level": {
      "enum": [
        "admins_only",
        "admins_and_members",
        "all_managed_users"
      ],
      "type": "string",
      "example": "admins_only",
      "description": "Specifies who can see the members of the group.\n\n* `admins_only` - the enterprise admin, co-admins, group's\n  group admin\n* `admins_and_members` - all admins and group members\n* `all_managed_users` - all managed users in the\n  enterprise"
    }
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/IntegrationMapping--Base"
    },
    {
      "properties": {
        "type": {
          "enum": [
            "integration_mapping"
          ],
          "type": "string",
          "example": "integration_mapping",
          "nullable": false,
          "description": "Mapping type"
        },
        "options": {
          "type": "object",
          "anyOf": [
            {
              "$ref": "#/components/schemas/IntegrationMappingSlackOptions"
            }
          ],
          "example": {},
          "nullable": false,
          "description": "Integration mapping options for Slack"
        },
        "box_item": {
          "$ref": "#/components/schemas/Folder--Mini"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": false,
          "description": "When the integration mapping object was created"
        },
        "created_by": {
          "$ref": "#/components/schemas/UserIntegrationMappings"
        },
        "modified_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "nullable": false,
          "description": "When the integration mapping object was last modified"
        },
        "modified_by": {
          "$ref": "#/components/schemas/UserIntegrationMappings"
        },
        "partner_item": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/IntegrationMappingPartnerItemSlack"
            }
          ],
          "nullable": false,
          "description": "Mapped item object for Slack"
        },
        "is_manually_created": {
          "type": "boolean",
          "example": true,
          "nullable": false,
          "description": "Identifies whether the mapping has\nbeen manually set\n(as opposed to being automatically created)"
        }
      }
    }
  ],
  "title": "Integration mapping",
  "required": [
    "type",
    "partner_item",
    "box_item"
  ],
  "x-box-tag": "integration_mappings",
  "description": "A standard representation of an integration\nmapping object.",
  "x-box-variant": "standard",
  "x-box-resource-id": "integration_mapping"
}

{
  "type": "object",
  "title": "Integration mapping (Base)",
  "x-box-tag": "integration_mappings",
  "properties": {
    "id": {
      "type": "string",
      "example": "12345",
      "nullable": false,
      "description": "A unique identifier of a folder mapping\n(part of a composite key together\nwith `integration_type`)"
    },
    "integration_type": {
      "enum": [
        "slack"
      ],
      "type": "string",
      "example": "slack",
      "nullable": false,
      "description": "Identifies the Box partner app,\nwith which the mapping is associated.\nCurrently only supports Slack.\n(part of the composite key together with `id`)"
    }
  },
  "description": "A base representation of an\nintegration mapping object.",
  "x-box-variant": "base",
  "x-box-variants": [
    "base",
    "standard",
    "mini"
  ],
  "x-box-resource-id": "integration_mapping--base"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/IntegrationMapping--Base"
    },
    {
      "properties": {
        "box_item_id": {
          "type": "string",
          "example": "123124351",
          "nullable": false,
          "description": "ID of the Box item mapped to the object referenced in `partner_item_id`"
        },
        "box_item_type": {
          "enum": [
            "folder"
          ],
          "type": "string",
          "example": "folder",
          "nullable": false,
          "description": "Type of the Box object referenced in `box_item_id`"
        },
        "partner_item_id": {
          "type": "string",
          "example": "C12351346",
          "nullable": false,
          "description": "ID of the mapped partner item"
        },
        "partner_item_type": {
          "enum": [
            "channel"
          ],
          "type": "string",
          "example": "channel",
          "nullable": false,
          "description": "Domain-specific type of the mapped partner item"
        }
      }
    }
  ],
  "title": "Integration mapping (Mini)",
  "x-box-tag": "integration_mappings",
  "description": "A mini representation of an\nintegration mapping object.",
  "x-box-variant": "mini",
  "x-box-resource-id": "integration_mapping--mini"
}

{
  "type": "object",
  "title": "Integration mapping Box item schema for type Slack",
  "required": [
    "id",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "1234567891",
      "nullable": false,
      "description": "ID of the mapped item (of type referenced in `type`)"
    },
    "type": {
      "enum": [
        "folder"
      ],
      "type": "string",
      "example": "folder",
      "nullable": false,
      "description": "Type of the mapped item referenced in `id`"
    }
  },
  "description": "The schema for an integration mapping Box item object for type Slack"
}

{
  "type": "object",
  "title": "Integration mapping mapped item schema for type Slack",
  "required": [
    "id",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "C12378991223",
      "nullable": false,
      "description": "ID of the mapped item (of type referenced in `type`)"
    },
    "type": {
      "enum": [
        "channel"
      ],
      "type": "string",
      "example": "channel",
      "nullable": false,
      "description": "Type of the mapped item referenced in `id`"
    },
    "slack_org_id": {
      "type": "string",
      "example": "E1234567",
      "nullable": true,
      "description": "ID of the Slack org with which the item is associated. Use this parameter if Box for Slack is installed at the org level. Do not use `slack_workspace_id` at the same time."
    },
    "slack_workspace_id": {
      "type": "string",
      "example": "T12352314",
      "nullable": true,
      "description": "ID of the Slack workspace with which the item is associated. Use this parameter if Box for Slack is installed at a workspace level. Do not use `slack_org_id` at the same time."
    }
  },
  "description": "The schema for an integration mapping mapped item object for type Slack.\n\nDepending if Box for Slack is installed at the org or workspace level,\nprovide **either** `slack_org_id` **or** `slack_workspace_id`.\nDo not use both parameters at the same time."
}

{
  "type": "object",
  "title": "Create integration mapping request",
  "required": [
    "partner_item",
    "box_item"
  ],
  "properties": {
    "options": {
      "$ref": "#/components/schemas/IntegrationMappingSlackOptions"
    },
    "box_item": {
      "$ref": "#/components/schemas/IntegrationMappingBoxItemSlack"
    },
    "partner_item": {
      "$ref": "#/components/schemas/IntegrationMappingPartnerItemSlack"
    }
  },
  "description": "A request to create a\nSlack Integration Mapping object",
  "x-box-resource-id": "integration_mapping_slack_create_request",
  "x-konfig-properties": {
    "options": {
      "nullable": false
    },
    "box_item": {
      "nullable": false
    },
    "partner_item": {
      "nullable": false
    }
  }
}

{
  "type": "object",
  "title": "Integration mapping options for type Slack",
  "properties": {
    "is_access_management_disabled": {
      "type": "boolean",
      "example": true,
      "nullable": false,
      "description": "Indicates whether or not channel member\naccess to the underlying box item\nshould be automatically managed.\nDepending on type of channel, access is managed\nthrough creating collaborations or shared links."
    }
  },
  "description": "The schema for an integration mapping options object for Slack type."
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "next_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
          "nullable": true,
          "description": "The marker for the start of the next page of results."
        }
      },
      "description": "The part of an API response that describes marker\nbased pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/IntegrationMapping"
          },
          "description": "A list of integration mappings"
        }
      }
    }
  ],
  "title": "Integration mappings",
  "x-box-tag": "integration_mappings",
  "description": "A list of integration mapping\nobjects.",
  "x-box-resource-id": "integration_mappings"
}

{
  "type": "object",
  "properties": {
    "options": {
      "$ref": "#/components/schemas/IntegrationMappingSlackOptions"
    },
    "box_item": {
      "$ref": "#/components/schemas/IntegrationMappingBoxItemSlack"
    }
  },
  "x-konfig-properties": {
    "options": {
      "nullable": false
    },
    "box_item": {
      "nullable": false
    }
  }
}

{
  "type": "object",
  "title": "Invite",
  "required": [
    "id",
    "type"
  ],
  "x-box-tag": "invites",
  "properties": {
    "id": {
      "type": "string",
      "example": "11446498",
      "description": "The unique identifier for this invite"
    },
    "type": {
      "enum": [
        "invite"
      ],
      "type": "string",
      "example": "invite",
      "description": "`invite`"
    },
    "status": {
      "type": "string",
      "example": "pending",
      "description": "The status of the invite"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-12T10:53:43-08:00",
      "description": "When the invite was created"
    },
    "invited_by": {
      "$ref": "#/components/schemas/User--Mini"
    },
    "invited_to": {
      "type": "object",
      "title": "Enterprise",
      "properties": {
        "id": {
          "type": "string",
          "example": "11446498",
          "description": "The unique identifier for this enterprise."
        },
        "name": {
          "type": "string",
          "example": "Acme Inc.",
          "description": "The name of the enterprise"
        },
        "type": {
          "enum": [
            "enterprise"
          ],
          "type": "string",
          "example": "enterprise",
          "description": "`enterprise`"
        }
      },
      "description": "A representation of a Box enterprise"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-12T10:53:43-08:00",
      "description": "When the invite was modified."
    },
    "actionable_by": {
      "$ref": "#/components/schemas/User--Mini"
    }
  },
  "description": "An invite for a user to an enterprise.",
  "x-box-resource-id": "invite"
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "order": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "by": {
                "type": "string",
                "example": "type",
                "description": "The field to order by"
              },
              "direction": {
                "enum": [
                  "ASC",
                  "DESC"
                ],
                "type": "string",
                "example": "ASC",
                "description": "The direction to order by, either ascending or descending"
              }
            },
            "description": "The order in which a pagination is ordered"
          },
          "description": "The order by which items are returned.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        },
        "offset": {
          "type": "integer",
          "format": "int64",
          "example": 2000,
          "description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        },
        "total_count": {
          "type": "integer",
          "format": "int64",
          "example": 5000,
          "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted."
        }
      },
      "description": "The part of an API response that describes pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/File--Full"
              },
              {
                "$ref": "#/components/schemas/Folder--Mini"
              },
              {
                "$ref": "#/components/schemas/WebLink"
              }
            ]
          },
          "description": "The items in this collection."
        }
      }
    }
  ],
  "title": "Items",
  "x-box-tag": "folders",
  "description": "A list of files, folders, and web links in\ntheir mini representation.",
  "x-box-resource-id": "items"
}

{
  "type": "object",
  "title": "Keyword Skill Card",
  "required": [
    "type",
    "skill_card_type",
    "skill",
    "invocation",
    "entries"
  ],
  "x-box-tag": "skills",
  "properties": {
    "type": {
      "enum": [
        "skill_card"
      ],
      "type": "string",
      "example": "skill_card",
      "description": "`skill_card`"
    },
    "skill": {
      "type": "object",
      "required": [
        "type",
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "image-recognition-service",
          "description": "A custom identifier that represent the service that\napplied this metadata."
        },
        "type": {
          "enum": [
            "service"
          ],
          "type": "string",
          "example": "service",
          "description": "`service`"
        }
      },
      "description": "The service that applied this metadata."
    },
    "entries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "example": "keyword1",
            "description": "The text of the keyword."
          }
        },
        "description": "An entry in the `entries` attribute of a metadata card"
      },
      "description": "An list of entries in the metadata card."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2018-04-13T13:53:23-07:00",
      "description": "The optional date and time this card was created at."
    },
    "invocation": {
      "type": "object",
      "required": [
        "type",
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "image-recognition-service-123",
          "description": "A custom identifier that represent the instance of\nthe service that applied this metadata. For example,\nif your `image-recognition-service` runs on multiple\nnodes, this field can be used to identify the ID of\nthe node that was used to apply the metadata."
        },
        "type": {
          "enum": [
            "skill_invocation"
          ],
          "type": "string",
          "example": "skill_invocation",
          "description": "`skill_invocation`"
        }
      },
      "description": "The invocation of this service, used to track\nwhich instance of a service applied the metadata."
    },
    "skill_card_type": {
      "enum": [
        "keyword"
      ],
      "type": "string",
      "example": "keyword",
      "description": "`keyword`"
    },
    "skill_card_title": {
      "type": "object",
      "required": [
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "example": "labels",
          "description": "An optional identifier for the title."
        },
        "message": {
          "type": "string",
          "example": "Labels",
          "description": "The actual title to show in the UI."
        }
      },
      "description": "The title of the card."
    }
  },
  "description": "A skill card that contains a set of keywords",
  "x-box-resource-id": "keyword_skill_card"
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "next_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
          "nullable": true,
          "description": "The marker for the start of the next page of results."
        },
        "prev_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
          "nullable": true,
          "description": "The marker for the start of the previous page of results."
        }
      },
      "description": "The part of an API response that describes marker\nbased pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/LegalHoldPolicy"
          },
          "description": "A list of legal hold policies"
        }
      }
    }
  ],
  "title": "Legal hold policies",
  "x-box-tag": "legal_hold_policies",
  "description": "A list of legal hold policies.",
  "x-box-resource-id": "legal_hold_policies"
}

{
  "type": "object",
  "required": [
    "policy_name"
  ],
  "properties": {
    "is_ongoing": {
      "type": "boolean",
      "example": true,
      "description": "Whether new assignments under this policy should\ncontinue applying to files even after initialization.\n\nWhen this policy is applied using a legal hold assignment,\nit will continue applying the policy to any new file versions\neven after it has been applied.\n\nFor example, if a legal hold assignment is placed on a user\ntoday, and that user uploads a file tomorrow, that file will\nget held. This will continue until the policy is retired.\n\nRequired if no filter dates are set."
    },
    "description": {
      "type": "string",
      "example": "A custom policy for the sales team",
      "maxLength": 500,
      "description": "A description for the policy."
    },
    "policy_name": {
      "type": "string",
      "example": "Sales Policy",
      "maxLength": 254,
      "description": "The name of the policy."
    },
    "filter_ended_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-18T10:53:43-08:00",
      "maxLength": 500,
      "description": "The filter end date.\n\nWhen this policy is applied using a `custodian` legal\nhold assignments, it will only apply to file versions\ncreated or uploaded inside of the\ndate range. Other assignment types, such as folders and\nfiles, will ignore the date filter.\n\nRequired if `is_ongoing` is set to `false`."
    },
    "filter_started_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-12-12T10:53:43-08:00",
      "maxLength": 500,
      "description": "The filter start date.\n\nWhen this policy is applied using a `custodian` legal\nhold assignments, it will only apply to file versions\ncreated or uploaded inside of the\ndate range. Other assignment types, such as folders and\nfiles, will ignore the date filter.\n\nRequired if `is_ongoing` is set to `false`."
    }
  }
}

{
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "example": "A custom policy for the sales team",
      "maxLength": 500,
      "description": "A description for the policy."
    },
    "policy_name": {
      "type": "string",
      "example": "Sales Policy",
      "maxLength": 254,
      "description": "The name of the policy."
    },
    "release_notes": {
      "type": "string",
      "example": "Required for GDPR",
      "maxLength": 500,
      "description": "Notes around why the policy was released."
    }
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/LegalHoldPolicy--Mini"
    },
    {
      "properties": {
        "status": {
          "enum": [
            "active",
            "applying",
            "releasing",
            "released"
          ],
          "type": "string",
          "example": "active",
          "description": "* 'active' - the policy is not in a transition state\n* 'applying' - that the policy is in the process of\n  being applied\n* 'releasing' - that the process is in the process\n  of being released\n* 'released' - the policy is no longer active"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "description": "When the legal hold policy object was created"
        },
        "created_by": {
          "allOf": [
            {
              "$ref": "#/components/schemas/User--Mini"
            },
            {
              "description": "The user who created the legal hold policy object"
            }
          ]
        },
        "deleted_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "description": "When the policy release request was sent. (Because\nit can take time for a policy to fully delete, this\nisn't quite the same time that the policy is fully deleted).\n\nIf `null`, the policy was not deleted."
        },
        "description": {
          "type": "string",
          "example": "Postman created policy",
          "maxLength": 500,
          "description": "Description of the legal hold policy. Optional\nproperty with a 500 character limit."
        },
        "modified_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "description": "When the legal hold policy object was modified.\nDoes not update when assignments are added or removed."
        },
        "policy_name": {
          "type": "string",
          "example": "Policy 4",
          "maxLength": 254,
          "description": "Name of the legal hold policy."
        },
        "release_notes": {
          "type": "string",
          "example": "Example",
          "maxLength": 500,
          "description": "Optional notes about why the policy was created."
        },
        "filter_ended_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "description": "User-specified, optional date filter applies to\nCustodian assignments only"
        },
        "assignment_counts": {
          "type": "object",
          "properties": {
            "file": {
              "type": "integer",
              "format": "int64",
              "example": 3,
              "description": "The number of files this policy is applied to"
            },
            "user": {
              "type": "integer",
              "format": "int64",
              "example": 1,
              "description": "The number of users this policy is applied to"
            },
            "folder": {
              "type": "integer",
              "format": "int64",
              "example": 2,
              "description": "The number of folders this policy is applied to"
            },
            "file_version": {
              "type": "integer",
              "format": "int64",
              "example": 4,
              "description": "The number of file versions this policy is applied to"
            }
          },
          "description": "Counts of assignments within this a legal hold policy by item type"
        },
        "filter_started_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "description": "User-specified, optional date filter applies to\nCustodian assignments only"
        }
      }
    }
  ],
  "title": "Legal hold policy",
  "description": "Legal Hold Policy information describes the basic\ncharacteristics of the Policy, such as name, description,\nand filter dates.",
  "x-box-variant": "standard",
  "x-box-resource-id": "legal_hold_policy"
}

{
  "type": "object",
  "title": "Legal hold policy (Mini)",
  "required": [
    "id",
    "type"
  ],
  "x-box-tag": "legal_hold_policies",
  "properties": {
    "id": {
      "type": "string",
      "example": "11446498",
      "description": "The unique identifier for this legal hold policy"
    },
    "type": {
      "enum": [
        "legal_hold_policy"
      ],
      "type": "string",
      "example": "legal_hold_policy",
      "description": "`legal_hold_policy`"
    }
  },
  "description": "A mini legal hold policy",
  "x-box-variant": "mini",
  "x-box-variants": [
    "mini",
    "standard"
  ],
  "x-box-resource-id": "legal_hold_policy--mini"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/LegalHoldPolicyAssignment--Base"
    },
    {
      "properties": {
        "deleted_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "description": "When the assignment release request was sent.\n(Because it can take time for an assignment to fully\ndelete, this isn't quite the same time that the\nassignment is fully deleted). If null, Assignment\nwas not deleted."
        },
        "assigned_at": {
          "type": "string",
          "format": "date-time",
          "example": "2012-12-12T10:53:43-08:00",
          "description": "When the legal hold policy assignment object was\ncreated"
        },
        "assigned_by": {
          "allOf": [
            {
              "$ref": "#/components/schemas/User--Mini"
            },
            {
              "description": "The user who created the legal hold policy\nassignment"
            }
          ]
        },
        "assigned_to": {
          "allOf": [
            {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/File"
                },
                {
                  "$ref": "#/components/schemas/Folder"
                },
                {
                  "$ref": "#/components/schemas/WebLink"
                }
              ]
            },
            {
              "description": "The item that the the legal hold policy\nis assigned to. Includes type and ID."
            }
          ]
        },
        "legal_hold_policy": {
          "allOf": [
            {
              "$ref": "#/components/schemas/LegalHoldPolicy--Mini"
            },
            {
              "description": "The policy that the legal hold policy assignment\nis part of"
            }
          ]
        }
      }
    }
  ],
  "title": "Legal hold policy assignment",
  "x-box-tag": "legal_hold_policy_assignments",
  "description": "Legal Hold Assignments are used to assign Legal Hold\nPolicies to Users, Folders, Files, or File Versions.\n\nCreating a Legal Hold Assignment puts a hold\non the File-Versions that belong to the Assignment's\n'apply-to' entity.",
  "x-box-resource-id": "legal_hold_policy_assignment"
}

{
  "type": "object",
  "title": "Legal hold policy assignment (Base)",
  "x-box-tag": "legal_hold_policy_assignments",
  "properties": {
    "id": {
      "type": "string",
      "example": "11446498",
      "description": "The unique identifier for this legal hold assignment"
    },
    "type": {
      "enum": [
        "legal_hold_policy_assignment"
      ],
      "type": "string",
      "example": "legal_hold_policy_assignment",
      "description": "`legal_hold_policy_assignment`"
    }
  },
  "description": "Legal Hold Assignments are used to assign Legal Hold\nPolicies to Users, Folders, Files, or File Versions.\n\nCreating a Legal Hold Assignment puts a hold\non the File-Versions that belong to the Assignment's\n'apply-to' entity.",
  "x-box-variant": "base",
  "x-box-variants": [
    "base",
    "standard"
  ],
  "x-box-sanitized": true,
  "x-box-resource-id": "legal_hold_policy_assignment--base"
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "next_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
          "nullable": true,
          "description": "The marker for the start of the next page of results."
        },
        "prev_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
          "nullable": true,
          "description": "The marker for the start of the previous page of results."
        }
      },
      "description": "The part of an API response that describes marker\nbased pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/LegalHoldPolicyAssignment"
          },
          "description": "A list of legal hold\npolicy assignments"
        }
      }
    }
  ],
  "title": "Legal hold policy assignments",
  "x-box-tag": "legal_hold_policy_assignments",
  "description": "A list of legal hold policies assignments.",
  "x-box-resource-id": "legal_hold_policy_assignments"
}

{
  "type": "object",
  "required": [
    "policy_id",
    "assign_to"
  ],
  "properties": {
    "assign_to": {
      "type": "object",
      "required": [
        "type",
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "6564564",
          "description": "The ID of item to assign the policy to"
        },
        "type": {
          "enum": [
            "file",
            "file_version",
            "folder",
            "user"
          ],
          "type": "string",
          "example": "folder",
          "description": "The type of item to assign the policy to"
        }
      },
      "description": "The item to assign the policy to"
    },
    "policy_id": {
      "type": "string",
      "example": "123244",
      "description": "The ID of the policy to assign."
    }
  }
}

{
  "type": "object",
  "title": "Metadata instance (Base)",
  "x-box-tag": "file_metadata",
  "properties": {
    "$scope": {
      "type": "string",
      "example": "enterprise_27335",
      "description": "An ID for the scope in which this template\nhas been applied. This will be `enterprise_{enterprise_id}` for templates\ndefined for use in this enterprise, and `global` for general templates\nthat are available to all enterprises using Box."
    },
    "$parent": {
      "type": "string",
      "example": "folder_59449484661,",
      "description": "The identifier of the item that this metadata instance\nhas been attached to. This combines the `type` and the `id`\nof the parent in the form `{type}_{id}`."
    },
    "$version": {
      "type": "integer",
      "example": 1,
      "description": "The version of the metadata instance. This version starts at 0 and\nincreases every time a user-defined property is modified."
    },
    "$template": {
      "type": "string",
      "example": "marketingCollateral",
      "description": "The name of the template"
    }
  },
  "description": "The base representation of a metadata instance.",
  "x-box-variant": "base",
  "x-box-variants": [
    "base",
    "standard",
    "full"
  ],
  "x-box-sanitized": true,
  "x-box-resource-id": "metadata--base"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Metadata--Base"
    },
    {
      "properties": {
        "$id": {
          "type": "string",
          "format": "uuid",
          "example": "01234500-12f1-1234-aa12-b1d234cb567e",
          "maxLength": 36,
          "description": "A UUID to identify the metadata instance."
        },
        "$type": {
          "type": "string",
          "example": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
          "description": "A unique identifier for the \"type\" of this instance. This is an\ninternal system property and should not be used by a client\napplication."
        },
        "$canEdit": {
          "type": "boolean",
          "example": true,
          "description": "Whether the user can edit this metadata instance."
        },
        "$typeVersion": {
          "type": "integer",
          "example": 2,
          "description": "The last-known version of the template of the object. This is an\ninternal system property and should not be used by a client\napplication."
        }
      }
    },
    {
      "additionalProperties": {
        "allOf": [
          {},
          {
            "example": "Aaron Levie"
          },
          {
            "description": "A value for each of the fields that are present\non the metadata template.\nFor the `global.properties` template this can be\na list of zero or more fields,\nas this template allows for any generic key-value pairs \nto be stored stored in the template."
          }
        ],
        "x-box-example-key": "name"
      }
    }
  ],
  "title": "Metadata instance (Full)",
  "description": "An instance of a metadata template, which has been applied to a file or\nfolder.",
  "x-box-variant": "full",
  "x-box-resource-id": "metadata--full"
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "next_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
          "nullable": true,
          "description": "The marker for the start of the next page of results."
        },
        "prev_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
          "nullable": true,
          "description": "The marker for the start of the previous page of results."
        }
      },
      "description": "The part of an API response that describes marker\nbased pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/MetadataCascadePolicy"
          },
          "description": "A list of metadata cascade policies"
        }
      }
    }
  ],
  "title": "Metadata cascade policies",
  "x-box-tag": "metadata_cascade_policies",
  "description": "A list of metadata cascade policies.",
  "x-box-resource-id": "metadata_cascade_policies"
}

{
  "type": "object",
  "required": [
    "conflict_resolution"
  ],
  "properties": {
    "conflict_resolution": {
      "enum": [
        "none",
        "overwrite"
      ],
      "type": "string",
      "example": "none",
      "description": "Describes the desired behavior when dealing with the conflict\nwhere a metadata template already has an instance applied\nto a child.\n\n* `none` will preserve the existing value on the file\n* `overwrite` will force-apply the templates values over\n  any existing values."
    }
  }
}

{
  "type": "object",
  "required": [
    "folder_id",
    "scope",
    "templateKey"
  ],
  "properties": {
    "scope": {
      "enum": [
        "global",
        "enterprise"
      ],
      "type": "string",
      "example": "enterprise",
      "description": "The scope of the targeted metadata template. This template will\nneed to already have an instance applied to the targeted folder."
    },
    "folder_id": {
      "type": "string",
      "example": "1234567",
      "description": "The ID of the folder to apply the policy to. This folder will\nneed to already have an instance of the targeted metadata\ntemplate applied to it."
    },
    "templateKey": {
      "type": "string",
      "example": "productInfo",
      "description": "The key of the targeted metadata template. This template will\nneed to already have an instance applied to the targeted folder.\n\nIn many cases the template key is automatically derived\nof its display name, for example `Contract Template` would\nbecome `contractTemplate`. In some cases the creator of the\ntemplate will have provided its own template key.\n\nPlease [list the templates for an enterprise][list], or\nget all instances on a [file][file] or [folder][folder]\nto inspect a template's key.\n\n[list]: e://get-metadata-templates-enterprise\n[file]: e://get-files-id-metadata\n[folder]: e://get-folders-id-metadata"
    }
  }
}

{
  "type": "object",
  "title": "Metadata cascade policy",
  "required": [
    "id",
    "type"
  ],
  "x-box-tag": "metadata_cascade_policies",
  "properties": {
    "id": {
      "type": "string",
      "example": "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7",
      "description": "The ID of the metadata cascade policy object"
    },
    "type": {
      "enum": [
        "metadata_cascade_policy"
      ],
      "type": "string",
      "example": "metadata_cascade_policy",
      "description": "`metadata_cascade_policy`"
    },
    "scope": {
      "type": "string",
      "example": "enterprise_123456",
      "description": "The scope of the metadata cascade policy can either be `global` or\n`enterprise_*`. The `global` scope is used for policies that are\navailable to any Box enterprise. The `enterprise_*` scope represents\npolicies that have been created within a specific enterprise, where `*`\nwill be the ID of that enterprise."
    },
    "parent": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "1234567",
          "description": "The ID of the folder the policy is applied to."
        },
        "type": {
          "enum": [
            "folder"
          ],
          "type": "string",
          "example": "folder",
          "description": "`folder`"
        }
      },
      "description": "Represent the folder the policy is applied to."
    },
    "templateKey": {
      "type": "string",
      "example": "productInfo",
      "description": "The key of the template that is cascaded down to the folder's\nchildren.\n\nIn many cases the template key is automatically derived\nof its display name, for example `Contract Template` would\nbecome `contractTemplate`. In some cases the creator of the\ntemplate will have provided its own template key.\n\nPlease [list the templates for an enterprise][list], or\nget all instances on a [file][file] or [folder][folder]\nto inspect a template's key.\n\n[list]: e://get-metadata-templates-enterprise\n[file]: e://get-files-id-metadata\n[folder]: e://get-folders-id-metadata"
    },
    "owner_enterprise": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "690678",
          "description": "The ID of the enterprise that owns the policy."
        },
        "type": {
          "enum": [
            "enterprise"
          ],
          "type": "string",
          "example": "enterprise",
          "description": "`enterprise`"
        }
      },
      "description": "The enterprise that owns this policy."
    }
  },
  "description": "A metadata cascade policy automatically applies a metadata template instance\nto all the files and folders within the targeted folder.",
  "x-box-resource-id": "metadata_cascade_policy"
}

{
  "type": "object",
  "title": "Metadata field filter (date range)",
  "example": {
    "expirationDate": {
      "gt": "2016-08-01T00:00:00Z",
      "lt": "2017-08-01T00:00:00Z"
    }
  },
  "description": "Specifies which `date` field on the template to filter the search\nresults by, specifying a range of dates that can match.",
  "x-box-resource-id": "metadata_field_filter_date_range",
  "additionalProperties": {
    "type": "object",
    "example": {
      "gt": "2016-08-01T00:00:00Z",
      "lt": "2017-08-01T00:00:00Z"
    },
    "properties": {
      "gt": {
        "type": "string",
        "format": "date-time",
        "example": "2016-08-01T00:00:00Z",
        "description": "Specifies the (inclusive) lower bound for the metadata field\nvalue. The value of a field must be greater than (`gt`) or\nequal to this value for the search query to match this\ntemplate."
      },
      "lt": {
        "type": "string",
        "format": "date-time",
        "example": "2017-08-01T00:00:00Z",
        "description": "Specifies the (inclusive) upper bound for the metadata field\nvalue. The value of a field must be lower than (`lt`) or\nequal to this value for the search query to match this\ntemplate."
      }
    },
    "description": "Match a `date` metadata field to a range of values.",
    "x-box-example-key": "expirationDate"
  }
}

{
  "type": "object",
  "title": "Metadata field filter (float)",
  "example": {
    "contractValue": 10000
  },
  "description": "Specifies which `float` field on the template to filter the search\nresults by.",
  "x-box-resource-id": "metadata_field_filter_float",
  "additionalProperties": {
    "type": "number",
    "example": 10000,
    "description": "A mapping between a metadata `float` field key and\nthe value to match search results on.",
    "x-box-example-key": "contractValue"
  }
}

{
  "type": "object",
  "title": "Metadata field filter (float range)",
  "example": {
    "contractValue": {
      "gt": 100000,
      "lt": 200000
    }
  },
  "description": "Specifies which `float` field on the template to filter the search\nresults by, specifying a range of values that can match.",
  "x-box-resource-id": "metadata_field_filter_float_range",
  "additionalProperties": {
    "type": "object",
    "example": {
      "gt": 100000,
      "lt": 200000
    },
    "properties": {
      "gt": {
        "type": "number",
        "example": 100000,
        "description": "Specifies the (inclusive) lower bound for the metadata field\nvalue. The value of a field must be greater than (`gt`) or\nequal to this value for the search query to match this\ntemplate."
      },
      "lt": {
        "type": "number",
        "example": 200000,
        "description": "Specifies the (inclusive) upper bound for the metadata field\nvalue. The value of a field must be lower than (`lt`) or\nequal to this value for the search query to match this\ntemplate."
      }
    },
    "description": "Specifies which `float` field on the template to filter the search\nresults by, specifying a range of values that can match.",
    "x-box-example-key": "value"
  }
}

{
  "type": "object",
  "title": "Metadata field filter (multi-select)",
  "example": {
    "category": [
      "online",
      "enterprise"
    ]
  },
  "description": "Specifies the values to match for a `multiSelect` metadata\nfield. When performing a search, the query will essentially\nperform an `OR` operation to match any template where any of\nthe provided values match this field.",
  "x-box-resource-id": "metadata_field_filter_multi_select",
  "additionalProperties": {
    "type": "array",
    "items": {
      "type": "string"
    },
    "example": [
      "online",
      "enterprise"
    ],
    "description": "A mapping between a metadata `multiSelect` field key and\nthe one or more values to match search results on.\n\nWhen performing a search, the query will essentially\nperform an `OR` operation to match any template where any of\nthe provided values match this field.",
    "x-box-example-key": "category"
  }
}

{
  "type": "object",
  "title": "Metadata field filter (string)",
  "example": {
    "category": "online"
  },
  "description": "Specifies which text field on the template to filter the search\nresults by.",
  "x-box-resource-id": "metadata_field_filter_string",
  "additionalProperties": {
    "type": "string",
    "example": "online",
    "description": "A mapping between a metadata `string` field key and\nthe value to match search results on.",
    "x-box-example-key": "category"
  }
}

{
  "type": "object",
  "title": "Metadata filter",
  "x-box-tag": "search",
  "properties": {
    "scope": {
      "enum": [
        "global",
        "enterprise",
        "enterprise_{enterprise_id}"
      ],
      "type": "string",
      "example": "enterprise",
      "description": "Specifies the scope of the template to filter search results by.\n\nThis will be `enterprise_{enterprise_id}` for templates defined\nfor use in this enterprise, and `global` for general templates\nthat are available to all enterprises using Box."
    },
    "filters": {
      "allOf": [
        {
          "anyOf": [
            {
              "$ref": "#/components/schemas/MetadataFieldFilterString"
            },
            {
              "$ref": "#/components/schemas/MetadataFieldFilterFloat"
            },
            {
              "$ref": "#/components/schemas/MetadataFieldFilterMultiSelect"
            },
            {
              "$ref": "#/components/schemas/MetadataFieldFilterFloatRange"
            },
            {
              "$ref": "#/components/schemas/MetadataFieldFilterDateRange"
            }
          ]
        },
        {
          "description": "Specifies which fields on the template to filter the search\nresults by. When more than one field is specified, the query\nperforms a logical `AND` to ensure that the instance of the\ntemplate matches each of the fields specified."
        },
        {
          "example": {
            "category": "online",
            "contractValue": 1000000
          }
        }
      ]
    },
    "templateKey": {
      "type": "string",
      "example": "contract",
      "description": "The key of the template to filter search results by.\n\nIn many cases the template key is automatically derived\nof its display name, for example `Contract Template` would\nbecome `contractTemplate`. In some cases the creator of the\ntemplate will have provided its own template key.\n\nPlease [list the templates for an enterprise][list], or\nget all instances on a [file][file] or [folder][folder]\nto inspect a template's key.\n\n[list]: e://get-metadata-templates-enterprise\n[file]: e://get-files-id-metadata\n[folder]: e://get-folders-id-metadata"
    }
  },
  "description": "A metadata template to filter the search results by.",
  "x-box-resource-id": "metadata_filter"
}

{
  "type": "object",
  "example": {
    "name": "Aaron Levie"
  },
  "x-box-example-key": "name",
  "additionalProperties": {
    "allOf": [
      {},
      {
        "example": "Aaron Levie"
      },
      {
        "description": "A value for each of the fields that are present\non the metadata template.\nFor the `global.properties` template this can be\na list of zero or more fields,\nas this template allows for any generic key-value pairs \nto be stored stored in the template."
      }
    ]
  }
}

{
  "type": "array",
  "items": {
    "type": "object",
    "title": "A metadata instance update operation",
    "properties": {
      "op": {
        "enum": [
          "add",
          "replace",
          "remove",
          "test",
          "move",
          "copy"
        ],
        "type": "string",
        "example": "add",
        "description": "The type of change to perform on the template. Some\nof these are hazardous as they will change existing templates."
      },
      "from": {
        "type": "string",
        "example": "/nextState",
        "description": "The location in the metadata JSON object to move or copy a value\nfrom. Required for `move` or `copy` operations and must be in the\nformat of a [JSON-Pointer](https://tools.ietf.org/html/rfc6901)."
      },
      "path": {
        "type": "string",
        "example": "/currentState",
        "description": "The location in the metadata JSON object\nto apply the changes to, in the format of a\n[JSON-Pointer](https://tools.ietf.org/html/rfc6901).\n\nThe path must always be prefixed with a `/` to represent the root\nof the template. The characters `~` and `/` are reserved\ncharacters and must be escaped in the key."
      },
      "value": {
        "type": "string",
        "example": "reviewed",
        "description": "The value to be set or tested.\n\nRequired for `add`, `replace`, and `test` operations. For `add`,\nif the value exists already the previous value will be overwritten\nby the new value. For `replace`, the value must exist before\nreplacing.\n\nFor `test`, the existing value at the `path` location must match\nthe specified value."
      }
    },
    "description": "A [JSON-Patch](https://tools.ietf.org/html/rfc6902) operation for a\nchange to make to the metadata instance."
  },
  "description": "A [JSON-Patch](https://tools.ietf.org/html/rfc6902)\nspecification for the changes to make to the metadata\ninstance.\n\nThe changes are represented as a JSON array of\noperation objects."
}

{
  "type": "object",
  "example": {
    "name": "Aaron Levie"
  },
  "x-box-example-key": "name",
  "additionalProperties": {
    "allOf": [
      {},
      {
        "example": "Aaron Levie"
      },
      {
        "description": "A value for each of the fields that are present on the metadata\ntemplate.\nFor the `global.properties` template this can be a list of zero\nor more fields, as this template allows for any generic key-value\npairs to be stored in the template."
      }
    ]
  }
}

{
  "type": "array",
  "items": {
    "type": "object",
    "title": "A metadata instance update operation",
    "properties": {
      "op": {
        "enum": [
          "add",
          "replace",
          "remove",
          "test",
          "move",
          "copy"
        ],
        "type": "string",
        "example": "add",
        "description": "The type of change to perform on the template. Some\nof these are hazardous as they will change existing templates."
      },
      "from": {
        "type": "string",
        "example": "/nextState",
        "description": "The location in the metadata JSON object to move or copy a value\nfrom. Required for `move` or `copy` operations and must be in the\nformat of a [JSON-Pointer](https://tools.ietf.org/html/rfc6901)."
      },
      "path": {
        "type": "string",
        "example": "/currentState",
        "description": "The location in the metadata JSON object\nto apply the changes to, in the format of a\n[JSON-Pointer](https://tools.ietf.org/html/rfc6901).\n\nThe path must always be prefixed with a `/` to represent the root\nof the template. The characters `~` and `/` are reserved\ncharacters and must be escaped in the key."
      },
      "value": {
        "type": "string",
        "example": "reviewed",
        "description": "The value to be set or tested.\n\nRequired for `add`, `replace`, and `test` operations. For `add`,\nif the value exists already the previous value will be overwritten\nby the new value. For `replace`, the value must exist before\nreplacing.\n\nFor `test`, the existing value at the `path` location must match\nthe specified value."
      }
    },
    "description": "A [JSON-Patch](https://tools.ietf.org/html/rfc6902) operation for a\nchange to make to the metadata instance."
  },
  "description": "A [JSON-Patch](https://tools.ietf.org/html/rfc6902)\nspecification for the changes to make to the metadata\ninstance.\n\nThe changes are represented as a JSON array of\noperation objects."
}

{
  "type": "object",
  "title": "Metadata query search request",
  "required": [
    "from",
    "ancestor_folder_id"
  ],
  "properties": {
    "from": {
      "type": "string",
      "example": "enterprise_123456.someTemplate",
      "description": "Specifies the template used in the query. Must be in the form\n`scope.templateKey`. Not all templates can be used in this field,\nmost notably the built-in, Box-provided classification templates\ncan not be used in a query."
    },
    "limit": {
      "type": "integer",
      "default": 100,
      "example": 50,
      "maximum": 100,
      "minimum": 0,
      "description": "A value between 0 and 100 that indicates the maximum number of results\nto return for a single request. This only specifies a maximum\nboundary and will not guarantee the minimum number of results\nreturned."
    },
    "query": {
      "type": "string",
      "example": "value >= :amount",
      "description": "The query to perform. A query is a logical expression that is very similar\nto a SQL `SELECT` statement. Values in the search query can be turned into\nparameters specified in the `query_param` arguments list to prevent having\nto manually insert search values into the query string.\n\nFor example, a value of `:amount` would represent the `amount` value in\n`query_params` object."
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "extension",
        "created_at",
        "item_status",
        "metadata.enterprise_1234.contracts",
        "metadata.enterprise_1234.regions.location"
      ],
      "description": "By default, this endpoint returns only the most basic info about the items for\nwhich the query matches. This attribute can be used to specify a list of\nadditional attributes to return for any item, including its metadata.\n\nThis attribute takes a list of item fields, metadata template identifiers,\nor metadata template field identifiers.\n\nFor example:\n\n* `created_by` will add the details of the user who created the item to\nthe response.\n* `metadata.<scope>.<templateKey>` will return the mini-representation\nof the metadata instance identified by the `scope` and `templateKey`.\n* `metadata.<scope>.<templateKey>.<field>` will return all the mini-representation\nof the metadata instance identified by the `scope` and `templateKey` plus\nthe field specified by the `field` name. Multiple fields for the same\n`scope` and `templateKey` can be defined."
    },
    "marker": {
      "type": "string",
      "example": "AAAAAmVYB1FWec8GH6yWu2nwmanfMh07IyYInaa7DZDYjgO1H4KoLW29vPlLY173OKsci6h6xGh61gG73gnaxoS+o0BbI1/h6le6cikjlupVhASwJ2Cj0tOD9wlnrUMHHw3/ISf+uuACzrOMhN6d5fYrbidPzS6MdhJOejuYlvsg4tcBYzjauP3+VU51p77HFAIuObnJT0ff",
      "description": "Marker to use for requesting the next page."
    },
    "order_by": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "direction": {
            "enum": [
              "ASC",
              "DESC",
              "asc",
              "desc"
            ],
            "type": "string",
            "example": "asc",
            "description": "The direction to order by, either ascending or descending.\n\nThe `ordering` direction must be the same for each item in the\narray."
          },
          "field_key": {
            "type": "string",
            "example": "amount",
            "description": "The metadata template field to order by.\n\nThe `field_key` represents the `key` value of a field from the\nmetadata template being searched for."
          }
        },
        "description": "An object representing one of the metadata template fields to sort the\nmetadata query results by."
      },
      "description": "A list of template fields and directions to sort the metadata query\nresults by.\n\nThe ordering `direction` must be the same for each item in the array."
    },
    "query_params": {
      "type": "object",
      "example": {
        "amount": "100"
      },
      "description": "Set of arguments corresponding to the parameters specified in the\n`query`. The type of each parameter used in the `query_params` must match\nthe type of the corresponding metadata template field.",
      "additionalProperties": {
        "type": "string",
        "example": "100",
        "description": "The value for the argument being used in the metadata search.\n\nThe type of this parameter must match the type of the corresponding\nmetadata template field.",
        "x-box-example-key": "amount"
      }
    },
    "ancestor_folder_id": {
      "type": "string",
      "example": "0",
      "description": "The ID of the folder that you are restricting the query to. A\nvalue of zero will return results from all folders you have access\nto. A non-zero value will only return results found in the folder\ncorresponding to the ID or in any of its subfolders."
    }
  },
  "description": "Create a search using SQL-like syntax to return items that match specific\nmetadata."
}

{
  "type": "object",
  "title": "Metadata query index",
  "required": [
    "type",
    "status"
  ],
  "x-box-tag": "search",
  "properties": {
    "id": {
      "type": "string",
      "example": "-9876",
      "description": "The ID of the metadata query index."
    },
    "type": {
      "type": "string",
      "example": "metadata_query_index",
      "nullable": false,
      "description": "Value is always `metadata_query_index`"
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "allOf": [
          {
            "properties": {
              "key": {
                "type": "string",
                "example": "vendor name",
                "description": "The metadata template field key."
              },
              "sort_direction": {
                "enum": [
                  "asc",
                  "desc"
                ],
                "type": "string",
                "example": "asc",
                "description": "The sort direction of the field."
              }
            }
          }
        ],
        "description": "The field which makes up the index."
      },
      "description": "A list of template fields which make up the index."
    },
    "status": {
      "enum": [
        "building",
        "active",
        "disabled"
      ],
      "type": "string",
      "example": "active",
      "nullable": false,
      "description": "The status of the metadata query index"
    }
  },
  "description": "A metadata query index",
  "x-box-resource-id": "metadata_query_index"
}

{
  "type": "object",
  "title": "Metadata query search results",
  "x-box-tag": "search",
  "properties": {
    "limit": {
      "type": "integer",
      "format": "int64",
      "default": 100,
      "example": 100,
      "description": "The limit that was used for this search. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed."
    },
    "entries": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/File"
          },
          {
            "$ref": "#/components/schemas/Folder"
          }
        ]
      },
      "description": "The mini representation of the files and folders that match the search\nterms.\n\nBy default, this endpoint returns only the most basic info about the\nitems. To get additional fields for each item, including any of the\nmetadata, use the `fields` attribute in the query.",
      "x-box-resource-variant": 1
    },
    "next_marker": {
      "type": "string",
      "example": "0!-M7487OpVfBTNBV-XsQjU50gQFlbFFu5nArMWD7Ck61GH_Qo40M1S2xN5zWZPBzEjaQS1SOjJiQoo5BsXEl1bCVLRZ2pTqo4SKp9tyqzWQK2L51KR_nC1EgF5I_TJSFw7uO2Bx4HweGETOjh5_2oPSWw5iMkM-OvGApeR0lGFO48FDKoyzJyLgz5aogxoKd8VE09CesOOnTnmZvrW0puylDc-hFjY5YLmWFBKox3SOWiSDwKFkmZGNHyjEzza1nSwbZg6CYsAdGsDwGJhuCeTNsFzP5Mo5qx9wMloS0lSPuf2CcBInbIJzl2CKlXF3FvqhANttpm2nzdBTQRSoJyJnjVBpf4Q_HjV2eb4KIZBBlLy067UCVdv2AAWQFd5E2i6s1YiGRTtgMEZntOSUYD4IYLMWWm5Ra7ke_SP32SL3GSjbBQYIyCVQ..",
      "description": "The marker for the start of the next page of results."
    }
  },
  "description": "A page of files and folders that matched the metadata query.",
  "x-box-resource-id": "metadata_query_results"
}

{
  "type": "object",
  "title": "Metadata template",
  "required": [
    "type",
    "id"
  ],
  "x-box-tag": "metadata_templates",
  "properties": {
    "id": {
      "type": "string",
      "example": "58063d82-4128-7b43-bba9-92f706befcdf",
      "description": "The ID of the metadata template."
    },
    "type": {
      "enum": [
        "metadata_template"
      ],
      "type": "string",
      "example": "metadata_template",
      "nullable": false,
      "description": "`metadata_template`"
    },
    "scope": {
      "type": "string",
      "example": "enterprise_123456",
      "description": "The scope of the metadata template can either be `global` or\n`enterprise_*`. The `global` scope is used for templates that are\navailable to any Box enterprise. The `enterprise_*` scope represents\ntemplates that have been created within a specific enterprise, where `*`\nwill be the ID of that enterprise."
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "title": "Metadata Field (Read)",
            "required": [
              "type",
              "key",
              "displayName"
            ],
            "properties": {
              "key": {
                "type": "string",
                "example": "category",
                "maxLength": 256,
                "description": "A unique identifier for the field. The identifier must\nbe unique within the template to which it belongs."
              },
              "type": {
                "enum": [
                  "string",
                  "float",
                  "date",
                  "enum",
                  "multiSelect",
                  "integer"
                ],
                "type": "string",
                "example": "string",
                "description": "The type of field. The basic fields are a `string` field for text, a\n`float` field for numbers, and a `date` fields to present the user with a\ndate-time picker.\n\nAdditionally, metadata templates support an `enum` field for a basic list\nof items, and ` multiSelect` field for a similar list of items where the\nuser can select more than one value.\n\n**Note**: The `integer` value is deprecated.\nIt is still present in the response,\nbut cannot be used in the POST request."
              },
              "hidden": {
                "type": "boolean",
                "example": true,
                "description": "Whether this field is hidden in the UI for the user and can only be set\nthrough the API instead."
              },
              "options": {
                "type": "array",
                "items": {
                  "type": "object",
                  "title": "Metadata Option (Write)",
                  "required": [
                    "key"
                  ],
                  "properties": {
                    "key": {
                      "type": "string",
                      "example": "Category 1",
                      "description": "The text value of the option. This represents both the display name of the\noption and the internal key used when updating templates."
                    }
                  },
                  "description": "An option for a Metadata Template Field.\n\nOptions only need to be provided for fields of type `enum` and `multiSelect`.\nOptions represent the value(s) a user can select for the field either through\nthe UI or through the API."
                },
                "description": "A list of options for this field. This is used in combination with the\n`enum` and `multiSelect` field types."
              },
              "description": {
                "type": "string",
                "example": "The category",
                "maxLength": 4096,
                "description": "A description of the field. This is not shown to the user."
              },
              "displayName": {
                "type": "string",
                "example": "Category",
                "maxLength": 4096,
                "description": "The display name of the field as it is shown to the user in the web and\nmobile apps."
              }
            },
            "description": "A field within a metadata template. Fields can be a basic text, date, or\nnumber field, or a list of options."
          },
          {
            "properties": {
              "id": {
                "type": "string",
                "example": "822227e0-47a5-921b-88a8-494760b2e6d2",
                "description": "The unique ID of the metadata template field."
              },
              "options": {
                "type": "array",
                "items": {
                  "type": "object",
                  "allOf": [
                    {
                      "type": "object",
                      "title": "Metadata Option (Write)",
                      "required": [
                        "key"
                      ],
                      "properties": {
                        "key": {
                          "type": "string",
                          "example": "Category 1",
                          "description": "The text value of the option. This represents both the display name of the\noption and the internal key used when updating templates."
                        }
                      },
                      "description": "An option for a Metadata Template Field.\n\nOptions only need to be provided for fields of type `enum` and `multiSelect`.\nOptions represent the value(s) a user can select for the field either through\nthe UI or through the API."
                    },
                    {
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "45dc2849-a4a7-40a9-a751-4a699a589190",
                          "description": "The internal unique identifier of the the option."
                        }
                      }
                    }
                  ],
                  "description": "An option for a Metadata Template Field.\n\nOptions are only present for fields of type `enum` and\n`multiSelect`. Options represent the value(s) a user can\nselect for the field either through the UI or through the API."
                },
                "description": "A list of options for this field. This is used in combination\nwith the `enum` and `multiSelect` field types."
              }
            }
          }
        ],
        "description": "A field within a metadata template. Fields can be a basic text, date, or\nnumber field, or a list of options."
      },
      "description": "An ordered list of template fields which are part of the template. Each\nfield can be a regular text field, date field, number field, as well as a\nsingle or multi-select list."
    },
    "hidden": {
      "type": "boolean",
      "example": true,
      "description": "Defines if this template is visible in the Box web app UI, or if\nit is purely intended for usage through the API."
    },
    "displayName": {
      "type": "string",
      "example": "Product Info",
      "maxLength": 4096,
      "description": "The display name of the template. This can be seen in the Box web app\nand mobile apps."
    },
    "templateKey": {
      "type": "string",
      "example": "productInfo",
      "pattern": "^[a-zA-Z_][-a-zA-Z0-9_]*$",
      "maxLength": 64,
      "description": "A unique identifier for the template. This identifier is unique across\nthe `scope` of the enterprise to which the metadata template is being\napplied, yet is not necessarily unique across different enterprises."
    },
    "copyInstanceOnItemCopy": {
      "type": "boolean",
      "example": true,
      "description": "Whether or not to include the metadata when a file or folder is copied."
    }
  },
  "description": "A template for metadata that can be applied to files and folders",
  "x-box-resource-id": "metadata_template"
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "example": 1000,
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API."
        },
        "next_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
          "nullable": true,
          "description": "The marker for the start of the next page of results."
        },
        "prev_marker": {
          "type": "string",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
          "nullable": true,
          "description": "The marker for the start of the previous page of results."
        }
      },
      "description": "The part of an API response that describes marker\nbased pagination"
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/MetadataTemplate"
          },
          "description": "A list of metadata templates"
        }
      }
    }
  ],
  "title": "Metadata templates",
  "x-box-tag": "metadata_templates",
  "description": "A list of metadata templates",
  "x-box-resource-id": "metadata_templates"
}

{
  "type": "object",
  "required": [
    "scope",
    "displayName"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "example": "enterprise",
      "description": "The scope of the metadata template to create. Applications can\nonly create templates for use within the authenticated user's\nenterprise.\n\nThis value needs to be set to `enterprise`, as `global` scopes can\nnot be created by applications."
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "title": "Metadata Field (Write)",
        "required": [
          "type",
          "key",
          "displayName"
        ],
        "properties": {
          "key": {
            "type": "string",
            "example": "category",
            "maxLength": 256,
            "description": "A unique identifier for the field. The identifier must\nbe unique within the template to which it belongs."
          },
          "type": {
            "enum": [
              "string",
              "float",
              "date",
              "enum",
              "multiSelect"
            ],
            "type": "string",
            "example": "string",
            "description": "The type of field. The basic fields are a `string` field for text, a\n`float` field for numbers, and a `date` fields to present the user with a\ndate-time picker.\n\nAdditionally, metadata templates support an `enum` field for a basic list\nof items, and ` multiSelect` field for a similar list of items where the\nuser can select more than one value."
          },
          "hidden": {
            "type": "boolean",
            "example": true,
            "description": "Whether this field is hidden in the UI for the user and can only be set\nthrough the API instead."
          },
          "options": {
            "type": "array",
            "items": {
              "type": "object",
              "title": "Metadata Option (Write)",
              "required": [
                "key"
              ],
              "properties": {
                "key": {
                  "type": "string",
                  "example": "Category 1",
                  "description": "The text value of the option. This represents both the display name of the\noption and the internal key used when updating templates."
                }
              },
              "description": "An option for a Metadata Template Field.\n\nOptions only need to be provided for fields of type `enum` and `multiSelect`.\nOptions represent the value(s) a user can select for the field either through\nthe UI or through the API."
            },
            "description": "A list of options for this field. This is used in combination with the\n`enum` and `multiSelect` field types."
          },
          "description": {
            "type": "string",
            "example": "The category",
            "maxLength": 4096,
            "description": "A description of the field. This is not shown to the user."
          },
          "displayName": {
            "type": "string",
            "example": "Category",
            "maxLength": 4096,
            "description": "The display name of the field as it is shown to the user in the web and\nmobile apps."
          }
        },
        "description": "A field within a metadata template. Fields can be a basic text, date, or\nnumber field, or a list of options."
      },
      "description": "An ordered list of template fields which are part of the template.\nEach field can be a regular text field, date field, number field,\nas well as a single or multi-select list."
    },
    "hidden": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Defines if this template is visible in the Box web app UI, or if\nit is purely intended for usage through the API."
    },
    "displayName": {
      "type": "string",
      "example": "Product Info",
      "maxLength": 4096,
      "description": "The display name of the template."
    },
    "templateKey": {
      "type": "string",
      "example": "productInfo",
      "pattern": "^[a-zA-Z_][-a-zA-Z0-9_]*$",
      "maxLength": 64,
      "description": "A unique identifier for the template. This identifier needs to be\nunique across the enterprise for which the metadata template is\nbeing created.\n\nWhen not provided, the API will create a unique `templateKey`\nbased on the value of the `displayName`."
    },
    "copyInstanceOnItemCopy": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Whether or not to copy any metadata attached to a file or folder\nwhen it is copied. By default, metadata is not copied along with a\nfile or folder when it is copied."
    }
  }
}

{
  "type": "array",
  "items": {
    "type": "object",
    "title": "A metadata template update operation",
    "required": [
      "op"
    ],
    "properties": {
      "op": {
        "enum": [
          "editTemplate",
          "addField",
          "reorderFields",
          "addEnumOption",
          "reorderEnumOptions",
          "reorderMultiSelectOptions",
          "addMultiSelectOption",
          "editField",
          "removeField",
          "editEnumOption",
          "removeEnumOption",
          "editMultiSelectOption",
          "removeMultiSelectOption"
        ],
        "type": "string",
        "example": "addEnumOption",
        "description": "The type of change to perform on the template. Some\nof these are hazardous as they will change existing templates."
      },
      "data": {
        "type": "object",
        "example": {
          "name": "Aaron Levie"
        },
        "description": "The data for the operation. This will vary depending on the\noperation being performed.",
        "additionalProperties": {
          "allOf": [
            {},
            {
              "example": "Aaron Levie"
            },
            {
              "description": "A value for each of the fields that are present\non the metadata template.\nFor the `global.properties` template this can be\na list of zero or more fields,\nas this template allows for any generic key-value pairs \nto be stored stored in the template."
            }
          ],
          "x-box-example-key": "name"
        }
      },
      "fieldKey": {
        "type": "string",
        "example": "category",
        "description": "For operations that affect a single field this defines the key of\nthe field that is affected."
      },
      "fieldKeys": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "example": [
          "category",
          "name"
        ],
        "description": "For operations that affect multiple fields this defines the keys\nof the fields that are affected."
      },
      "enumOptionKey": {
        "type": "string",
        "example": "option1",
        "description": "For operations that affect a single `enum` option this defines\nthe key of the option that is affected."
      },
      "enumOptionKeys": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "example": [
          "option1",
          "option2",
          "option3"
        ],
        "description": "For operations that affect multiple `enum` options this defines\nthe keys of the options that are affected."
      },
      "multiSelectOptionKey": {
        "type": "string",
        "example": "option1",
        "description": "For operations that affect a single multi select option this\ndefines the key of the option that is affected."
      },
      "multiSelectOptionKeys": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "example": [
          "option1",
          "option2",
          "option3"
        ],
        "description": "For operations that affect multiple multi select options this\ndefines the keys of the options that are affected."
      }
    },
    "description": "A [JSON-Patch](https://tools.ietf.org/html/rfc6902) operation for a\nchange to make to the metadata instance."
  },
  "description": "A [JSON-Patch](https://tools.ietf.org/html/rfc6902)\nspecification for the changes to make to the metadata\ntemplate.\n\nThe changes are represented as a JSON array of\noperation objects."
}

{
  "type": "object",
  "title": "Metadata instances",
  "x-box-tag": "file_metadata",
  "properties": {
    "limit": {
      "type": "integer",
      "example": 100,
      "description": "The limit that was used for this page of results."
    },
    "entries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Metadata--Base"
      },
      "description": "A list of metadata instances, as applied to this file or folder."
    }
  },
  "description": "A list of metadata instances that have been applied to a file or folder.",
  "x-box-resource-id": "metadatas"
}

{
  "type": "object",
  "title": "OAuth 2.0 error",
  "x-box-tag": "authorization",
  "properties": {
    "error": {
      "type": "string",
      "example": "invalid_client",
      "description": "The type of the error returned."
    },
    "error_description": {
      "type": "string",
      "example": "The client credentials are not valid",
      "description": "The type of the error returned."
    }
  },
  "description": "An OAuth 2.0 error",
  "x-box-resource-id": "oauth2_error"
}

{
  "type": "object",
  "title": "Outcome",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "17363629",
      "description": "ID of a specific outcome"
    },
    "role": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoleVariable"
        },
        {
          "description": "Determines if the\nworkflow outcome\naffects a specific\ncollaborator role."
        }
      ]
    },
    "collaborators": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CollaboratorVariable"
        },
        {
          "description": "Lists collaborators\naffected by the workflow\nresult."
        }
      ]
    },
    "completion_rule": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CompletionRuleVariable"
        },
        {
          "description": "Determines\nif an action should be completed\nby all or any assignees."
        }
      ]
    },
    "task_collaborators": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CollaboratorVariable"
        },
        {
          "description": "Lists collaborators\naffected by the task workflow\nresult."
        }
      ]
    },
    "file_collaborator_role": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoleVariable"
        },
        {
          "description": "Determines if the\nworkflow outcome for\na file\naffects a specific\ncollaborator role."
        }
      ]
    }
  },
  "description": "An instance of an outcome."
}

{
  "type": "object",
  "required": [
    "item",
    "accessible_by",
    "role"
  ],
  "properties": {
    "item": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "11446498",
          "description": "The ID of the item that will be granted access to"
        },
        "type": {
          "enum": [
            "file",
            "folder"
          ],
          "type": "string",
          "example": "file",
          "description": "The type of the item that this collaboration will be\ngranted access to"
        }
      },
      "description": "The item to attach the comment to."
    },
    "role": {
      "enum": [
        "editor",
        "viewer",
        "previewer",
        "uploader",
        "previewer uploader",
        "viewer uploader",
        "co-owner"
      ],
      "type": "string",
      "example": "editor",
      "description": "The level of access granted."
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "example": "2019-08-29T23:59:00-07:00",
      "description": "Set the expiration date for the collaboration. At this date, the\ncollaboration will be automatically removed from the item.\n\nThis feature will only work if the **Automatically remove invited\ncollaborators: Allow folder owners to extend the expiry date**\nsetting has been enabled in the **Enterprise Settings**\nof the **Admin Console**. When the setting is not enabled,\ncollaborations can not have an expiry date and a value for this\nfield will be result in an error."
    },
    "accessible_by": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "23522323",
          "description": "The ID of the user or group.\n\nAlternatively, use `login` to specify a user by email\naddress."
        },
        "type": {
          "enum": [
            "user",
            "group"
          ],
          "type": "string",
          "example": "user",
          "description": "The type of collaborator to invite."
        },
        "login": {
          "type": "string",
          "example": "john@example.com",
          "description": "The email address of the user to grant access to the item.\n\nAlternatively, use `id` to specify a user by user ID."
        }
      },
      "description": "The user or group to give access to the item."
    },
    "can_view_path": {
      "type": "boolean",
      "example": true,
      "description": "Determines if the invited users can see the entire parent path to\nthe associated folder. The user will not gain privileges in any\nparent folder and therefore can not see content the user is not\ncollaborated on.\n\nBe aware that this meaningfully increases the time required to load the\ninvitee's **All Files** page. We recommend you limit the number of\ncollaborations with `can_view_path` enabled to 1,000 per user.\n\nOnly owner or co-owners can invite collaborators with a `can_view_path` of\n`true`.\n\n`can_view_path` can only be used for folder collaborations."
    },
    "is_access_only": {
      "type": "boolean",
      "example": true,
      "description": "If set to `true`, collaborators have access to\nshared items, but such items won't be visible in the\nAll Files list. Additionally, collaborators won't\nsee the the path to the root folder for the\nshared item."
    }
  }
}